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/>.
23 #include "smbd/globals.h"
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
;
31 struct notify_mid_map
*mid_map
;
35 static void notify_fsp(files_struct
*fsp
, uint32 action
, const char *name
);
38 * For NTCancel, we need to find the notify_change_request indexed by
39 * mid. Separate list here.
42 struct notify_mid_map
{
43 struct notify_mid_map
*prev
, *next
;
44 struct notify_change_request
*req
;
48 static bool notify_change_record_identical(struct notify_change
*c1
,
49 struct notify_change
*c2
)
51 /* Note this is deliberately case sensitive. */
52 if (c1
->action
== c2
->action
&&
53 strcmp(c1
->name
, c2
->name
) == 0) {
59 static bool notify_marshall_changes(int num_changes
,
61 struct notify_change
*changes
,
67 uni_name
.buffer
= NULL
;
69 for (i
=0; i
<num_changes
; i
++) {
70 struct notify_change
*c
;
72 uint32 u32_tmp
; /* Temp arg to prs_uint32 to avoid
73 * signed/unsigned issues */
75 /* Coalesce any identical records. */
76 while (i
+1 < num_changes
&&
77 notify_change_record_identical(&changes
[i
],
84 if (!convert_string_allocate(NULL
, CH_UNIX
, CH_UTF16LE
,
85 c
->name
, strlen(c
->name
)+1, &uni_name
.buffer
,
86 &namelen
, True
) || (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. */
116 DEBUG(10, ("Client only wanted %d bytes, trying to "
117 "marshall %d bytes\n", (int)max_offset
,
118 (int)prs_offset(ps
)));
126 SAFE_FREE(uni_name
.buffer
);
130 /****************************************************************************
131 Setup the common parts of the return packet and send it.
132 *****************************************************************************/
134 static void change_notify_reply_packet(connection_struct
*conn
,
135 struct smb_request
*req
,
138 reply_outbuf(req
, 18, 0);
140 if (!NT_STATUS_IS_OK(error_code
)) {
141 error_packet_set((char *)req
->outbuf
, 0, 0, error_code
,
145 show_msg((char *)req
->outbuf
);
146 if (!srv_send_smb(smbd_server_fd(), (char *)req
->outbuf
,
147 req
->encrypted
, &req
->pcd
)) {
148 exit_server_cleanly("change_notify_reply_packet: srv_send_smb "
151 TALLOC_FREE(req
->outbuf
);
154 void change_notify_reply(connection_struct
*conn
,
155 struct smb_request
*req
, uint32 max_param
,
156 struct notify_change_buf
*notify_buf
)
160 if (notify_buf
->num_changes
== -1) {
161 change_notify_reply_packet(conn
, req
, NT_STATUS_OK
);
162 notify_buf
->num_changes
= 0;
166 prs_init_empty(&ps
, NULL
, MARSHALL
);
168 if (!notify_marshall_changes(notify_buf
->num_changes
, max_param
,
169 notify_buf
->changes
, &ps
)) {
171 * We exceed what the client is willing to accept. Send
174 change_notify_reply_packet(conn
, req
, NT_STATUS_OK
);
178 send_nt_replies(conn
, req
, NT_STATUS_OK
, prs_data_p(&ps
),
179 prs_offset(&ps
), NULL
, 0);
184 TALLOC_FREE(notify_buf
->changes
);
185 notify_buf
->num_changes
= 0;
188 static void notify_callback(void *private_data
, const struct notify_event
*e
)
190 files_struct
*fsp
= (files_struct
*)private_data
;
191 DEBUG(10, ("notify_callback called for %s\n", fsp
->fsp_name
));
192 notify_fsp(fsp
, e
->action
, e
->path
);
195 NTSTATUS
change_notify_create(struct files_struct
*fsp
, uint32 filter
,
199 struct notify_entry e
;
202 SMB_ASSERT(fsp
->notify
== NULL
);
204 if (!(fsp
->notify
= TALLOC_ZERO_P(NULL
, struct notify_change_buf
))) {
205 DEBUG(0, ("talloc failed\n"));
206 return NT_STATUS_NO_MEMORY
;
209 if (asprintf(&fullpath
, "%s/%s", fsp
->conn
->connectpath
,
210 fsp
->fsp_name
) == -1) {
211 DEBUG(0, ("asprintf failed\n"));
212 TALLOC_FREE(fsp
->notify
);
213 return NT_STATUS_NO_MEMORY
;
218 e
.dir_fd
= fsp
->fh
->fd
;
219 e
.dir_id
= fsp
->file_id
;
223 e
.subdir_filter
= filter
;
226 status
= notify_add(fsp
->conn
->notify_ctx
, &e
, notify_callback
, fsp
);
232 NTSTATUS
change_notify_add_request(struct smb_request
*req
,
234 uint32 filter
, bool recursive
,
235 struct files_struct
*fsp
)
237 struct notify_change_request
*request
= NULL
;
238 struct notify_mid_map
*map
= NULL
;
240 DEBUG(10, ("change_notify_add_request: Adding request for %s: "
241 "max_param = %d\n", fsp
->fsp_name
, (int)max_param
));
243 if (!(request
= talloc(NULL
, struct notify_change_request
))
244 || !(map
= talloc(request
, struct notify_mid_map
))) {
245 TALLOC_FREE(request
);
246 return NT_STATUS_NO_MEMORY
;
249 request
->mid_map
= map
;
252 request
->req
= talloc_move(request
, &req
);
253 request
->max_param
= max_param
;
254 request
->filter
= filter
;
256 request
->backend_data
= NULL
;
258 DLIST_ADD_END(fsp
->notify
->requests
, request
,
259 struct notify_change_request
*);
261 map
->mid
= request
->req
->mid
;
262 DLIST_ADD(notify_changes_by_mid
, map
);
264 /* Push the MID of this packet on the signing queue. */
265 srv_defer_sign_response(request
->req
->mid
);
270 static void change_notify_remove_request(struct notify_change_request
*remove_req
)
273 struct notify_change_request
*req
;
276 * Paranoia checks, the fsp referenced must must have the request in
277 * its list of pending requests
280 fsp
= remove_req
->fsp
;
281 SMB_ASSERT(fsp
->notify
!= NULL
);
283 for (req
= fsp
->notify
->requests
; req
; req
= req
->next
) {
284 if (req
== remove_req
) {
290 smb_panic("notify_req not found in fsp's requests");
293 DLIST_REMOVE(fsp
->notify
->requests
, req
);
294 DLIST_REMOVE(notify_changes_by_mid
, req
->mid_map
);
298 /****************************************************************************
299 Delete entries by mid from the change notify pending queue. Always send reply.
300 *****************************************************************************/
302 void remove_pending_change_notify_requests_by_mid(uint16 mid
)
304 struct notify_mid_map
*map
;
306 for (map
= notify_changes_by_mid
; map
; map
= map
->next
) {
307 if (map
->mid
== mid
) {
316 change_notify_reply_packet(map
->req
->fsp
->conn
, map
->req
->req
,
317 NT_STATUS_CANCELLED
);
318 change_notify_remove_request(map
->req
);
321 /****************************************************************************
322 Delete entries by fnum from the change notify pending queue.
323 *****************************************************************************/
325 void remove_pending_change_notify_requests_by_fid(files_struct
*fsp
,
328 if (fsp
->notify
== NULL
) {
332 while (fsp
->notify
->requests
!= NULL
) {
333 change_notify_reply_packet(
334 fsp
->conn
, fsp
->notify
->requests
->req
, status
);
335 change_notify_remove_request(fsp
->notify
->requests
);
339 void notify_fname(connection_struct
*conn
, uint32 action
, uint32 filter
,
344 if (path
[0] == '.' && path
[1] == '/') {
347 if (asprintf(&fullpath
, "%s/%s", conn
->connectpath
, path
) == -1) {
348 DEBUG(0, ("asprintf failed\n"));
352 notify_trigger(conn
->notify_ctx
, action
, filter
, fullpath
);
356 static void notify_fsp(files_struct
*fsp
, uint32 action
, const char *name
)
358 struct notify_change
*change
, *changes
;
361 if (fsp
->notify
== NULL
) {
363 * Nobody is waiting, don't queue
369 * Someone has triggered a notify previously, queue the change for
373 if ((fsp
->notify
->num_changes
> 1000) || (name
== NULL
)) {
375 * The real number depends on the client buf, just provide a
376 * guard against a DoS here. If name == NULL the CN backend is
377 * alerting us to a problem. Possibly dropped events. Clear
378 * queued changes and send the catch-all response to the client
379 * if a request is pending.
381 TALLOC_FREE(fsp
->notify
->changes
);
382 fsp
->notify
->num_changes
= -1;
383 if (fsp
->notify
->requests
!= NULL
) {
384 change_notify_reply(fsp
->conn
,
385 fsp
->notify
->requests
->req
,
386 fsp
->notify
->requests
->max_param
,
388 change_notify_remove_request(fsp
->notify
->requests
);
393 /* If we've exceeded the server side queue or received a NULL name
394 * from the underlying CN implementation, don't queue up any more
395 * requests until we can send a catch-all response to the client */
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
->req
,
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
,