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 /* Max size we can send to client in a notify response. */
27 struct notify_change_request {
28 struct notify_change_request *prev, *next;
29 struct files_struct *fsp; /* backpointer for cancel by mid */
30 char request_buf[smb_size];
32 uint32 current_bufsize;
33 struct notify_mid_map *mid_map;
37 static void notify_fsp(files_struct *fsp, uint32 action, const char *name);
39 static struct notify_mid_map *notify_changes_by_mid;
42 * For NTCancel, we need to find the notify_change_request indexed by
43 * mid. Separate list here.
46 struct notify_mid_map {
47 struct notify_mid_map *prev, *next;
48 struct notify_change_request *req;
52 static BOOL notify_change_record_identical(struct notify_change *c1,
53 struct notify_change *c2)
55 /* Note this is deliberately case sensitive. */
56 if (c1->action == c2->action &&
57 strcmp(c1->name, c2->name) == 0) {
63 static BOOL notify_marshall_changes(int num_changes,
64 struct notify_change *changes,
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);
120 SAFE_FREE(uni_name.buffer);
124 /****************************************************************************
125 Setup the common parts of the return packet and send it.
126 *****************************************************************************/
128 static void change_notify_reply_packet(const char *request_buf,
131 const char *inbuf = request_buf;
132 char outbuf[smb_size+38];
134 memset(outbuf, '\0', sizeof(outbuf));
135 construct_reply_common(request_buf, outbuf);
137 ERROR_NT(error_code);
140 * Seems NT needs a transact command with an error code
141 * in it. This is a longer packet than a simple error.
143 set_message(inbuf,outbuf,18,0,False);
146 if (!send_smb(smbd_server_fd(),outbuf))
147 exit_server_cleanly("change_notify_reply_packet: send_smb "
151 void change_notify_reply(const char *request_buf,
152 struct notify_change_buf *notify_buf)
158 if (notify_buf->num_changes == -1) {
159 change_notify_reply_packet(request_buf, NT_STATUS_OK);
163 if (!prs_init(&ps, 0, NULL, False)
164 || !notify_marshall_changes(notify_buf->num_changes,
165 notify_buf->changes, &ps)) {
166 change_notify_reply_packet(request_buf, NT_STATUS_NO_MEMORY);
170 buflen = smb_size+38+prs_offset(&ps) + 4 /* padding */;
172 if (buflen > max_send) {
174 * We exceed what the client is willing to accept. Send
177 change_notify_reply_packet(request_buf, NT_STATUS_OK);
181 if (!(outbuf = SMB_MALLOC_ARRAY(char, buflen))) {
182 change_notify_reply_packet(request_buf, NT_STATUS_NO_MEMORY);
186 construct_reply_common(request_buf, outbuf);
188 if (send_nt_replies(request_buf, outbuf, buflen, NT_STATUS_OK, prs_data_p(&ps),
189 prs_offset(&ps), NULL, 0) == -1) {
190 exit_server("change_notify_reply_packet: send_smb failed.");
197 TALLOC_FREE(notify_buf->changes);
198 notify_buf->num_changes = 0;
201 static void notify_callback(void *private_data, const struct notify_event *e)
203 files_struct *fsp = (files_struct *)private_data;
204 DEBUG(10, ("notify_callback called for %s\n", fsp->fsp_name));
205 notify_fsp(fsp, e->action, e->path);
208 NTSTATUS change_notify_create(struct files_struct *fsp, uint32 filter,
212 struct notify_entry e;
215 SMB_ASSERT(fsp->notify == NULL);
217 if (!(fsp->notify = TALLOC_ZERO_P(NULL, struct notify_change_buf))) {
218 DEBUG(0, ("talloc failed\n"));
219 return NT_STATUS_NO_MEMORY;
222 if (asprintf(&fullpath, "%s/%s", fsp->conn->connectpath,
223 fsp->fsp_name) == -1) {
224 DEBUG(0, ("asprintf failed\n"));
225 return NT_STATUS_NO_MEMORY;
232 e.subdir_filter = filter;
235 status = notify_add(fsp->conn->notify_ctx, &e, notify_callback, fsp);
241 NTSTATUS change_notify_add_request(const char *inbuf,
242 uint32 filter, BOOL recursive,
243 struct files_struct *fsp)
245 struct notify_change_request *request = NULL;
246 struct notify_mid_map *map = NULL;
248 if (!(request = SMB_MALLOC_P(struct notify_change_request))
249 || !(map = SMB_MALLOC_P(struct notify_mid_map))) {
251 return NT_STATUS_NO_MEMORY;
254 request->mid_map = map;
257 memcpy(request->request_buf, inbuf, sizeof(request->request_buf));
258 request->current_bufsize = 0;
259 request->filter = filter;
261 request->backend_data = NULL;
263 DLIST_ADD_END(fsp->notify->requests, request,
264 struct notify_change_request *);
266 map->mid = SVAL(inbuf, smb_mid);
267 DLIST_ADD(notify_changes_by_mid, map);
269 /* Push the MID of this packet on the signing queue. */
270 srv_defer_sign_response(SVAL(inbuf,smb_mid));
275 static void change_notify_remove_request(struct notify_change_request *remove_req)
278 struct notify_change_request *req;
281 * Paranoia checks, the fsp referenced must must have the request in
282 * its list of pending requests
285 fsp = remove_req->fsp;
286 SMB_ASSERT(fsp->notify != NULL);
288 for (req = fsp->notify->requests; req; req = req->next) {
289 if (req == remove_req) {
295 smb_panic("notify_req not found in fsp's requests");
298 DLIST_REMOVE(fsp->notify->requests, req);
299 DLIST_REMOVE(notify_changes_by_mid, req->mid_map);
300 SAFE_FREE(req->mid_map);
301 TALLOC_FREE(req->backend_data);
305 /****************************************************************************
306 Delete entries by mid from the change notify pending queue. Always send reply.
307 *****************************************************************************/
309 void remove_pending_change_notify_requests_by_mid(uint16 mid)
311 struct notify_mid_map *map;
313 for (map = notify_changes_by_mid; map; map = map->next) {
314 if (map->mid == mid) {
323 change_notify_reply_packet(map->req->request_buf, NT_STATUS_CANCELLED);
324 change_notify_remove_request(map->req);
327 /****************************************************************************
328 Delete entries by fnum from the change notify pending queue.
329 *****************************************************************************/
331 void remove_pending_change_notify_requests_by_fid(files_struct *fsp,
334 if (fsp->notify == NULL) {
338 while (fsp->notify->requests != NULL) {
339 change_notify_reply_packet(
340 fsp->notify->requests->request_buf, status);
341 change_notify_remove_request(fsp->notify->requests);
345 void notify_fname(connection_struct *conn, uint32 action, uint32 filter,
350 if (asprintf(&fullpath, "%s/%s", conn->connectpath, path) == -1) {
351 DEBUG(0, ("asprintf failed\n"));
355 notify_trigger(conn->notify_ctx, action, filter, fullpath);
359 static void notify_fsp(files_struct *fsp, uint32 action, const char *name)
361 struct notify_change *change, *changes;
364 if (fsp->notify == NULL) {
366 * Nobody is waiting, don't queue
372 * Someone has triggered a notify previously, queue the change for
376 if ((fsp->notify->num_changes > 1000) || (name == NULL)) {
378 * The real number depends on the client buf, just provide a
379 * guard against a DoS here.
381 TALLOC_FREE(fsp->notify->changes);
382 fsp->notify->num_changes = -1;
386 if (fsp->notify->num_changes == -1) {
390 if (!(changes = TALLOC_REALLOC_ARRAY(
391 fsp->notify, fsp->notify->changes,
392 struct notify_change, fsp->notify->num_changes+1))) {
393 DEBUG(0, ("talloc_realloc failed\n"));
397 fsp->notify->changes = changes;
399 change = &(fsp->notify->changes[fsp->notify->num_changes]);
401 if (!(tmp = talloc_strdup(changes, name))) {
402 DEBUG(0, ("talloc_strdup failed\n"));
406 string_replace(tmp, '/', '\\');
409 change->action = action;
410 fsp->notify->num_changes += 1;
412 if (fsp->notify->requests == NULL) {
414 * Nobody is waiting, so don't send anything. The ot
419 if (action == NOTIFY_ACTION_OLD_NAME) {
421 * We have to send the two rename events in one reply. So hold
422 * the first part back.
428 * Someone is waiting for the change, trigger the reply immediately.
430 * TODO: do we have to walk the lists of requests pending?
433 change_notify_reply(fsp->notify->requests->request_buf,
436 change_notify_remove_request(fsp->notify->requests);
439 char *notify_filter_string(TALLOC_CTX *mem_ctx, uint32 filter)
443 result = talloc_strdup(mem_ctx, "");
445 if (filter & FILE_NOTIFY_CHANGE_FILE_NAME)
446 result = talloc_asprintf_append(result, "FILE_NAME|");
447 if (filter & FILE_NOTIFY_CHANGE_DIR_NAME)
448 result = talloc_asprintf_append(result, "DIR_NAME|");
449 if (filter & FILE_NOTIFY_CHANGE_ATTRIBUTES)
450 result = talloc_asprintf_append(result, "ATTRIBUTES|");
451 if (filter & FILE_NOTIFY_CHANGE_SIZE)
452 result = talloc_asprintf_append(result, "SIZE|");
453 if (filter & FILE_NOTIFY_CHANGE_LAST_WRITE)
454 result = talloc_asprintf_append(result, "LAST_WRITE|");
455 if (filter & FILE_NOTIFY_CHANGE_LAST_ACCESS)
456 result = talloc_asprintf_append(result, "LAST_ACCESS|");
457 if (filter & FILE_NOTIFY_CHANGE_CREATION)
458 result = talloc_asprintf_append(result, "CREATION|");
459 if (filter & FILE_NOTIFY_CHANGE_EA)
460 result = talloc_asprintf_append(result, "EA|");
461 if (filter & FILE_NOTIFY_CHANGE_SECURITY)
462 result = talloc_asprintf_append(result, "SECURITY|");
463 if (filter & FILE_NOTIFY_CHANGE_STREAM_NAME)
464 result = talloc_asprintf_append(result, "STREAM_NAME|");
465 if (filter & FILE_NOTIFY_CHANGE_STREAM_SIZE)
466 result = talloc_asprintf_append(result, "STREAM_SIZE|");
467 if (filter & FILE_NOTIFY_CHANGE_STREAM_WRITE)
468 result = talloc_asprintf_append(result, "STREAM_WRITE|");
470 if (result == NULL) return NULL;
471 if (*result == '\0') return result;
473 result[strlen(result)-1] = '\0';
477 struct sys_notify_context *sys_notify_context_create(connection_struct *conn,
479 struct event_context *ev)
481 struct sys_notify_context *ctx;
483 if (!(ctx = TALLOC_P(mem_ctx, struct sys_notify_context))) {
484 DEBUG(0, ("talloc failed\n"));
490 ctx->private_data = NULL;
494 NTSTATUS sys_notify_watch(struct sys_notify_context *ctx,
495 struct notify_entry *e,
496 void (*callback)(struct sys_notify_context *ctx,
498 struct notify_event *ev),
499 void *private_data, void *handle)
501 return SMB_VFS_NOTIFY_WATCH(ctx->conn, ctx, e, callback, private_data,