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 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 namelen = convert_string_allocate(
86 NULL, CH_UNIX, CH_UTF16LE, c->name, strlen(c->name)+1,
87 &uni_name.buffer, True);
88 if ((namelen == -1) || (uni_name.buffer == NULL)) {
92 namelen -= 2; /* Dump NULL termination */
95 * Offset to next entry, only if there is one
98 u32_tmp = (i == num_changes-1) ? 0 : namelen + 12;
99 if (!prs_uint32("offset", ps, 1, &u32_tmp)) goto fail;
102 if (!prs_uint32("action", ps, 1, &u32_tmp)) goto fail;
105 if (!prs_uint32("namelen", ps, 1, &u32_tmp)) goto fail;
107 if (!prs_unistr("name", ps, 1, &uni_name)) goto fail;
110 * Not NULL terminated, decrease by the 2 UCS2 \0 chars
112 prs_set_offset(ps, prs_offset(ps)-2);
114 SAFE_FREE(uni_name.buffer);
116 if (prs_offset(ps) > max_offset) {
117 /* Too much data for client. */
125 SAFE_FREE(uni_name.buffer);
129 /****************************************************************************
130 Setup the common parts of the return packet and send it.
131 *****************************************************************************/
133 static void change_notify_reply_packet(connection_struct *conn,
134 const uint8 *request_buf,
137 char outbuf[smb_size+38];
139 memset(outbuf, '\0', sizeof(outbuf));
140 construct_reply_common((char *)request_buf, outbuf);
142 ERROR_NT(error_code);
145 * Seems NT needs a transact command with an error code
146 * in it. This is a longer packet than a simple error.
148 srv_set_message(outbuf,18,0,False);
151 if (!srv_send_smb(smbd_server_fd(),
153 IS_CONN_ENCRYPTED(conn)))
154 exit_server_cleanly("change_notify_reply_packet: srv_send_smb "
158 void change_notify_reply(connection_struct *conn,
159 const uint8 *request_buf, uint32 max_param,
160 struct notify_change_buf *notify_buf)
163 struct smb_request *req = NULL;
164 uint8 tmp_request[smb_size];
166 if (notify_buf->num_changes == -1) {
167 change_notify_reply_packet(conn, request_buf, NT_STATUS_OK);
168 notify_buf->num_changes = 0;
172 prs_init(&ps, 0, NULL, MARSHALL);
174 if (!notify_marshall_changes(notify_buf->num_changes, max_param,
175 notify_buf->changes, &ps)) {
177 * We exceed what the client is willing to accept. Send
180 change_notify_reply_packet(conn, request_buf, NT_STATUS_OK);
184 if (!(req = talloc(talloc_tos(), struct smb_request))) {
185 change_notify_reply_packet(conn, request_buf, NT_STATUS_NO_MEMORY);
189 memcpy(tmp_request, request_buf, smb_size);
192 * We're only interested in the header fields here
195 smb_setlen((char *)tmp_request, smb_size);
196 SCVAL(tmp_request, smb_wct, 0);
198 init_smb_request(req, tmp_request,0, conn->encrypted_tid);
200 send_nt_replies(conn, req, NT_STATUS_OK, prs_data_p(&ps),
201 prs_offset(&ps), NULL, 0);
207 TALLOC_FREE(notify_buf->changes);
208 notify_buf->num_changes = 0;
211 static void notify_callback(void *private_data, const struct notify_event *e)
213 files_struct *fsp = (files_struct *)private_data;
214 DEBUG(10, ("notify_callback called for %s\n", fsp->fsp_name));
215 notify_fsp(fsp, e->action, e->path);
218 NTSTATUS change_notify_create(struct files_struct *fsp, uint32 filter,
222 struct notify_entry e;
225 SMB_ASSERT(fsp->notify == NULL);
227 if (!(fsp->notify = TALLOC_ZERO_P(NULL, struct notify_change_buf))) {
228 DEBUG(0, ("talloc failed\n"));
229 return NT_STATUS_NO_MEMORY;
232 if (asprintf(&fullpath, "%s/%s", fsp->conn->connectpath,
233 fsp->fsp_name) == -1) {
234 DEBUG(0, ("asprintf failed\n"));
235 return NT_STATUS_NO_MEMORY;
243 e.subdir_filter = filter;
246 status = notify_add(fsp->conn->notify_ctx, &e, notify_callback, fsp);
252 NTSTATUS change_notify_add_request(const struct smb_request *req,
254 uint32 filter, bool recursive,
255 struct files_struct *fsp)
257 struct notify_change_request *request = NULL;
258 struct notify_mid_map *map = NULL;
260 if (!(request = SMB_MALLOC_P(struct notify_change_request))
261 || !(map = SMB_MALLOC_P(struct notify_mid_map))) {
263 return NT_STATUS_NO_MEMORY;
266 request->mid_map = map;
269 memcpy(request->request_buf, req->inbuf, sizeof(request->request_buf));
270 request->max_param = max_param;
271 request->filter = filter;
273 request->backend_data = NULL;
275 DLIST_ADD_END(fsp->notify->requests, request,
276 struct notify_change_request *);
278 map->mid = SVAL(req->inbuf, smb_mid);
279 DLIST_ADD(notify_changes_by_mid, map);
281 /* Push the MID of this packet on the signing queue. */
282 srv_defer_sign_response(SVAL(req->inbuf,smb_mid));
287 static void change_notify_remove_request(struct notify_change_request *remove_req)
290 struct notify_change_request *req;
293 * Paranoia checks, the fsp referenced must must have the request in
294 * its list of pending requests
297 fsp = remove_req->fsp;
298 SMB_ASSERT(fsp->notify != NULL);
300 for (req = fsp->notify->requests; req; req = req->next) {
301 if (req == remove_req) {
307 smb_panic("notify_req not found in fsp's requests");
310 DLIST_REMOVE(fsp->notify->requests, req);
311 DLIST_REMOVE(notify_changes_by_mid, req->mid_map);
312 SAFE_FREE(req->mid_map);
313 TALLOC_FREE(req->backend_data);
317 /****************************************************************************
318 Delete entries by mid from the change notify pending queue. Always send reply.
319 *****************************************************************************/
321 void remove_pending_change_notify_requests_by_mid(uint16 mid)
323 struct notify_mid_map *map;
325 for (map = notify_changes_by_mid; map; map = map->next) {
326 if (map->mid == mid) {
335 change_notify_reply_packet(map->req->fsp->conn,
336 map->req->request_buf, NT_STATUS_CANCELLED);
337 change_notify_remove_request(map->req);
340 /****************************************************************************
341 Delete entries by fnum from the change notify pending queue.
342 *****************************************************************************/
344 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
347 if (fsp->notify == NULL) {
351 while (fsp->notify->requests != NULL) {
352 change_notify_reply_packet(fsp->conn,
353 fsp->notify->requests->request_buf, status);
354 change_notify_remove_request(fsp->notify->requests);
358 void notify_fname(connection_struct *conn, uint32 action, uint32 filter,
363 if (asprintf(&fullpath, "%s/%s", conn->connectpath, path) == -1) {
364 DEBUG(0, ("asprintf failed\n"));
368 notify_trigger(conn->notify_ctx, action, filter, fullpath);
372 static void notify_fsp(files_struct *fsp, uint32 action, const char *name)
374 struct notify_change *change, *changes;
377 if (fsp->notify == NULL) {
379 * Nobody is waiting, don't queue
385 * Someone has triggered a notify previously, queue the change for
389 if ((fsp->notify->num_changes > 1000) || (name == NULL)) {
391 * The real number depends on the client buf, just provide a
392 * guard against a DoS here.
394 TALLOC_FREE(fsp->notify->changes);
395 fsp->notify->num_changes = -1;
399 if (fsp->notify->num_changes == -1) {
403 if (!(changes = TALLOC_REALLOC_ARRAY(
404 fsp->notify, fsp->notify->changes,
405 struct notify_change, fsp->notify->num_changes+1))) {
406 DEBUG(0, ("talloc_realloc failed\n"));
410 fsp->notify->changes = changes;
412 change = &(fsp->notify->changes[fsp->notify->num_changes]);
414 if (!(tmp = talloc_strdup(changes, name))) {
415 DEBUG(0, ("talloc_strdup failed\n"));
419 string_replace(tmp, '/', '\\');
422 change->action = action;
423 fsp->notify->num_changes += 1;
425 if (fsp->notify->requests == NULL) {
427 * Nobody is waiting, so don't send anything. The ot
432 if (action == NOTIFY_ACTION_OLD_NAME) {
434 * We have to send the two rename events in one reply. So hold
435 * the first part back.
441 * Someone is waiting for the change, trigger the reply immediately.
443 * TODO: do we have to walk the lists of requests pending?
446 change_notify_reply(fsp->conn,
447 fsp->notify->requests->request_buf,
448 fsp->notify->requests->max_param,
451 change_notify_remove_request(fsp->notify->requests);
454 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32 filter)
458 result = talloc_strdup(mem_ctx, "");
460 if (filter & FILE_NOTIFY_CHANGE_FILE_NAME)
461 result = talloc_asprintf_append(result, "FILE_NAME|");
462 if (filter & FILE_NOTIFY_CHANGE_DIR_NAME)
463 result = talloc_asprintf_append(result, "DIR_NAME|");
464 if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
465 result = talloc_asprintf_append(result, "ATTRIBUTES|");
466 if (filter & FILE_NOTIFY_CHANGE_SIZE)
467 result = talloc_asprintf_append(result, "SIZE|");
468 if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
469 result = talloc_asprintf_append(result, "LAST_WRITE|");
470 if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
471 result = talloc_asprintf_append(result, "LAST_ACCESS|");
472 if (filter & FILE_NOTIFY_CHANGE_CREATION)
473 result = talloc_asprintf_append(result, "CREATION|");
474 if (filter & FILE_NOTIFY_CHANGE_EA)
475 result = talloc_asprintf_append(result, "EA|");
476 if (filter & FILE_NOTIFY_CHANGE_SECURITY)
477 result = talloc_asprintf_append(result, "SECURITY|");
478 if (filter & FILE_NOTIFY_CHANGE_STREAM_NAME)
479 result = talloc_asprintf_append(result, "STREAM_NAME|");
480 if (filter & FILE_NOTIFY_CHANGE_STREAM_SIZE)
481 result = talloc_asprintf_append(result, "STREAM_SIZE|");
482 if (filter & FILE_NOTIFY_CHANGE_STREAM_WRITE)
483 result = talloc_asprintf_append(result, "STREAM_WRITE|");
485 if (result == NULL) return NULL;
486 if (*result == '\0') return result;
488 result[strlen(result)-1] = '\0';
492 struct sys_notify_context *sys_notify_context_create(connection_struct *conn,
494 struct event_context *ev)
496 struct sys_notify_context *ctx;
498 if (!(ctx = TALLOC_P(mem_ctx, struct sys_notify_context))) {
499 DEBUG(0, ("talloc failed\n"));
505 ctx->private_data = NULL;
509 NTSTATUS sys_notify_watch(struct sys_notify_context *ctx,
510 struct notify_entry *e,
511 void (*callback)(struct sys_notify_context *ctx,
513 struct notify_event *ev),
514 void *private_data, void *handle)
516 return SMB_VFS_NOTIFY_WATCH(ctx->conn, ctx, e, callback, private_data,