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(connection_struct *conn,
132 const uint8 *request_buf,
135 char outbuf[smb_size+38];
137 memset(outbuf, '\0', sizeof(outbuf));
138 construct_reply_common((char *)request_buf, 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 srv_set_message(outbuf,18,0,False);
149 if (!srv_send_smb(smbd_server_fd(),
151 IS_CONN_ENCRYPTED(conn)))
152 exit_server_cleanly("change_notify_reply_packet: srv_send_smb "
156 void change_notify_reply(connection_struct *conn,
157 const uint8 *request_buf, uint32 max_param,
158 struct notify_change_buf *notify_buf)
161 struct smb_request *req = NULL;
162 uint8 tmp_request[smb_size];
164 if (notify_buf->num_changes == -1) {
165 change_notify_reply_packet(conn, request_buf, NT_STATUS_OK);
166 notify_buf->num_changes = 0;
170 prs_init(&ps, 0, NULL, MARSHALL);
172 if (!notify_marshall_changes(notify_buf->num_changes, max_param,
173 notify_buf->changes, &ps)) {
175 * We exceed what the client is willing to accept. Send
178 change_notify_reply_packet(conn, request_buf, NT_STATUS_OK);
182 if (!(req = talloc(talloc_tos(), struct smb_request))) {
183 change_notify_reply_packet(conn, request_buf, NT_STATUS_NO_MEMORY);
187 memcpy(tmp_request, request_buf, smb_size);
190 * We're only interested in the header fields here
193 smb_setlen((char *)tmp_request, smb_size);
194 SCVAL(tmp_request, smb_wct, 0);
196 init_smb_request(req, tmp_request,0, conn->encrypted_tid);
198 send_nt_replies(conn, req, NT_STATUS_OK, prs_data_p(&ps),
199 prs_offset(&ps), NULL, 0);
205 TALLOC_FREE(notify_buf->changes);
206 notify_buf->num_changes = 0;
209 static void notify_callback(void *private_data, const struct notify_event *e)
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);
216 NTSTATUS change_notify_create(struct files_struct *fsp, uint32 filter,
220 struct notify_entry e;
223 SMB_ASSERT(fsp->notify == NULL);
225 if (!(fsp->notify = TALLOC_ZERO_P(NULL, struct notify_change_buf))) {
226 DEBUG(0, ("talloc failed\n"));
227 return NT_STATUS_NO_MEMORY;
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;
240 e.subdir_filter = filter;
243 status = notify_add(fsp->conn->notify_ctx, &e, notify_callback, fsp);
249 NTSTATUS change_notify_add_request(const struct smb_request *req,
251 uint32 filter, bool recursive,
252 struct files_struct *fsp)
254 struct notify_change_request *request = NULL;
255 struct notify_mid_map *map = NULL;
257 if (!(request = SMB_MALLOC_P(struct notify_change_request))
258 || !(map = SMB_MALLOC_P(struct notify_mid_map))) {
260 return NT_STATUS_NO_MEMORY;
263 request->mid_map = map;
266 memcpy(request->request_buf, req->inbuf, sizeof(request->request_buf));
267 request->max_param = max_param;
268 request->filter = filter;
270 request->backend_data = NULL;
272 DLIST_ADD_END(fsp->notify->requests, request,
273 struct notify_change_request *);
275 map->mid = SVAL(req->inbuf, smb_mid);
276 DLIST_ADD(notify_changes_by_mid, map);
278 /* Push the MID of this packet on the signing queue. */
279 srv_defer_sign_response(SVAL(req->inbuf,smb_mid));
284 static void change_notify_remove_request(struct notify_change_request *remove_req)
287 struct notify_change_request *req;
290 * Paranoia checks, the fsp referenced must must have the request in
291 * its list of pending requests
294 fsp = remove_req->fsp;
295 SMB_ASSERT(fsp->notify != NULL);
297 for (req = fsp->notify->requests; req; req = req->next) {
298 if (req == remove_req) {
304 smb_panic("notify_req not found in fsp's requests");
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);
314 /****************************************************************************
315 Delete entries by mid from the change notify pending queue. Always send reply.
316 *****************************************************************************/
318 void remove_pending_change_notify_requests_by_mid(uint16 mid)
320 struct notify_mid_map *map;
322 for (map = notify_changes_by_mid; map; map = map->next) {
323 if (map->mid == mid) {
332 change_notify_reply_packet(map->req->fsp->conn,
333 map->req->request_buf, NT_STATUS_CANCELLED);
334 change_notify_remove_request(map->req);
337 /****************************************************************************
338 Delete entries by fnum from the change notify pending queue.
339 *****************************************************************************/
341 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
344 if (fsp->notify == NULL) {
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);
355 void notify_fname(connection_struct *conn, uint32 action, uint32 filter,
360 if (asprintf(&fullpath, "%s/%s", conn->connectpath, path) == -1) {
361 DEBUG(0, ("asprintf failed\n"));
365 notify_trigger(conn->notify_ctx, action, filter, fullpath);
369 static void notify_fsp(files_struct *fsp, uint32 action, const char *name)
371 struct notify_change *change, *changes;
374 if (fsp->notify == NULL) {
376 * Nobody is waiting, don't queue
382 * Someone has triggered a notify previously, queue the change for
386 if ((fsp->notify->num_changes > 1000) || (name == NULL)) {
388 * The real number depends on the client buf, just provide a
389 * guard against a DoS here.
391 TALLOC_FREE(fsp->notify->changes);
392 fsp->notify->num_changes = -1;
396 if (fsp->notify->num_changes == -1) {
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"));
407 fsp->notify->changes = changes;
409 change = &(fsp->notify->changes[fsp->notify->num_changes]);
411 if (!(tmp = talloc_strdup(changes, name))) {
412 DEBUG(0, ("talloc_strdup failed\n"));
416 string_replace(tmp, '/', '\\');
419 change->action = action;
420 fsp->notify->num_changes += 1;
422 if (fsp->notify->requests == NULL) {
424 * Nobody is waiting, so don't send anything. The ot
429 if (action == NOTIFY_ACTION_OLD_NAME) {
431 * We have to send the two rename events in one reply. So hold
432 * the first part back.
438 * Someone is waiting for the change, trigger the reply immediately.
440 * TODO: do we have to walk the lists of requests pending?
443 change_notify_reply(fsp->conn,
444 fsp->notify->requests->request_buf,
445 fsp->notify->requests->max_param,
448 change_notify_remove_request(fsp->notify->requests);
451 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32 filter)
455 result = talloc_strdup(mem_ctx, "");
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|");
482 if (result == NULL) return NULL;
483 if (*result == '\0') return result;
485 result[strlen(result)-1] = '\0';
489 struct sys_notify_context *sys_notify_context_create(connection_struct *conn,
491 struct event_context *ev)
493 struct sys_notify_context *ctx;
495 if (!(ctx = TALLOC_P(mem_ctx, struct sys_notify_context))) {
496 DEBUG(0, ("talloc failed\n"));
502 ctx->private_data = NULL;
506 NTSTATUS sys_notify_watch(struct sys_notify_context *ctx,
507 struct notify_entry *e,
508 void (*callback)(struct sys_notify_context *ctx,
510 struct notify_event *ev),
511 void *private_data, void *handle)
513 return SMB_VFS_NOTIFY_WATCH(ctx->conn, ctx, e, callback, private_data,