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 struct smb_request *req;
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 uni_name.buffer = NULL;
70 for (i=0; i<num_changes; i++) {
71 struct notify_change *c;
73 uint32 u32_tmp; /* Temp arg to prs_uint32 to avoid
74 * signed/unsigned issues */
76 /* Coalesce any identical records. */
77 while (i+1 < num_changes &&
78 notify_change_record_identical(&changes[i],
85 if (!convert_string_allocate(NULL, CH_UNIX, CH_UTF16LE,
86 c->name, strlen(c->name)+1, &uni_name.buffer,
87 &namelen, True) || (uni_name.buffer == NULL)) {
91 namelen -= 2; /* Dump NULL termination */
94 * Offset to next entry, only if there is one
97 u32_tmp = (i == num_changes-1) ? 0 : namelen + 12;
98 if (!prs_uint32("offset", ps, 1, &u32_tmp)) goto fail;
101 if (!prs_uint32("action", ps, 1, &u32_tmp)) goto fail;
104 if (!prs_uint32("namelen", ps, 1, &u32_tmp)) goto fail;
106 if (!prs_unistr("name", ps, 1, &uni_name)) goto fail;
109 * Not NULL terminated, decrease by the 2 UCS2 \0 chars
111 prs_set_offset(ps, prs_offset(ps)-2);
113 SAFE_FREE(uni_name.buffer);
115 if (prs_offset(ps) > max_offset) {
116 /* Too much data for client. */
117 DEBUG(10, ("Client only wanted %d bytes, trying to "
118 "marshall %d bytes\n", (int)max_offset,
119 (int)prs_offset(ps)));
127 SAFE_FREE(uni_name.buffer);
131 /****************************************************************************
132 Setup the common parts of the return packet and send it.
133 *****************************************************************************/
135 static void change_notify_reply_packet(connection_struct *conn,
136 struct smb_request *req,
139 reply_outbuf(req, 18, 0);
141 if (!NT_STATUS_IS_OK(error_code)) {
142 error_packet_set((char *)req->outbuf, 0, 0, error_code,
146 show_msg((char *)req->outbuf);
147 if (!srv_send_smb(smbd_server_fd(), (char *)req->outbuf,
149 exit_server_cleanly("change_notify_reply_packet: srv_send_smb "
152 TALLOC_FREE(req->outbuf);
155 void change_notify_reply(connection_struct *conn,
156 struct smb_request *req, uint32 max_param,
157 struct notify_change_buf *notify_buf)
161 if (notify_buf->num_changes == -1) {
162 change_notify_reply_packet(conn, req, NT_STATUS_OK);
163 notify_buf->num_changes = 0;
167 prs_init_empty(&ps, 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(conn, req, NT_STATUS_OK);
179 send_nt_replies(conn, req, NT_STATUS_OK, prs_data_p(&ps),
180 prs_offset(&ps), NULL, 0);
185 TALLOC_FREE(notify_buf->changes);
186 notify_buf->num_changes = 0;
189 static void notify_callback(void *private_data, const struct notify_event *e)
191 files_struct *fsp = (files_struct *)private_data;
192 DEBUG(10, ("notify_callback called for %s\n", fsp->fsp_name));
193 notify_fsp(fsp, e->action, e->path);
196 NTSTATUS change_notify_create(struct files_struct *fsp, uint32 filter,
200 struct notify_entry e;
203 SMB_ASSERT(fsp->notify == NULL);
205 if (!(fsp->notify = TALLOC_ZERO_P(NULL, struct notify_change_buf))) {
206 DEBUG(0, ("talloc failed\n"));
207 return NT_STATUS_NO_MEMORY;
210 if (asprintf(&fullpath, "%s/%s", fsp->conn->connectpath,
211 fsp->fsp_name) == -1) {
212 DEBUG(0, ("asprintf failed\n"));
213 return NT_STATUS_NO_MEMORY;
221 e.subdir_filter = filter;
224 status = notify_add(fsp->conn->notify_ctx, &e, notify_callback, fsp);
230 NTSTATUS change_notify_add_request(struct smb_request *req,
232 uint32 filter, bool recursive,
233 struct files_struct *fsp)
235 struct notify_change_request *request = NULL;
236 struct notify_mid_map *map = NULL;
238 DEBUG(10, ("change_notify_add_request: Adding request for %s: "
239 "max_param = %d\n", fsp->fsp_name, (int)max_param));
241 if (!(request = talloc(NULL, struct notify_change_request))
242 || !(map = talloc(request, struct notify_mid_map))) {
243 TALLOC_FREE(request);
244 return NT_STATUS_NO_MEMORY;
247 request->mid_map = map;
250 request->req = talloc_move(request, &req);
251 request->max_param = max_param;
252 request->filter = filter;
254 request->backend_data = NULL;
256 DLIST_ADD_END(fsp->notify->requests, request,
257 struct notify_change_request *);
259 map->mid = request->req->mid;
260 DLIST_ADD(notify_changes_by_mid, map);
262 /* Push the MID of this packet on the signing queue. */
263 srv_defer_sign_response(request->req->mid);
268 static void change_notify_remove_request(struct notify_change_request *remove_req)
271 struct notify_change_request *req;
274 * Paranoia checks, the fsp referenced must must have the request in
275 * its list of pending requests
278 fsp = remove_req->fsp;
279 SMB_ASSERT(fsp->notify != NULL);
281 for (req = fsp->notify->requests; req; req = req->next) {
282 if (req == remove_req) {
288 smb_panic("notify_req not found in fsp's requests");
291 DLIST_REMOVE(fsp->notify->requests, req);
292 DLIST_REMOVE(notify_changes_by_mid, req->mid_map);
296 /****************************************************************************
297 Delete entries by mid from the change notify pending queue. Always send reply.
298 *****************************************************************************/
300 void remove_pending_change_notify_requests_by_mid(uint16 mid)
302 struct notify_mid_map *map;
304 for (map = notify_changes_by_mid; map; map = map->next) {
305 if (map->mid == mid) {
314 change_notify_reply_packet(map->req->fsp->conn, map->req->req,
315 NT_STATUS_CANCELLED);
316 change_notify_remove_request(map->req);
319 /****************************************************************************
320 Delete entries by fnum from the change notify pending queue.
321 *****************************************************************************/
323 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
326 if (fsp->notify == NULL) {
330 while (fsp->notify->requests != NULL) {
331 change_notify_reply_packet(
332 fsp->conn, fsp->notify->requests->req, status);
333 change_notify_remove_request(fsp->notify->requests);
337 void notify_fname(connection_struct *conn, uint32 action, uint32 filter,
342 if (path[0] == '.' && path[1] == '/') {
345 if (asprintf(&fullpath, "%s/%s", conn->connectpath, path) == -1) {
346 DEBUG(0, ("asprintf failed\n"));
350 notify_trigger(conn->notify_ctx, action, filter, fullpath);
354 static void notify_fsp(files_struct *fsp, uint32 action, const char *name)
356 struct notify_change *change, *changes;
359 if (fsp->notify == NULL) {
361 * Nobody is waiting, don't queue
367 * Someone has triggered a notify previously, queue the change for
371 if ((fsp->notify->num_changes > 1000) || (name == NULL)) {
373 * The real number depends on the client buf, just provide a
374 * guard against a DoS here.
376 TALLOC_FREE(fsp->notify->changes);
377 fsp->notify->num_changes = -1;
381 if (fsp->notify->num_changes == -1) {
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"));
392 fsp->notify->changes = changes;
394 change = &(fsp->notify->changes[fsp->notify->num_changes]);
396 if (!(tmp = talloc_strdup(changes, name))) {
397 DEBUG(0, ("talloc_strdup failed\n"));
401 string_replace(tmp, '/', '\\');
404 change->action = action;
405 fsp->notify->num_changes += 1;
407 if (fsp->notify->requests == NULL) {
409 * Nobody is waiting, so don't send anything. The ot
414 if (action == NOTIFY_ACTION_OLD_NAME) {
416 * We have to send the two rename events in one reply. So hold
417 * the first part back.
423 * Someone is waiting for the change, trigger the reply immediately.
425 * TODO: do we have to walk the lists of requests pending?
428 change_notify_reply(fsp->conn,
429 fsp->notify->requests->req,
430 fsp->notify->requests->max_param,
433 change_notify_remove_request(fsp->notify->requests);
436 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32 filter)
440 result = talloc_strdup(mem_ctx, "");
442 if (filter & FILE_NOTIFY_CHANGE_FILE_NAME)
443 result = talloc_asprintf_append(result, "FILE_NAME|");
444 if (filter & FILE_NOTIFY_CHANGE_DIR_NAME)
445 result = talloc_asprintf_append(result, "DIR_NAME|");
446 if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
447 result = talloc_asprintf_append(result, "ATTRIBUTES|");
448 if (filter & FILE_NOTIFY_CHANGE_SIZE)
449 result = talloc_asprintf_append(result, "SIZE|");
450 if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
451 result = talloc_asprintf_append(result, "LAST_WRITE|");
452 if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
453 result = talloc_asprintf_append(result, "LAST_ACCESS|");
454 if (filter & FILE_NOTIFY_CHANGE_CREATION)
455 result = talloc_asprintf_append(result, "CREATION|");
456 if (filter & FILE_NOTIFY_CHANGE_EA)
457 result = talloc_asprintf_append(result, "EA|");
458 if (filter & FILE_NOTIFY_CHANGE_SECURITY)
459 result = talloc_asprintf_append(result, "SECURITY|");
460 if (filter & FILE_NOTIFY_CHANGE_STREAM_NAME)
461 result = talloc_asprintf_append(result, "STREAM_NAME|");
462 if (filter & FILE_NOTIFY_CHANGE_STREAM_SIZE)
463 result = talloc_asprintf_append(result, "STREAM_SIZE|");
464 if (filter & FILE_NOTIFY_CHANGE_STREAM_WRITE)
465 result = talloc_asprintf_append(result, "STREAM_WRITE|");
467 if (result == NULL) return NULL;
468 if (*result == '\0') return result;
470 result[strlen(result)-1] = '\0';
474 struct sys_notify_context *sys_notify_context_create(connection_struct *conn,
476 struct event_context *ev)
478 struct sys_notify_context *ctx;
480 if (!(ctx = TALLOC_P(mem_ctx, struct sys_notify_context))) {
481 DEBUG(0, ("talloc failed\n"));
487 ctx->private_data = NULL;
491 NTSTATUS sys_notify_watch(struct sys_notify_context *ctx,
492 struct notify_entry *e,
493 void (*callback)(struct sys_notify_context *ctx,
495 struct notify_event *ev),
496 void *private_data, void *handle)
498 return SMB_VFS_NOTIFY_WATCH(ctx->conn, ctx, e, callback, private_data,