Commit e640dc9

Browse files
authored
win: handle short path mismatch with a fallback in fs events (#5152)
uv_fs_event_start() stores the watched directory path verbatim in handle->dirw. When an event arrives, the child path is resolved to its long form with GetLongPathNameW() and uv__relative_path() strips the handle->dirw prefix off the result. Previously if the directory was supplied as an 8.3 short path, the long form no longer shares that prefix, so the prefix check in uv__relative_path() fails, which either fires an assertion in builds without NDEBUG or produces a wrong(potentially out-of-bounds) result otherwise. This patch falls back to the name reported by ReadDirectoryChangesW in this case, since that is already relative to the watched directory, similar to how other branches handle it. Also update the test to try testing under %TEMP% if accessible to increase the chance of it reproducing in the CI.
1 parent f6b7133 commit e640dc9

2 files changed

Lines changed: 116 additions & 27 deletions

File tree

‎src/win/fs-event.c‎

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,17 @@ static void uv__fs_event_queue_readdirchanges(uv_loop_t* loop,
6363
handle->req_pending=1;
6464
}
6565

66-
staticvoiduv__relative_path(constWCHAR*filename,
67-
constWCHAR*dir,
68-
WCHAR**relpath) {
66+
/* Compute the path of `filename` relative to the watched directory `dir`.
67+
* Returns 0 on success, -1 if `filename` is not actually prefixed by `dir`,
68+
* which can happen if the directory is a short path. */
69+
staticintuv__relative_path(constWCHAR*filename,
70+
constWCHAR*dir,
71+
WCHAR**relpath) {
6972
size_trelpathlen;
7073
size_tfilenamelen=wcslen(filename);
7174
size_tdirlen=wcslen(dir);
72-
assert(!_wcsnicmp(filename, dir, dirlen));
75+
if (filenamelen <= dirlen||_wcsnicmp(filename, dir, dirlen) !=0)
76+
return-1;
7377
if (dirlen>0&&dir[dirlen-1] =='\\')
7478
dirlen--;
7579
relpathlen=filenamelen-dirlen-1;
@@ -78,6 +82,7 @@ static void uv__relative_path(const WCHAR* filename,
7882
uv_fatal_error(ERROR_OUTOFMEMORY, "uv__malloc");
7983
wcsncpy(*relpath, filename+dirlen+1, relpathlen);
8084
(*relpath)[relpathlen] =L'\0';
85+
return0;
8186
}
8287

8388
staticintuv__split_path(constWCHAR*filename, WCHAR**dir,
@@ -522,12 +527,21 @@ void uv__process_fs_event_req(uv_loop_t* loop, uv_req_t* req,
522527

523528
if (long_filenamew) {
524529
/* Get the file name out of the long path. */
525-
uv__relative_path(long_filenamew,
526-
handle->dirw,
527-
&filenamew);
528-
uv__free(long_filenamew);
529-
long_filenamew=filenamew;
530-
sizew=-1;
530+
if (uv__relative_path(long_filenamew,
531+
handle->dirw,
532+
&filenamew) ==0) {
533+
uv__free(long_filenamew);
534+
long_filenamew=filenamew;
535+
sizew=-1;
536+
} else {
537+
/* The resolved long path was not prefixed by the watched
538+
* directory (e.g. short name vs long name mismatch),
539+
* fall back to the name given by ReadDirectoryChangesW. */
540+
uv__free(long_filenamew);
541+
long_filenamew=NULL;
542+
filenamew=file_info->FileName;
543+
sizew=file_info->FileNameLength / sizeof(WCHAR);
544+
}
531545
} else {
532546
/* We couldn't get the long filename, use the one reported. */
533547
filenamew=file_info->FileName;

‎test/test-fs-event.c‎

Lines changed: 92 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -632,44 +632,119 @@ TEST_IMPL(fs_event_watch_dir_recursive) {
632632
}
633633

634634
#ifdef_WIN32
635+
staticcharshort_path_file[MAX_PATH];
636+
637+
staticvoidshort_path_timer_cb(uv_timer_t*handle) {
638+
++timer_cb_called;
639+
touch_file(short_path_file);
640+
}
641+
642+
/* Try to create a unique watch directory that has a 8.3 short component
643+
under `parent` ("" means the cwd). If it's successful, fills `watch_dir`
644+
and `short_dir` with the long and short forms of the created directory
645+
respectively, and returns 1. Otherwise removes the directory created
646+
and returns 0. */
647+
staticintshort_path_make(constchar*parent,
648+
char*watch_dir, size_twatch_n,
649+
char*short_dir, size_tshort_n) {
650+
uv_fs_treq;
651+
chartmpl[MAX_PATH];
652+
WCHARwatch_dirw[MAX_PATH];
653+
WCHARshort_dirw[MAX_PATH];
654+
WCHARlong_dirw[MAX_PATH];
655+
size_tpathlen;
656+
intr;
657+
658+
if (parent[0] !='\0')
659+
r=snprintf(tmpl, sizeof(tmpl), "%s\\watch_dirXXXXXX", parent);
660+
else
661+
r=snprintf(tmpl, sizeof(tmpl), "watch_dirXXXXXX");
662+
if (r<0|| (size_t) r >= sizeof(tmpl))
663+
return0;
664+
665+
r=uv_fs_mkdtemp(NULL, &req, tmpl, NULL);
666+
if (r!=0) {
667+
uv_fs_req_cleanup(&req);
668+
return0;
669+
}
670+
671+
/* Copy the created path out before cleaning up the request that owns it. */
672+
pathlen=strlen(req.path);
673+
memcpy(watch_dir, req.path, pathlen+1);
674+
uv_fs_req_cleanup(&req);
675+
676+
/* The caller appends "\file1" to both watch_dir and short_dir. If there is
677+
no room for that suffix, skip this location. */
678+
if (pathlen+sizeof("\\file1") <= watch_n&&
679+
MultiByteToWideChar(CP_UTF8, 0, watch_dir, -1,
680+
watch_dirw, ARRAY_SIZE(watch_dirw)) !=0&&
681+
GetShortPathNameW(watch_dirw, short_dirw, ARRAY_SIZE(short_dirw)) !=0&&
682+
GetLongPathNameW(watch_dirw, long_dirw, ARRAY_SIZE(long_dirw)) !=0&&
683+
_wcsicmp(short_dirw, long_dirw) !=0&&
684+
WideCharToMultiByte(CP_UTF8, 0, short_dirw, -1,
685+
short_dir, (int) short_n, NULL, NULL) !=0)
686+
return1;
687+
688+
uv_fs_rmdir(NULL, &req, watch_dir, NULL);
689+
uv_fs_req_cleanup(&req);
690+
return0;
691+
}
692+
635693
TEST_IMPL(fs_event_watch_dir_short_path) {
636694
uv_loop_t*loop;
637-
uv_fs_treq;
695+
chartemp_path[MAX_PATH];
696+
charwatch_dir[MAX_PATH];
697+
charwatch_file[MAX_PATH];
698+
charshort_dir[MAX_PATH];
699+
size_ttemp_len;
638700
inthas_shortnames;
639701
intr;
640702

641-
/* Setup */
642703
loop=uv_default_loop();
643-
delete_file("watch_dir/file1");
644-
delete_dir("watch_dir/");
645-
create_dir("watch_dir");
646-
create_file("watch_dir/file1");
647704

648-
/* Newer version of Windows ship with
649-
HKLM\SYSTEM\CurrentControlSet\Control\FileSystem\NtfsDisable8dot3NameCreation
650-
not equal to 0. So we verify the files we created are addressable by a 8.3
651-
short name */
652-
has_shortnames=uv_fs_stat(NULL, &req, "watch_~1", NULL) !=UV_ENOENT;
705+
/* This test needs the watched directory to have an 8.3 short component. The
706+
generated "watch_dirXXXXXX" name is > 8 chars, so it gets a short alias on
707+
volumes where 8.3 name creation is enabled. For non-system volumes on
708+
newer Windows it's disabled by default (NtfsDisable8dot3NameCreation=3).
709+
The temp dir and the cwd may be on different volumes, so try each and use
710+
whichever has a short alias, and skip if neither does. */
711+
has_shortnames=0;
712+
temp_len=sizeof(temp_path);
713+
if (uv_os_tmpdir(temp_path, &temp_len) ==0)
714+
has_shortnames=short_path_make(temp_path,
715+
watch_dir, sizeof(watch_dir),
716+
short_dir, sizeof(short_dir));
717+
if (!has_shortnames)
718+
has_shortnames=short_path_make("",
719+
watch_dir, sizeof(watch_dir),
720+
short_dir, sizeof(short_dir));
721+
653722
if (has_shortnames) {
723+
snprintf(watch_file, sizeof(watch_file), "%s\\file1", watch_dir);
724+
/* short_path_file is used in the timer callback to touch the file. */
725+
snprintf(short_path_file, sizeof(short_path_file), "%s\\file1", short_dir);
726+
/* The directory was just created, so file1 cannot exist yet. */
727+
create_file(watch_file);
728+
654729
r=uv_fs_event_init(loop, &fs_event);
655730
ASSERT_OK(r);
656-
r=uv_fs_event_start(&fs_event, fs_event_cb_dir, "watch_~1", 0);
731+
r=uv_fs_event_start(&fs_event, fs_event_cb_dir, short_dir, 0);
657732
ASSERT_OK(r);
658733
r=uv_timer_init(loop, &timer);
659734
ASSERT_OK(r);
660-
r=uv_timer_start(&timer, timer_cb_file, 100, 0);
735+
r=uv_timer_start(&timer, short_path_timer_cb, 100, 0);
661736
ASSERT_OK(r);
662737

663738
uv_run(loop, UV_RUN_DEFAULT);
664739

665740
ASSERT_EQ(1, fs_event_cb_called);
666741
ASSERT_EQ(1, timer_cb_called);
667742
ASSERT_EQ(1, close_cb_called);
668-
}
669743

670-
/* Cleanup */
671-
delete_file("watch_dir/file1");
672-
delete_dir("watch_dir/");
744+
/* Cleanup */
745+
delete_file(watch_file);
746+
delete_dir(watch_dir);
747+
}
673748

674749
MAKE_VALGRIND_HAPPY(loop);
675750

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Commit e640dc9

Browse files
authored
win: handle short path mismatch with a fallback in fs events (#5152)
uv_fs_event_start() stores the watched directory path verbatim in handle->dirw. When an event arrives, the child path is resolved to its long form with GetLongPathNameW() and uv__relative_path() strips the handle->dirw prefix off the result. Previously if the directory was supplied as an 8.3 short path, the long form no longer shares that prefix, so the prefix check in uv__relative_path() fails, which either fires an assertion in builds without NDEBUG or produces a wrong(potentially out-of-bounds) result otherwise. This patch falls back to the name reported by ReadDirectoryChangesW in this case, since that is already relative to the watched directory, similar to how other branches handle it. Also update the test to try testing under %TEMP% if accessible to increase the chance of it reproducing in the CI.
1 parent f6b7133 commit e640dc9

2 files changed

Lines changed: 116 additions & 27 deletions

File tree

‎src/win/fs-event.c‎

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,17 @@ static void uv__fs_event_queue_readdirchanges(uv_loop_t* loop,
6363
handle->req_pending=1;
6464
}
6565

66-
staticvoiduv__relative_path(constWCHAR*filename,
67-
constWCHAR*dir,
68-
WCHAR**relpath) {
66+
/* Compute the path of `filename` relative to the watched directory `dir`.
67+
* Returns 0 on success, -1 if `filename` is not actually prefixed by `dir`,
68+
* which can happen if the directory is a short path. */
69+
staticintuv__relative_path(constWCHAR*filename,
70+
constWCHAR*dir,
71+
WCHAR**relpath) {
6972
size_trelpathlen;
7073
size_tfilenamelen=wcslen(filename);
7174
size_tdirlen=wcslen(dir);
72-
assert(!_wcsnicmp(filename, dir, dirlen));
75+
if (filenamelen <= dirlen||_wcsnicmp(filename, dir, dirlen) !=0)
76+
return-1;
7377
if (dirlen>0&&dir[dirlen-1] =='\\')
7478
dirlen--;
7579
relpathlen=filenamelen-dirlen-1;
@@ -78,6 +82,7 @@ static void uv__relative_path(const WCHAR* filename,
7882
uv_fatal_error(ERROR_OUTOFMEMORY, "uv__malloc");
7983
wcsncpy(*relpath, filename+dirlen+1, relpathlen);
8084
(*relpath)[relpathlen] =L'\0';
85+
return0;
8186
}
8287

8388
staticintuv__split_path(constWCHAR*filename, WCHAR**dir,
@@ -522,12 +527,21 @@ void uv__process_fs_event_req(uv_loop_t* loop, uv_req_t* req,
522527

523528
if (long_filenamew) {
524529
/* Get the file name out of the long path. */
525-
uv__relative_path(long_filenamew,
526-
handle->dirw,
527-
&filenamew);
528-
uv__free(long_filenamew);
529-
long_filenamew=filenamew;
530-
sizew=-1;
530+
if (uv__relative_path(long_filenamew,
531+
handle->dirw,
532+
&filenamew) ==0) {
533+
uv__free(long_filenamew);
534+
long_filenamew=filenamew;
535+
sizew=-1;
536+
} else {
537+
/* The resolved long path was not prefixed by the watched
538+
* directory (e.g. short name vs long name mismatch),
539+
* fall back to the name given by ReadDirectoryChangesW. */
540+
uv__free(long_filenamew);
541+
long_filenamew=NULL;
542+
filenamew=file_info->FileName;
543+
sizew=file_info->FileNameLength / sizeof(WCHAR);
544+
}
531545
} else {
532546
/* We couldn't get the long filename, use the one reported. */
533547
filenamew=file_info->FileName;

‎test/test-fs-event.c‎

Lines changed: 92 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -632,44 +632,119 @@ TEST_IMPL(fs_event_watch_dir_recursive) {
632632
}
633633

634634
#ifdef_WIN32
635+
staticcharshort_path_file[MAX_PATH];
636+
637+
staticvoidshort_path_timer_cb(uv_timer_t*handle) {
638+
++timer_cb_called;
639+
touch_file(short_path_file);
640+
}
641+
642+
/* Try to create a unique watch directory that has a 8.3 short component
643+
under `parent` ("" means the cwd). If it's successful, fills `watch_dir`
644+
and `short_dir` with the long and short forms of the created directory
645+
respectively, and returns 1. Otherwise removes the directory created
646+
and returns 0. */
647+
staticintshort_path_make(constchar*parent,
648+
char*watch_dir, size_twatch_n,
649+
char*short_dir, size_tshort_n) {
650+
uv_fs_treq;
651+
chartmpl[MAX_PATH];
652+
WCHARwatch_dirw[MAX_PATH];
653+
WCHARshort_dirw[MAX_PATH];
654+
WCHARlong_dirw[MAX_PATH];
655+
size_tpathlen;
656+
intr;
657+
658+
if (parent[0] !='\0')
659+
r=snprintf(tmpl, sizeof(tmpl), "%s\\watch_dirXXXXXX", parent);
660+
else
661+
r=snprintf(tmpl, sizeof(tmpl), "watch_dirXXXXXX");
662+
if (r<0|| (size_t) r >= sizeof(tmpl))
663+
return0;
664+
665+
r=uv_fs_mkdtemp(NULL, &req, tmpl, NULL);
666+
if (r!=0) {
667+
uv_fs_req_cleanup(&req);
668+
return0;
669+
}
670+
671+
/* Copy the created path out before cleaning up the request that owns it. */
672+
pathlen=strlen(req.path);
673+
memcpy(watch_dir, req.path, pathlen+1);
674+
uv_fs_req_cleanup(&req);
675+
676+
/* The caller appends "\file1" to both watch_dir and short_dir. If there is
677+
no room for that suffix, skip this location. */
678+
if (pathlen+sizeof("\\file1") <= watch_n&&
679+
MultiByteToWideChar(CP_UTF8, 0, watch_dir, -1,
680+
watch_dirw, ARRAY_SIZE(watch_dirw)) !=0&&
681+
GetShortPathNameW(watch_dirw, short_dirw, ARRAY_SIZE(short_dirw)) !=0&&
682+
GetLongPathNameW(watch_dirw, long_dirw, ARRAY_SIZE(long_dirw)) !=0&&
683+
_wcsicmp(short_dirw, long_dirw) !=0&&
684+
WideCharToMultiByte(CP_UTF8, 0, short_dirw, -1,
685+
short_dir, (int) short_n, NULL, NULL) !=0)
686+
return1;
687+
688+
uv_fs_rmdir(NULL, &req, watch_dir, NULL);
689+
uv_fs_req_cleanup(&req);
690+
return0;
691+
}
692+
635693
TEST_IMPL(fs_event_watch_dir_short_path) {
636694
uv_loop_t*loop;
637-
uv_fs_treq;
695+
chartemp_path[MAX_PATH];
696+
charwatch_dir[MAX_PATH];
697+
charwatch_file[MAX_PATH];
698+
charshort_dir[MAX_PATH];
699+
size_ttemp_len;
638700
inthas_shortnames;
639701
intr;
640702

641-
/* Setup */
642703
loop=uv_default_loop();
643-
delete_file("watch_dir/file1");
644-
delete_dir("watch_dir/");
645-
create_dir("watch_dir");
646-
create_file("watch_dir/file1");
647704

648-
/* Newer version of Windows ship with
649-
HKLM\SYSTEM\CurrentControlSet\Control\FileSystem\NtfsDisable8dot3NameCreation
650-
not equal to 0. So we verify the files we created are addressable by a 8.3
651-
short name */
652-
has_shortnames=uv_fs_stat(NULL, &req, "watch_~1", NULL) !=UV_ENOENT;
705+
/* This test needs the watched directory to have an 8.3 short component. The
706+
generated "watch_dirXXXXXX" name is > 8 chars, so it gets a short alias on
707+
volumes where 8.3 name creation is enabled. For non-system volumes on
708+
newer Windows it's disabled by default (NtfsDisable8dot3NameCreation=3).
709+
The temp dir and the cwd may be on different volumes, so try each and use
710+
whichever has a short alias, and skip if neither does. */
711+
has_shortnames=0;
712+
temp_len=sizeof(temp_path);
713+
if (uv_os_tmpdir(temp_path, &temp_len) ==0)
714+
has_shortnames=short_path_make(temp_path,
715+
watch_dir, sizeof(watch_dir),
716+
short_dir, sizeof(short_dir));
717+
if (!has_shortnames)
718+
has_shortnames=short_path_make("",
719+
watch_dir, sizeof(watch_dir),
720+
short_dir, sizeof(short_dir));
721+
653722
if (has_shortnames) {
723+
snprintf(watch_file, sizeof(watch_file), "%s\\file1", watch_dir);
724+
/* short_path_file is used in the timer callback to touch the file. */
725+
snprintf(short_path_file, sizeof(short_path_file), "%s\\file1", short_dir);
726+
/* The directory was just created, so file1 cannot exist yet. */
727+
create_file(watch_file);
728+
654729
r=uv_fs_event_init(loop, &fs_event);
655730
ASSERT_OK(r);
656-
r=uv_fs_event_start(&fs_event, fs_event_cb_dir, "watch_~1", 0);
731+
r=uv_fs_event_start(&fs_event, fs_event_cb_dir, short_dir, 0);
657732
ASSERT_OK(r);
658733
r=uv_timer_init(loop, &timer);
659734
ASSERT_OK(r);
660-
r=uv_timer_start(&timer, timer_cb_file, 100, 0);
735+
r=uv_timer_start(&timer, short_path_timer_cb, 100, 0);
661736
ASSERT_OK(r);
662737

663738
uv_run(loop, UV_RUN_DEFAULT);
664739

665740
ASSERT_EQ(1, fs_event_cb_called);
666741
ASSERT_EQ(1, timer_cb_called);
667742
ASSERT_EQ(1, close_cb_called);
668-
}
669743

670-
/* Cleanup */
671-
delete_file("watch_dir/file1");
672-
delete_dir("watch_dir/");
744+
/* Cleanup */
745+
delete_file(watch_file);
746+
delete_dir(watch_dir);
747+
}
673748

674749
MAKE_VALGRIND_HAPPY(loop);
675750

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit e640dc9

Browse files
authored
win: handle short path mismatch with a fallback in fs events (#5152)
uv_fs_event_start() stores the watched directory path verbatim in handle->dirw. When an event arrives, the child path is resolved to its long form with GetLongPathNameW() and uv__relative_path() strips the handle->dirw prefix off the result. Previously if the directory was supplied as an 8.3 short path, the long form no longer shares that prefix, so the prefix check in uv__relative_path() fails, which either fires an assertion in builds without NDEBUG or produces a wrong(potentially out-of-bounds) result otherwise. This patch falls back to the name reported by ReadDirectoryChangesW in this case, since that is already relative to the watched directory, similar to how other branches handle it. Also update the test to try testing under %TEMP% if accessible to increase the chance of it reproducing in the CI.
1 parent f6b7133 commit e640dc9

2 files changed

Lines changed: 116 additions & 27 deletions

File tree

‎src/win/fs-event.c‎

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,17 @@ static void uv__fs_event_queue_readdirchanges(uv_loop_t* loop,
6363
handle->req_pending=1;
6464
}
6565

66-
staticvoiduv__relative_path(constWCHAR*filename,
67-
constWCHAR*dir,
68-
WCHAR**relpath) {
66+
/* Compute the path of `filename` relative to the watched directory `dir`.
67+
* Returns 0 on success, -1 if `filename` is not actually prefixed by `dir`,
68+
* which can happen if the directory is a short path. */
69+
staticintuv__relative_path(constWCHAR*filename,
70+
constWCHAR*dir,
71+
WCHAR**relpath) {
6972
size_trelpathlen;
7073
size_tfilenamelen=wcslen(filename);
7174
size_tdirlen=wcslen(dir);
72-
assert(!_wcsnicmp(filename, dir, dirlen));
75+
if (filenamelen <= dirlen||_wcsnicmp(filename, dir, dirlen) !=0)
76+
return-1;
7377
if (dirlen>0&&dir[dirlen-1] =='\\')
7478
dirlen--;
7579
relpathlen=filenamelen-dirlen-1;
@@ -78,6 +82,7 @@ static void uv__relative_path(const WCHAR* filename,
7882
uv_fatal_error(ERROR_OUTOFMEMORY, "uv__malloc");
7983
wcsncpy(*relpath, filename+dirlen+1, relpathlen);
8084
(*relpath)[relpathlen] =L'\0';
85+
return0;
8186
}
8287

8388
staticintuv__split_path(constWCHAR*filename, WCHAR**dir,
@@ -522,12 +527,21 @@ void uv__process_fs_event_req(uv_loop_t* loop, uv_req_t* req,
522527

523528
if (long_filenamew) {
524529
/* Get the file name out of the long path. */
525-
uv__relative_path(long_filenamew,
526-
handle->dirw,
527-
&filenamew);
528-
uv__free(long_filenamew);
529-
long_filenamew=filenamew;
530-
sizew=-1;
530+
if (uv__relative_path(long_filenamew,
531+
handle->dirw,
532+
&filenamew) ==0) {
533+
uv__free(long_filenamew);
534+
long_filenamew=filenamew;
535+
sizew=-1;
536+
} else {
537+
/* The resolved long path was not prefixed by the watched
538+
* directory (e.g. short name vs long name mismatch),
539+
* fall back to the name given by ReadDirectoryChangesW. */
540+
uv__free(long_filenamew);
541+
long_filenamew=NULL;
542+
filenamew=file_info->FileName;
543+
sizew=file_info->FileNameLength / sizeof(WCHAR);
544+
}
531545
} else {
532546
/* We couldn't get the long filename, use the one reported. */
533547
filenamew=file_info->FileName;

‎test/test-fs-event.c‎

Lines changed: 92 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -632,44 +632,119 @@ TEST_IMPL(fs_event_watch_dir_recursive) {
632632
}
633633

634634
#ifdef_WIN32
635+
staticcharshort_path_file[MAX_PATH];
636+
637+
staticvoidshort_path_timer_cb(uv_timer_t*handle) {
638+
++timer_cb_called;
639+
touch_file(short_path_file);
640+
}
641+
642+
/* Try to create a unique watch directory that has a 8.3 short component
643+
under `parent` ("" means the cwd). If it's successful, fills `watch_dir`
644+
and `short_dir` with the long and short forms of the created directory
645+
respectively, and returns 1. Otherwise removes the directory created
646+
and returns 0. */
647+
staticintshort_path_make(constchar*parent,
648+
char*watch_dir, size_twatch_n,
649+
char*short_dir, size_tshort_n) {
650+
uv_fs_treq;
651+
chartmpl[MAX_PATH];
652+
WCHARwatch_dirw[MAX_PATH];
653+
WCHARshort_dirw[MAX_PATH];
654+
WCHARlong_dirw[MAX_PATH];
655+
size_tpathlen;
656+
intr;
657+
658+
if (parent[0] !='\0')
659+
r=snprintf(tmpl, sizeof(tmpl), "%s\\watch_dirXXXXXX", parent);
660+
else
661+
r=snprintf(tmpl, sizeof(tmpl), "watch_dirXXXXXX");
662+
if (r<0|| (size_t) r >= sizeof(tmpl))
663+
return0;
664+
665+
r=uv_fs_mkdtemp(NULL, &req, tmpl, NULL);
666+
if (r!=0) {
667+
uv_fs_req_cleanup(&req);
668+
return0;
669+
}
670+
671+
/* Copy the created path out before cleaning up the request that owns it. */
672+
pathlen=strlen(req.path);
673+
memcpy(watch_dir, req.path, pathlen+1);
674+
uv_fs_req_cleanup(&req);
675+
676+
/* The caller appends "\file1" to both watch_dir and short_dir. If there is
677+
no room for that suffix, skip this location. */
678+
if (pathlen+sizeof("\\file1") <= watch_n&&
679+
MultiByteToWideChar(CP_UTF8, 0, watch_dir, -1,
680+
watch_dirw, ARRAY_SIZE(watch_dirw)) !=0&&
681+
GetShortPathNameW(watch_dirw, short_dirw, ARRAY_SIZE(short_dirw)) !=0&&
682+
GetLongPathNameW(watch_dirw, long_dirw, ARRAY_SIZE(long_dirw)) !=0&&
683+
_wcsicmp(short_dirw, long_dirw) !=0&&
684+
WideCharToMultiByte(CP_UTF8, 0, short_dirw, -1,
685+
short_dir, (int) short_n, NULL, NULL) !=0)
686+
return1;
687+
688+
uv_fs_rmdir(NULL, &req, watch_dir, NULL);
689+
uv_fs_req_cleanup(&req);
690+
return0;
691+
}
692+
635693
TEST_IMPL(fs_event_watch_dir_short_path) {
636694
uv_loop_t*loop;
637-
uv_fs_treq;
695+
chartemp_path[MAX_PATH];
696+
charwatch_dir[MAX_PATH];
697+
charwatch_file[MAX_PATH];
698+
charshort_dir[MAX_PATH];
699+
size_ttemp_len;
638700
inthas_shortnames;
639701
intr;
640702

641-
/* Setup */
642703
loop=uv_default_loop();
643-
delete_file("watch_dir/file1");
644-
delete_dir("watch_dir/");
645-
create_dir("watch_dir");
646-
create_file("watch_dir/file1");
647704

648-
/* Newer version of Windows ship with
649-
HKLM\SYSTEM\CurrentControlSet\Control\FileSystem\NtfsDisable8dot3NameCreation
650-
not equal to 0. So we verify the files we created are addressable by a 8.3
651-
short name */
652-
has_shortnames=uv_fs_stat(NULL, &req, "watch_~1", NULL) !=UV_ENOENT;
705+
/* This test needs the watched directory to have an 8.3 short component. The
706+
generated "watch_dirXXXXXX" name is > 8 chars, so it gets a short alias on
707+
volumes where 8.3 name creation is enabled. For non-system volumes on
708+
newer Windows it's disabled by default (NtfsDisable8dot3NameCreation=3).
709+
The temp dir and the cwd may be on different volumes, so try each and use
710+
whichever has a short alias, and skip if neither does. */
711+
has_shortnames=0;
712+
temp_len=sizeof(temp_path);
713+
if (uv_os_tmpdir(temp_path, &temp_len) ==0)
714+
has_shortnames=short_path_make(temp_path,
715+
watch_dir, sizeof(watch_dir),
716+
short_dir, sizeof(short_dir));
717+
if (!has_shortnames)
718+
has_shortnames=short_path_make("",
719+
watch_dir, sizeof(watch_dir),
720+
short_dir, sizeof(short_dir));
721+
653722
if (has_shortnames) {
723+
snprintf(watch_file, sizeof(watch_file), "%s\\file1", watch_dir);
724+
/* short_path_file is used in the timer callback to touch the file. */
725+
snprintf(short_path_file, sizeof(short_path_file), "%s\\file1", short_dir);
726+
/* The directory was just created, so file1 cannot exist yet. */
727+
create_file(watch_file);
728+
654729
r=uv_fs_event_init(loop, &fs_event);
655730
ASSERT_OK(r);
656-
r=uv_fs_event_start(&fs_event, fs_event_cb_dir, "watch_~1", 0);
731+
r=uv_fs_event_start(&fs_event, fs_event_cb_dir, short_dir, 0);
657732
ASSERT_OK(r);
658733
r=uv_timer_init(loop, &timer);
659734
ASSERT_OK(r);
660-
r=uv_timer_start(&timer, timer_cb_file, 100, 0);
735+
r=uv_timer_start(&timer, short_path_timer_cb, 100, 0);
661736
ASSERT_OK(r);
662737

663738
uv_run(loop, UV_RUN_DEFAULT);
664739

665740
ASSERT_EQ(1, fs_event_cb_called);
666741
ASSERT_EQ(1, timer_cb_called);
667742
ASSERT_EQ(1, close_cb_called);
668-
}
669743

670-
/* Cleanup */
671-
delete_file("watch_dir/file1");
672-
delete_dir("watch_dir/");
744+
/* Cleanup */
745+
delete_file(watch_file);
746+
delete_dir(watch_dir);
747+
}
673748

674749
MAKE_VALGRIND_HAPPY(loop);
675750

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit e640dc9

Browse files
authored
win: handle short path mismatch with a fallback in fs events (#5152)
uv_fs_event_start() stores the watched directory path verbatim in handle->dirw. When an event arrives, the child path is resolved to its long form with GetLongPathNameW() and uv__relative_path() strips the handle->dirw prefix off the result. Previously if the directory was supplied as an 8.3 short path, the long form no longer shares that prefix, so the prefix check in uv__relative_path() fails, which either fires an assertion in builds without NDEBUG or produces a wrong(potentially out-of-bounds) result otherwise. This patch falls back to the name reported by ReadDirectoryChangesW in this case, since that is already relative to the watched directory, similar to how other branches handle it. Also update the test to try testing under %TEMP% if accessible to increase the chance of it reproducing in the CI.
1 parent f6b7133 commit e640dc9

2 files changed

Lines changed: 116 additions & 27 deletions

File tree

‎src/win/fs-event.c‎

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,17 @@ static void uv__fs_event_queue_readdirchanges(uv_loop_t* loop,
6363
handle->req_pending=1;
6464
}
6565

66-
staticvoiduv__relative_path(constWCHAR*filename,
67-
constWCHAR*dir,
68-
WCHAR**relpath) {
66+
/* Compute the path of `filename` relative to the watched directory `dir`.
67+
* Returns 0 on success, -1 if `filename` is not actually prefixed by `dir`,
68+
* which can happen if the directory is a short path. */
69+
staticintuv__relative_path(constWCHAR*filename,
70+
constWCHAR*dir,
71+
WCHAR**relpath) {
6972
size_trelpathlen;
7073
size_tfilenamelen=wcslen(filename);
7174
size_tdirlen=wcslen(dir);
72-
assert(!_wcsnicmp(filename, dir, dirlen));
75+
if (filenamelen <= dirlen||_wcsnicmp(filename, dir, dirlen) !=0)
76+
return-1;
7377
if (dirlen>0&&dir[dirlen-1] =='\\')
7478
dirlen--;
7579
relpathlen=filenamelen-dirlen-1;
@@ -78,6 +82,7 @@ static void uv__relative_path(const WCHAR* filename,
7882
uv_fatal_error(ERROR_OUTOFMEMORY, "uv__malloc");
7983
wcsncpy(*relpath, filename+dirlen+1, relpathlen);
8084
(*relpath)[relpathlen] =L'\0';
85+
return0;
8186
}
8287

8388
staticintuv__split_path(constWCHAR*filename, WCHAR**dir,
@@ -522,12 +527,21 @@ void uv__process_fs_event_req(uv_loop_t* loop, uv_req_t* req,
522527

523528
if (long_filenamew) {
524529
/* Get the file name out of the long path. */
525-
uv__relative_path(long_filenamew,
526-
handle->dirw,
527-
&filenamew);
528-
uv__free(long_filenamew);
529-
long_filenamew=filenamew;
530-
sizew=-1;
530+
if (uv__relative_path(long_filenamew,
531+
handle->dirw,
532+
&filenamew) ==0) {
533+
uv__free(long_filenamew);
534+
long_filenamew=filenamew;
535+
sizew=-1;
536+
} else {
537+
/* The resolved long path was not prefixed by the watched
538+
* directory (e.g. short name vs long name mismatch),
539+
* fall back to the name given by ReadDirectoryChangesW. */
540+
uv__free(long_filenamew);
541+
long_filenamew=NULL;
542+
filenamew=file_info->FileName;
543+
sizew=file_info->FileNameLength / sizeof(WCHAR);
544+
}
531545
} else {
532546
/* We couldn't get the long filename, use the one reported. */
533547
filenamew=file_info->FileName;

‎test/test-fs-event.c‎

Lines changed: 92 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -632,44 +632,119 @@ TEST_IMPL(fs_event_watch_dir_recursive) {
632632
}
633633

634634
#ifdef_WIN32
635+
staticcharshort_path_file[MAX_PATH];
636+
637+
staticvoidshort_path_timer_cb(uv_timer_t*handle) {
638+
++timer_cb_called;
639+
touch_file(short_path_file);
640+
}
641+
642+
/* Try to create a unique watch directory that has a 8.3 short component
643+
under `parent` ("" means the cwd). If it's successful, fills `watch_dir`
644+
and `short_dir` with the long and short forms of the created directory
645+
respectively, and returns 1. Otherwise removes the directory created
646+
and returns 0. */
647+
staticintshort_path_make(constchar*parent,
648+
char*watch_dir, size_twatch_n,
649+
char*short_dir, size_tshort_n) {
650+
uv_fs_treq;
651+
chartmpl[MAX_PATH];
652+
WCHARwatch_dirw[MAX_PATH];
653+
WCHARshort_dirw[MAX_PATH];
654+
WCHARlong_dirw[MAX_PATH];
655+
size_tpathlen;
656+
intr;
657+
658+
if (parent[0] !='\0')
659+
r=snprintf(tmpl, sizeof(tmpl), "%s\\watch_dirXXXXXX", parent);
660+
else
661+
r=snprintf(tmpl, sizeof(tmpl), "watch_dirXXXXXX");
662+
if (r<0|| (size_t) r >= sizeof(tmpl))
663+
return0;
664+
665+
r=uv_fs_mkdtemp(NULL, &req, tmpl, NULL);
666+
if (r!=0) {
667+
uv_fs_req_cleanup(&req);
668+
return0;
669+
}
670+
671+
/* Copy the created path out before cleaning up the request that owns it. */
672+
pathlen=strlen(req.path);
673+
memcpy(watch_dir, req.path, pathlen+1);
674+
uv_fs_req_cleanup(&req);
675+
676+
/* The caller appends "\file1" to both watch_dir and short_dir. If there is
677+
no room for that suffix, skip this location. */
678+
if (pathlen+sizeof("\\file1") <= watch_n&&
679+
MultiByteToWideChar(CP_UTF8, 0, watch_dir, -1,
680+
watch_dirw, ARRAY_SIZE(watch_dirw)) !=0&&
681+
GetShortPathNameW(watch_dirw, short_dirw, ARRAY_SIZE(short_dirw)) !=0&&
682+
GetLongPathNameW(watch_dirw, long_dirw, ARRAY_SIZE(long_dirw)) !=0&&
683+
_wcsicmp(short_dirw, long_dirw) !=0&&
684+
WideCharToMultiByte(CP_UTF8, 0, short_dirw, -1,
685+
short_dir, (int) short_n, NULL, NULL) !=0)
686+
return1;
687+
688+
uv_fs_rmdir(NULL, &req, watch_dir, NULL);
689+
uv_fs_req_cleanup(&req);
690+
return0;
691+
}
692+
635693
TEST_IMPL(fs_event_watch_dir_short_path) {
636694
uv_loop_t*loop;
637-
uv_fs_treq;
695+
chartemp_path[MAX_PATH];
696+
charwatch_dir[MAX_PATH];
697+
charwatch_file[MAX_PATH];
698+
charshort_dir[MAX_PATH];
699+
size_ttemp_len;
638700
inthas_shortnames;
639701
intr;
640702

641-
/* Setup */
642703
loop=uv_default_loop();
643-
delete_file("watch_dir/file1");
644-
delete_dir("watch_dir/");
645-
create_dir("watch_dir");
646-
create_file("watch_dir/file1");
647704

648-
/* Newer version of Windows ship with
649-
HKLM\SYSTEM\CurrentControlSet\Control\FileSystem\NtfsDisable8dot3NameCreation
650-
not equal to 0. So we verify the files we created are addressable by a 8.3
651-
short name */
652-
has_shortnames=uv_fs_stat(NULL, &req, "watch_~1", NULL) !=UV_ENOENT;
705+
/* This test needs the watched directory to have an 8.3 short component. The
706+
generated "watch_dirXXXXXX" name is > 8 chars, so it gets a short alias on
707+
volumes where 8.3 name creation is enabled. For non-system volumes on
708+
newer Windows it's disabled by default (NtfsDisable8dot3NameCreation=3).
709+
The temp dir and the cwd may be on different volumes, so try each and use
710+
whichever has a short alias, and skip if neither does. */
711+
has_shortnames=0;
712+
temp_len=sizeof(temp_path);
713+
if (uv_os_tmpdir(temp_path, &temp_len) ==0)
714+
has_shortnames=short_path_make(temp_path,
715+
watch_dir, sizeof(watch_dir),
716+
short_dir, sizeof(short_dir));
717+
if (!has_shortnames)
718+
has_shortnames=short_path_make("",
719+
watch_dir, sizeof(watch_dir),
720+
short_dir, sizeof(short_dir));
721+
653722
if (has_shortnames) {
723+
snprintf(watch_file, sizeof(watch_file), "%s\\file1", watch_dir);
724+
/* short_path_file is used in the timer callback to touch the file. */
725+
snprintf(short_path_file, sizeof(short_path_file), "%s\\file1", short_dir);
726+
/* The directory was just created, so file1 cannot exist yet. */
727+
create_file(watch_file);
728+
654729
r=uv_fs_event_init(loop, &fs_event);
655730
ASSERT_OK(r);
656-
r=uv_fs_event_start(&fs_event, fs_event_cb_dir, "watch_~1", 0);
731+
r=uv_fs_event_start(&fs_event, fs_event_cb_dir, short_dir, 0);
657732
ASSERT_OK(r);
658733
r=uv_timer_init(loop, &timer);
659734
ASSERT_OK(r);
660-
r=uv_timer_start(&timer, timer_cb_file, 100, 0);
735+
r=uv_timer_start(&timer, short_path_timer_cb, 100, 0);
661736
ASSERT_OK(r);
662737

663738
uv_run(loop, UV_RUN_DEFAULT);
664739

665740
ASSERT_EQ(1, fs_event_cb_called);
666741
ASSERT_EQ(1, timer_cb_called);
667742
ASSERT_EQ(1, close_cb_called);
668-
}
669743

670-
/* Cleanup */
671-
delete_file("watch_dir/file1");
672-
delete_dir("watch_dir/");
744+
/* Cleanup */
745+
delete_file(watch_file);
746+
delete_dir(watch_dir);
747+
}
673748

674749
MAKE_VALGRIND_HAPPY(loop);
675750

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Commit e640dc9

Browse files
authored
win: handle short path mismatch with a fallback in fs events (#5152)
uv_fs_event_start() stores the watched directory path verbatim in handle->dirw. When an event arrives, the child path is resolved to its long form with GetLongPathNameW() and uv__relative_path() strips the handle->dirw prefix off the result. Previously if the directory was supplied as an 8.3 short path, the long form no longer shares that prefix, so the prefix check in uv__relative_path() fails, which either fires an assertion in builds without NDEBUG or produces a wrong(potentially out-of-bounds) result otherwise. This patch falls back to the name reported by ReadDirectoryChangesW in this case, since that is already relative to the watched directory, similar to how other branches handle it. Also update the test to try testing under %TEMP% if accessible to increase the chance of it reproducing in the CI.
1 parent f6b7133 commit e640dc9

2 files changed

Lines changed: 116 additions & 27 deletions

File tree

‎src/win/fs-event.c‎

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,17 @@ static void uv__fs_event_queue_readdirchanges(uv_loop_t* loop,
6363
handle->req_pending=1;
6464
}
6565

66-
staticvoiduv__relative_path(constWCHAR*filename,
67-
constWCHAR*dir,
68-
WCHAR**relpath) {
66+
/* Compute the path of `filename` relative to the watched directory `dir`.
67+
* Returns 0 on success, -1 if `filename` is not actually prefixed by `dir`,
68+
* which can happen if the directory is a short path. */
69+
staticintuv__relative_path(constWCHAR*filename,
70+
constWCHAR*dir,
71+
WCHAR**relpath) {
6972
size_trelpathlen;
7073
size_tfilenamelen=wcslen(filename);
7174
size_tdirlen=wcslen(dir);
72-
assert(!_wcsnicmp(filename, dir, dirlen));
75+
if (filenamelen <= dirlen||_wcsnicmp(filename, dir, dirlen) !=0)
76+
return-1;
7377
if (dirlen>0&&dir[dirlen-1] =='\\')
7478
dirlen--;
7579
relpathlen=filenamelen-dirlen-1;
@@ -78,6 +82,7 @@ static void uv__relative_path(const WCHAR* filename,
7882
uv_fatal_error(ERROR_OUTOFMEMORY, "uv__malloc");
7983
wcsncpy(*relpath, filename+dirlen+1, relpathlen);
8084
(*relpath)[relpathlen] =L'\0';
85+
return0;
8186
}
8287

8388
staticintuv__split_path(constWCHAR*filename, WCHAR**dir,
@@ -522,12 +527,21 @@ void uv__process_fs_event_req(uv_loop_t* loop, uv_req_t* req,
522527

523528
if (long_filenamew) {
524529
/* Get the file name out of the long path. */
525-
uv__relative_path(long_filenamew,
526-
handle->dirw,
527-
&filenamew);
528-
uv__free(long_filenamew);
529-
long_filenamew=filenamew;
530-
sizew=-1;
530+
if (uv__relative_path(long_filenamew,
531+
handle->dirw,
532+
&filenamew) ==0) {
533+
uv__free(long_filenamew);
534+
long_filenamew=filenamew;
535+
sizew=-1;
536+
} else {
537+
/* The resolved long path was not prefixed by the watched
538+
* directory (e.g. short name vs long name mismatch),
539+
* fall back to the name given by ReadDirectoryChangesW. */
540+
uv__free(long_filenamew);
541+
long_filenamew=NULL;
542+
filenamew=file_info->FileName;
543+
sizew=file_info->FileNameLength / sizeof(WCHAR);
544+
}
531545
} else {
532546
/* We couldn't get the long filename, use the one reported. */
533547
filenamew=file_info->FileName;

‎test/test-fs-event.c‎

Lines changed: 92 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -632,44 +632,119 @@ TEST_IMPL(fs_event_watch_dir_recursive) {
632632
}
633633

634634
#ifdef_WIN32
635+
staticcharshort_path_file[MAX_PATH];
636+
637+
staticvoidshort_path_timer_cb(uv_timer_t*handle) {
638+
++timer_cb_called;
639+
touch_file(short_path_file);
640+
}
641+
642+
/* Try to create a unique watch directory that has a 8.3 short component
643+
under `parent` ("" means the cwd). If it's successful, fills `watch_dir`
644+
and `short_dir` with the long and short forms of the created directory
645+
respectively, and returns 1. Otherwise removes the directory created
646+
and returns 0. */
647+
staticintshort_path_make(constchar*parent,
648+
char*watch_dir, size_twatch_n,
649+
char*short_dir, size_tshort_n) {
650+
uv_fs_treq;
651+
chartmpl[MAX_PATH];
652+
WCHARwatch_dirw[MAX_PATH];
653+
WCHARshort_dirw[MAX_PATH];
654+
WCHARlong_dirw[MAX_PATH];
655+
size_tpathlen;
656+
intr;
657+
658+
if (parent[0] !='\0')
659+
r=snprintf(tmpl, sizeof(tmpl), "%s\\watch_dirXXXXXX", parent);
660+
else
661+
r=snprintf(tmpl, sizeof(tmpl), "watch_dirXXXXXX");
662+
if (r<0|| (size_t) r >= sizeof(tmpl))
663+
return0;
664+
665+
r=uv_fs_mkdtemp(NULL, &req, tmpl, NULL);
666+
if (r!=0) {
667+
uv_fs_req_cleanup(&req);
668+
return0;
669+
}
670+
671+
/* Copy the created path out before cleaning up the request that owns it. */
672+
pathlen=strlen(req.path);
673+
memcpy(watch_dir, req.path, pathlen+1);
674+
uv_fs_req_cleanup(&req);
675+
676+
/* The caller appends "\file1" to both watch_dir and short_dir. If there is
677+
no room for that suffix, skip this location. */
678+
if (pathlen+sizeof("\\file1") <= watch_n&&
679+
MultiByteToWideChar(CP_UTF8, 0, watch_dir, -1,
680+
watch_dirw, ARRAY_SIZE(watch_dirw)) !=0&&
681+
GetShortPathNameW(watch_dirw, short_dirw, ARRAY_SIZE(short_dirw)) !=0&&
682+
GetLongPathNameW(watch_dirw, long_dirw, ARRAY_SIZE(long_dirw)) !=0&&
683+
_wcsicmp(short_dirw, long_dirw) !=0&&
684+
WideCharToMultiByte(CP_UTF8, 0, short_dirw, -1,
685+
short_dir, (int) short_n, NULL, NULL) !=0)
686+
return1;
687+
688+
uv_fs_rmdir(NULL, &req, watch_dir, NULL);
689+
uv_fs_req_cleanup(&req);
690+
return0;
691+
}
692+
635693
TEST_IMPL(fs_event_watch_dir_short_path) {
636694
uv_loop_t*loop;
637-
uv_fs_treq;
695+
chartemp_path[MAX_PATH];
696+
charwatch_dir[MAX_PATH];
697+
charwatch_file[MAX_PATH];
698+
charshort_dir[MAX_PATH];
699+
size_ttemp_len;
638700
inthas_shortnames;
639701
intr;
640702

641-
/* Setup */
642703
loop=uv_default_loop();
643-
delete_file("watch_dir/file1");
644-
delete_dir("watch_dir/");
645-
create_dir("watch_dir");
646-
create_file("watch_dir/file1");
647704

648-
/* Newer version of Windows ship with
649-
HKLM\SYSTEM\CurrentControlSet\Control\FileSystem\NtfsDisable8dot3NameCreation
650-
not equal to 0. So we verify the files we created are addressable by a 8.3
651-
short name */
652-
has_shortnames=uv_fs_stat(NULL, &req, "watch_~1", NULL) !=UV_ENOENT;
705+
/* This test needs the watched directory to have an 8.3 short component. The
706+
generated "watch_dirXXXXXX" name is > 8 chars, so it gets a short alias on
707+
volumes where 8.3 name creation is enabled. For non-system volumes on
708+
newer Windows it's disabled by default (NtfsDisable8dot3NameCreation=3).
709+
The temp dir and the cwd may be on different volumes, so try each and use
710+
whichever has a short alias, and skip if neither does. */
711+
has_shortnames=0;
712+
temp_len=sizeof(temp_path);
713+
if (uv_os_tmpdir(temp_path, &temp_len) ==0)
714+
has_shortnames=short_path_make(temp_path,
715+
watch_dir, sizeof(watch_dir),
716+
short_dir, sizeof(short_dir));
717+
if (!has_shortnames)
718+
has_shortnames=short_path_make("",
719+
watch_dir, sizeof(watch_dir),
720+
short_dir, sizeof(short_dir));
721+
653722
if (has_shortnames) {
723+
snprintf(watch_file, sizeof(watch_file), "%s\\file1", watch_dir);
724+
/* short_path_file is used in the timer callback to touch the file. */
725+
snprintf(short_path_file, sizeof(short_path_file), "%s\\file1", short_dir);
726+
/* The directory was just created, so file1 cannot exist yet. */
727+
create_file(watch_file);
728+
654729
r=uv_fs_event_init(loop, &fs_event);
655730
ASSERT_OK(r);
656-
r=uv_fs_event_start(&fs_event, fs_event_cb_dir, "watch_~1", 0);
731+
r=uv_fs_event_start(&fs_event, fs_event_cb_dir, short_dir, 0);
657732
ASSERT_OK(r);
658733
r=uv_timer_init(loop, &timer);
659734
ASSERT_OK(r);
660-
r=uv_timer_start(&timer, timer_cb_file, 100, 0);
735+
r=uv_timer_start(&timer, short_path_timer_cb, 100, 0);
661736
ASSERT_OK(r);
662737

663738
uv_run(loop, UV_RUN_DEFAULT);
664739

665740
ASSERT_EQ(1, fs_event_cb_called);
666741
ASSERT_EQ(1, timer_cb_called);
667742
ASSERT_EQ(1, close_cb_called);
668-
}
669743

670-
/* Cleanup */
671-
delete_file("watch_dir/file1");
672-
delete_dir("watch_dir/");
744+
/* Cleanup */
745+
delete_file(watch_file);
746+
delete_dir(watch_dir);
747+
}
673748

674749
MAKE_VALGRIND_HAPPY(loop);
675750

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit e640dc9

Browse files
authored
win: handle short path mismatch with a fallback in fs events (#5152)
uv_fs_event_start() stores the watched directory path verbatim in handle->dirw. When an event arrives, the child path is resolved to its long form with GetLongPathNameW() and uv__relative_path() strips the handle->dirw prefix off the result. Previously if the directory was supplied as an 8.3 short path, the long form no longer shares that prefix, so the prefix check in uv__relative_path() fails, which either fires an assertion in builds without NDEBUG or produces a wrong(potentially out-of-bounds) result otherwise. This patch falls back to the name reported by ReadDirectoryChangesW in this case, since that is already relative to the watched directory, similar to how other branches handle it. Also update the test to try testing under %TEMP% if accessible to increase the chance of it reproducing in the CI.
1 parent f6b7133 commit e640dc9

2 files changed

Lines changed: 116 additions & 27 deletions

File tree

‎src/win/fs-event.c‎

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,17 @@ static void uv__fs_event_queue_readdirchanges(uv_loop_t* loop,
6363
handle->req_pending=1;
6464
}
6565

66-
staticvoiduv__relative_path(constWCHAR*filename,
67-
constWCHAR*dir,
68-
WCHAR**relpath) {
66+
/* Compute the path of `filename` relative to the watched directory `dir`.
67+
* Returns 0 on success, -1 if `filename` is not actually prefixed by `dir`,
68+
* which can happen if the directory is a short path. */
69+
staticintuv__relative_path(constWCHAR*filename,
70+
constWCHAR*dir,
71+
WCHAR**relpath) {
6972
size_trelpathlen;
7073
size_tfilenamelen=wcslen(filename);
7174
size_tdirlen=wcslen(dir);
72-
assert(!_wcsnicmp(filename, dir, dirlen));
75+
if (filenamelen <= dirlen||_wcsnicmp(filename, dir, dirlen) !=0)
76+
return-1;
7377
if (dirlen>0&&dir[dirlen-1] =='\\')
7478
dirlen--;
7579
relpathlen=filenamelen-dirlen-1;
@@ -78,6 +82,7 @@ static void uv__relative_path(const WCHAR* filename,
7882
uv_fatal_error(ERROR_OUTOFMEMORY, "uv__malloc");
7983
wcsncpy(*relpath, filename+dirlen+1, relpathlen);
8084
(*relpath)[relpathlen] =L'\0';
85+
return0;
8186
}
8287

8388
staticintuv__split_path(constWCHAR*filename, WCHAR**dir,
@@ -522,12 +527,21 @@ void uv__process_fs_event_req(uv_loop_t* loop, uv_req_t* req,
522527

523528
if (long_filenamew) {
524529
/* Get the file name out of the long path. */
525-
uv__relative_path(long_filenamew,
526-
handle->dirw,
527-
&filenamew);
528-
uv__free(long_filenamew);
529-
long_filenamew=filenamew;
530-
sizew=-1;
530+
if (uv__relative_path(long_filenamew,
531+
handle->dirw,
532+
&filenamew) ==0) {
533+
uv__free(long_filenamew);
534+
long_filenamew=filenamew;
535+
sizew=-1;
536+
} else {
537+
/* The resolved long path was not prefixed by the watched
538+
* directory (e.g. short name vs long name mismatch),
539+
* fall back to the name given by ReadDirectoryChangesW. */
540+
uv__free(long_filenamew);
541+
long_filenamew=NULL;
542+
filenamew=file_info->FileName;
543+
sizew=file_info->FileNameLength / sizeof(WCHAR);
544+
}
531545
} else {
532546
/* We couldn't get the long filename, use the one reported. */
533547
filenamew=file_info->FileName;

‎test/test-fs-event.c‎

Lines changed: 92 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -632,44 +632,119 @@ TEST_IMPL(fs_event_watch_dir_recursive) {
632632
}
633633

634634
#ifdef_WIN32
635+
staticcharshort_path_file[MAX_PATH];
636+
637+
staticvoidshort_path_timer_cb(uv_timer_t*handle) {
638+
++timer_cb_called;
639+
touch_file(short_path_file);
640+
}
641+
642+
/* Try to create a unique watch directory that has a 8.3 short component
643+
under `parent` ("" means the cwd). If it's successful, fills `watch_dir`
644+
and `short_dir` with the long and short forms of the created directory
645+
respectively, and returns 1. Otherwise removes the directory created
646+
and returns 0. */
647+
staticintshort_path_make(constchar*parent,
648+
char*watch_dir, size_twatch_n,
649+
char*short_dir, size_tshort_n) {
650+
uv_fs_treq;
651+
chartmpl[MAX_PATH];
652+
WCHARwatch_dirw[MAX_PATH];
653+
WCHARshort_dirw[MAX_PATH];
654+
WCHARlong_dirw[MAX_PATH];
655+
size_tpathlen;
656+
intr;
657+
658+
if (parent[0] !='\0')
659+
r=snprintf(tmpl, sizeof(tmpl), "%s\\watch_dirXXXXXX", parent);
660+
else
661+
r=snprintf(tmpl, sizeof(tmpl), "watch_dirXXXXXX");
662+
if (r<0|| (size_t) r >= sizeof(tmpl))
663+
return0;
664+
665+
r=uv_fs_mkdtemp(NULL, &req, tmpl, NULL);
666+
if (r!=0) {
667+
uv_fs_req_cleanup(&req);
668+
return0;
669+
}
670+
671+
/* Copy the created path out before cleaning up the request that owns it. */
672+
pathlen=strlen(req.path);
673+
memcpy(watch_dir, req.path, pathlen+1);
674+
uv_fs_req_cleanup(&req);
675+
676+
/* The caller appends "\file1" to both watch_dir and short_dir. If there is
677+
no room for that suffix, skip this location. */
678+
if (pathlen+sizeof("\\file1") <= watch_n&&
679+
MultiByteToWideChar(CP_UTF8, 0, watch_dir, -1,
680+
watch_dirw, ARRAY_SIZE(watch_dirw)) !=0&&
681+
GetShortPathNameW(watch_dirw, short_dirw, ARRAY_SIZE(short_dirw)) !=0&&
682+
GetLongPathNameW(watch_dirw, long_dirw, ARRAY_SIZE(long_dirw)) !=0&&
683+
_wcsicmp(short_dirw, long_dirw) !=0&&
684+
WideCharToMultiByte(CP_UTF8, 0, short_dirw, -1,
685+
short_dir, (int) short_n, NULL, NULL) !=0)
686+
return1;
687+
688+
uv_fs_rmdir(NULL, &req, watch_dir, NULL);
689+
uv_fs_req_cleanup(&req);
690+
return0;
691+
}
692+
635693
TEST_IMPL(fs_event_watch_dir_short_path) {
636694
uv_loop_t*loop;
637-
uv_fs_treq;
695+
chartemp_path[MAX_PATH];
696+
charwatch_dir[MAX_PATH];
697+
charwatch_file[MAX_PATH];
698+
charshort_dir[MAX_PATH];
699+
size_ttemp_len;
638700
inthas_shortnames;
639701
intr;
640702

641-
/* Setup */
642703
loop=uv_default_loop();
643-
delete_file("watch_dir/file1");
644-
delete_dir("watch_dir/");
645-
create_dir("watch_dir");
646-
create_file("watch_dir/file1");
647704

648-
/* Newer version of Windows ship with
649-
HKLM\SYSTEM\CurrentControlSet\Control\FileSystem\NtfsDisable8dot3NameCreation
650-
not equal to 0. So we verify the files we created are addressable by a 8.3
651-
short name */
652-
has_shortnames=uv_fs_stat(NULL, &req, "watch_~1", NULL) !=UV_ENOENT;
705+
/* This test needs the watched directory to have an 8.3 short component. The
706+
generated "watch_dirXXXXXX" name is > 8 chars, so it gets a short alias on
707+
volumes where 8.3 name creation is enabled. For non-system volumes on
708+
newer Windows it's disabled by default (NtfsDisable8dot3NameCreation=3).
709+
The temp dir and the cwd may be on different volumes, so try each and use
710+
whichever has a short alias, and skip if neither does. */
711+
has_shortnames=0;
712+
temp_len=sizeof(temp_path);
713+
if (uv_os_tmpdir(temp_path, &temp_len) ==0)
714+
has_shortnames=short_path_make(temp_path,
715+
watch_dir, sizeof(watch_dir),
716+
short_dir, sizeof(short_dir));
717+
if (!has_shortnames)
718+
has_shortnames=short_path_make("",
719+
watch_dir, sizeof(watch_dir),
720+
short_dir, sizeof(short_dir));
721+
653722
if (has_shortnames) {
723+
snprintf(watch_file, sizeof(watch_file), "%s\\file1", watch_dir);
724+
/* short_path_file is used in the timer callback to touch the file. */
725+
snprintf(short_path_file, sizeof(short_path_file), "%s\\file1", short_dir);
726+
/* The directory was just created, so file1 cannot exist yet. */
727+
create_file(watch_file);
728+
654729
r=uv_fs_event_init(loop, &fs_event);
655730
ASSERT_OK(r);
656-
r=uv_fs_event_start(&fs_event, fs_event_cb_dir, "watch_~1", 0);
731+
r=uv_fs_event_start(&fs_event, fs_event_cb_dir, short_dir, 0);
657732
ASSERT_OK(r);
658733
r=uv_timer_init(loop, &timer);
659734
ASSERT_OK(r);
660-
r=uv_timer_start(&timer, timer_cb_file, 100, 0);
735+
r=uv_timer_start(&timer, short_path_timer_cb, 100, 0);
661736
ASSERT_OK(r);
662737

663738
uv_run(loop, UV_RUN_DEFAULT);
664739

665740
ASSERT_EQ(1, fs_event_cb_called);
666741
ASSERT_EQ(1, timer_cb_called);
667742
ASSERT_EQ(1, close_cb_called);
668-
}
669743

670-
/* Cleanup */
671-
delete_file("watch_dir/file1");
672-
delete_dir("watch_dir/");
744+
/* Cleanup */
745+
delete_file(watch_file);
746+
delete_dir(watch_dir);
747+
}
673748

674749
MAKE_VALGRIND_HAPPY(loop);
675750

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit e640dc9

Browse files
authored
win: handle short path mismatch with a fallback in fs events (#5152)
uv_fs_event_start() stores the watched directory path verbatim in handle->dirw. When an event arrives, the child path is resolved to its long form with GetLongPathNameW() and uv__relative_path() strips the handle->dirw prefix off the result. Previously if the directory was supplied as an 8.3 short path, the long form no longer shares that prefix, so the prefix check in uv__relative_path() fails, which either fires an assertion in builds without NDEBUG or produces a wrong(potentially out-of-bounds) result otherwise. This patch falls back to the name reported by ReadDirectoryChangesW in this case, since that is already relative to the watched directory, similar to how other branches handle it. Also update the test to try testing under %TEMP% if accessible to increase the chance of it reproducing in the CI.
1 parent f6b7133 commit e640dc9

2 files changed

Lines changed: 116 additions & 27 deletions

File tree

‎src/win/fs-event.c‎

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,17 @@ static void uv__fs_event_queue_readdirchanges(uv_loop_t* loop,
6363
handle->req_pending=1;
6464
}
6565

66-
staticvoiduv__relative_path(constWCHAR*filename,
67-
constWCHAR*dir,
68-
WCHAR**relpath) {
66+
/* Compute the path of `filename` relative to the watched directory `dir`.
67+
* Returns 0 on success, -1 if `filename` is not actually prefixed by `dir`,
68+
* which can happen if the directory is a short path. */
69+
staticintuv__relative_path(constWCHAR*filename,
70+
constWCHAR*dir,
71+
WCHAR**relpath) {
6972
size_trelpathlen;
7073
size_tfilenamelen=wcslen(filename);
7174
size_tdirlen=wcslen(dir);
72-
assert(!_wcsnicmp(filename, dir, dirlen));
75+
if (filenamelen <= dirlen||_wcsnicmp(filename, dir, dirlen) !=0)
76+
return-1;
7377
if (dirlen>0&&dir[dirlen-1] =='\\')
7478
dirlen--;
7579
relpathlen=filenamelen-dirlen-1;
@@ -78,6 +82,7 @@ static void uv__relative_path(const WCHAR* filename,
7882
uv_fatal_error(ERROR_OUTOFMEMORY, "uv__malloc");
7983
wcsncpy(*relpath, filename+dirlen+1, relpathlen);
8084
(*relpath)[relpathlen] =L'\0';
85+
return0;
8186
}
8287

8388
staticintuv__split_path(constWCHAR*filename, WCHAR**dir,
@@ -522,12 +527,21 @@ void uv__process_fs_event_req(uv_loop_t* loop, uv_req_t* req,
522527

523528
if (long_filenamew) {
524529
/* Get the file name out of the long path. */
525-
uv__relative_path(long_filenamew,
526-
handle->dirw,
527-
&filenamew);
528-
uv__free(long_filenamew);
529-
long_filenamew=filenamew;
530-
sizew=-1;
530+
if (uv__relative_path(long_filenamew,
531+
handle->dirw,
532+
&filenamew) ==0) {
533+
uv__free(long_filenamew);
534+
long_filenamew=filenamew;
535+
sizew=-1;
536+
} else {
537+
/* The resolved long path was not prefixed by the watched
538+
* directory (e.g. short name vs long name mismatch),
539+
* fall back to the name given by ReadDirectoryChangesW. */
540+
uv__free(long_filenamew);
541+
long_filenamew=NULL;
542+
filenamew=file_info->FileName;
543+
sizew=file_info->FileNameLength / sizeof(WCHAR);
544+
}
531545
} else {
532546
/* We couldn't get the long filename, use the one reported. */
533547
filenamew=file_info->FileName;

‎test/test-fs-event.c‎

Lines changed: 92 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -632,44 +632,119 @@ TEST_IMPL(fs_event_watch_dir_recursive) {
632632
}
633633

634634
#ifdef_WIN32
635+
staticcharshort_path_file[MAX_PATH];
636+
637+
staticvoidshort_path_timer_cb(uv_timer_t*handle) {
638+
++timer_cb_called;
639+
touch_file(short_path_file);
640+
}
641+
642+
/* Try to create a unique watch directory that has a 8.3 short component
643+
under `parent` ("" means the cwd). If it's successful, fills `watch_dir`
644+
and `short_dir` with the long and short forms of the created directory
645+
respectively, and returns 1. Otherwise removes the directory created
646+
and returns 0. */
647+
staticintshort_path_make(constchar*parent,
648+
char*watch_dir, size_twatch_n,
649+
char*short_dir, size_tshort_n) {
650+
uv_fs_treq;
651+
chartmpl[MAX_PATH];
652+
WCHARwatch_dirw[MAX_PATH];
653+
WCHARshort_dirw[MAX_PATH];
654+
WCHARlong_dirw[MAX_PATH];
655+
size_tpathlen;
656+
intr;
657+
658+
if (parent[0] !='\0')
659+
r=snprintf(tmpl, sizeof(tmpl), "%s\\watch_dirXXXXXX", parent);
660+
else
661+
r=snprintf(tmpl, sizeof(tmpl), "watch_dirXXXXXX");
662+
if (r<0|| (size_t) r >= sizeof(tmpl))
663+
return0;
664+
665+
r=uv_fs_mkdtemp(NULL, &req, tmpl, NULL);
666+
if (r!=0) {
667+
uv_fs_req_cleanup(&req);
668+
return0;
669+
}
670+
671+
/* Copy the created path out before cleaning up the request that owns it. */
672+
pathlen=strlen(req.path);
673+
memcpy(watch_dir, req.path, pathlen+1);
674+
uv_fs_req_cleanup(&req);
675+
676+
/* The caller appends "\file1" to both watch_dir and short_dir. If there is
677+
no room for that suffix, skip this location. */
678+
if (pathlen+sizeof("\\file1") <= watch_n&&
679+
MultiByteToWideChar(CP_UTF8, 0, watch_dir, -1,
680+
watch_dirw, ARRAY_SIZE(watch_dirw)) !=0&&
681+
GetShortPathNameW(watch_dirw, short_dirw, ARRAY_SIZE(short_dirw)) !=0&&
682+
GetLongPathNameW(watch_dirw, long_dirw, ARRAY_SIZE(long_dirw)) !=0&&
683+
_wcsicmp(short_dirw, long_dirw) !=0&&
684+
WideCharToMultiByte(CP_UTF8, 0, short_dirw, -1,
685+
short_dir, (int) short_n, NULL, NULL) !=0)
686+
return1;
687+
688+
uv_fs_rmdir(NULL, &req, watch_dir, NULL);
689+
uv_fs_req_cleanup(&req);
690+
return0;
691+
}
692+
635693
TEST_IMPL(fs_event_watch_dir_short_path) {
636694
uv_loop_t*loop;
637-
uv_fs_treq;
695+
chartemp_path[MAX_PATH];
696+
charwatch_dir[MAX_PATH];
697+
charwatch_file[MAX_PATH];
698+
charshort_dir[MAX_PATH];
699+
size_ttemp_len;
638700
inthas_shortnames;
639701
intr;
640702

641-
/* Setup */
642703
loop=uv_default_loop();
643-
delete_file("watch_dir/file1");
644-
delete_dir("watch_dir/");
645-
create_dir("watch_dir");
646-
create_file("watch_dir/file1");
647704

648-
/* Newer version of Windows ship with
649-
HKLM\SYSTEM\CurrentControlSet\Control\FileSystem\NtfsDisable8dot3NameCreation
650-
not equal to 0. So we verify the files we created are addressable by a 8.3
651-
short name */
652-
has_shortnames=uv_fs_stat(NULL, &req, "watch_~1", NULL) !=UV_ENOENT;
705+
/* This test needs the watched directory to have an 8.3 short component. The
706+
generated "watch_dirXXXXXX" name is > 8 chars, so it gets a short alias on
707+
volumes where 8.3 name creation is enabled. For non-system volumes on
708+
newer Windows it's disabled by default (NtfsDisable8dot3NameCreation=3).
709+
The temp dir and the cwd may be on different volumes, so try each and use
710+
whichever has a short alias, and skip if neither does. */
711+
has_shortnames=0;
712+
temp_len=sizeof(temp_path);
713+
if (uv_os_tmpdir(temp_path, &temp_len) ==0)
714+
has_shortnames=short_path_make(temp_path,
715+
watch_dir, sizeof(watch_dir),
716+
short_dir, sizeof(short_dir));
717+
if (!has_shortnames)
718+
has_shortnames=short_path_make("",
719+
watch_dir, sizeof(watch_dir),
720+
short_dir, sizeof(short_dir));
721+
653722
if (has_shortnames) {
723+
snprintf(watch_file, sizeof(watch_file), "%s\\file1", watch_dir);
724+
/* short_path_file is used in the timer callback to touch the file. */
725+
snprintf(short_path_file, sizeof(short_path_file), "%s\\file1", short_dir);
726+
/* The directory was just created, so file1 cannot exist yet. */
727+
create_file(watch_file);
728+
654729
r=uv_fs_event_init(loop, &fs_event);
655730
ASSERT_OK(r);
656-
r=uv_fs_event_start(&fs_event, fs_event_cb_dir, "watch_~1", 0);
731+
r=uv_fs_event_start(&fs_event, fs_event_cb_dir, short_dir, 0);
657732
ASSERT_OK(r);
658733
r=uv_timer_init(loop, &timer);
659734
ASSERT_OK(r);
660-
r=uv_timer_start(&timer, timer_cb_file, 100, 0);
735+
r=uv_timer_start(&timer, short_path_timer_cb, 100, 0);
661736
ASSERT_OK(r);
662737

663738
uv_run(loop, UV_RUN_DEFAULT);
664739

665740
ASSERT_EQ(1, fs_event_cb_called);
666741
ASSERT_EQ(1, timer_cb_called);
667742
ASSERT_EQ(1, close_cb_called);
668-
}
669743

670-
/* Cleanup */
671-
delete_file("watch_dir/file1");
672-
delete_dir("watch_dir/");
744+
/* Cleanup */
745+
delete_file(watch_file);
746+
delete_dir(watch_dir);
747+
}
673748

674749
MAKE_VALGRIND_HAPPY(loop);
675750

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Commit e640dc9

Browse files
authored
win: handle short path mismatch with a fallback in fs events (#5152)
uv_fs_event_start() stores the watched directory path verbatim in handle->dirw. When an event arrives, the child path is resolved to its long form with GetLongPathNameW() and uv__relative_path() strips the handle->dirw prefix off the result. Previously if the directory was supplied as an 8.3 short path, the long form no longer shares that prefix, so the prefix check in uv__relative_path() fails, which either fires an assertion in builds without NDEBUG or produces a wrong(potentially out-of-bounds) result otherwise. This patch falls back to the name reported by ReadDirectoryChangesW in this case, since that is already relative to the watched directory, similar to how other branches handle it. Also update the test to try testing under %TEMP% if accessible to increase the chance of it reproducing in the CI.
1 parent f6b7133 commit e640dc9

2 files changed

Lines changed: 116 additions & 27 deletions

File tree

‎src/win/fs-event.c‎

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,17 @@ static void uv__fs_event_queue_readdirchanges(uv_loop_t* loop,
6363
handle->req_pending=1;
6464
}
6565

66-
staticvoiduv__relative_path(constWCHAR*filename,
67-
constWCHAR*dir,
68-
WCHAR**relpath) {
66+
/* Compute the path of `filename` relative to the watched directory `dir`.
67+
* Returns 0 on success, -1 if `filename` is not actually prefixed by `dir`,
68+
* which can happen if the directory is a short path. */
69+
staticintuv__relative_path(constWCHAR*filename,
70+
constWCHAR*dir,
71+
WCHAR**relpath) {
6972
size_trelpathlen;
7073
size_tfilenamelen=wcslen(filename);
7174
size_tdirlen=wcslen(dir);
72-
assert(!_wcsnicmp(filename, dir, dirlen));
75+
if (filenamelen <= dirlen||_wcsnicmp(filename, dir, dirlen) !=0)
76+
return-1;
7377
if (dirlen>0&&dir[dirlen-1] =='\\')
7478
dirlen--;
7579
relpathlen=filenamelen-dirlen-1;
@@ -78,6 +82,7 @@ static void uv__relative_path(const WCHAR* filename,
7882
uv_fatal_error(ERROR_OUTOFMEMORY, "uv__malloc");
7983
wcsncpy(*relpath, filename+dirlen+1, relpathlen);
8084
(*relpath)[relpathlen] =L'\0';
85+
return0;
8186
}
8287

8388
staticintuv__split_path(constWCHAR*filename, WCHAR**dir,
@@ -522,12 +527,21 @@ void uv__process_fs_event_req(uv_loop_t* loop, uv_req_t* req,
522527

523528
if (long_filenamew) {
524529
/* Get the file name out of the long path. */
525-
uv__relative_path(long_filenamew,
526-
handle->dirw,
527-
&filenamew);
528-
uv__free(long_filenamew);
529-
long_filenamew=filenamew;
530-
sizew=-1;
530+
if (uv__relative_path(long_filenamew,
531+
handle->dirw,
532+
&filenamew) ==0) {
533+
uv__free(long_filenamew);
534+
long_filenamew=filenamew;
535+
sizew=-1;
536+
} else {
537+
/* The resolved long path was not prefixed by the watched
538+
* directory (e.g. short name vs long name mismatch),
539+
* fall back to the name given by ReadDirectoryChangesW. */
540+
uv__free(long_filenamew);
541+
long_filenamew=NULL;
542+
filenamew=file_info->FileName;
543+
sizew=file_info->FileNameLength / sizeof(WCHAR);
544+
}
531545
} else {
532546
/* We couldn't get the long filename, use the one reported. */
533547
filenamew=file_info->FileName;

‎test/test-fs-event.c‎

Lines changed: 92 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -632,44 +632,119 @@ TEST_IMPL(fs_event_watch_dir_recursive) {
632632
}
633633

634634
#ifdef_WIN32
635+
staticcharshort_path_file[MAX_PATH];
636+
637+
staticvoidshort_path_timer_cb(uv_timer_t*handle) {
638+
++timer_cb_called;
639+
touch_file(short_path_file);
640+
}
641+
642+
/* Try to create a unique watch directory that has a 8.3 short component
643+
under `parent` ("" means the cwd). If it's successful, fills `watch_dir`
644+
and `short_dir` with the long and short forms of the created directory
645+
respectively, and returns 1. Otherwise removes the directory created
646+
and returns 0. */
647+
staticintshort_path_make(constchar*parent,
648+
char*watch_dir, size_twatch_n,
649+
char*short_dir, size_tshort_n) {
650+
uv_fs_treq;
651+
chartmpl[MAX_PATH];
652+
WCHARwatch_dirw[MAX_PATH];
653+
WCHARshort_dirw[MAX_PATH];
654+
WCHARlong_dirw[MAX_PATH];
655+
size_tpathlen;
656+
intr;
657+
658+
if (parent[0] !='\0')
659+
r=snprintf(tmpl, sizeof(tmpl), "%s\\watch_dirXXXXXX", parent);
660+
else
661+
r=snprintf(tmpl, sizeof(tmpl), "watch_dirXXXXXX");
662+
if (r<0|| (size_t) r >= sizeof(tmpl))
663+
return0;
664+
665+
r=uv_fs_mkdtemp(NULL, &req, tmpl, NULL);
666+
if (r!=0) {
667+
uv_fs_req_cleanup(&req);
668+
return0;
669+
}
670+
671+
/* Copy the created path out before cleaning up the request that owns it. */
672+
pathlen=strlen(req.path);
673+
memcpy(watch_dir, req.path, pathlen+1);
674+
uv_fs_req_cleanup(&req);
675+
676+
/* The caller appends "\file1" to both watch_dir and short_dir. If there is
677+
no room for that suffix, skip this location. */
678+
if (pathlen+sizeof("\\file1") <= watch_n&&
679+
MultiByteToWideChar(CP_UTF8, 0, watch_dir, -1,
680+
watch_dirw, ARRAY_SIZE(watch_dirw)) !=0&&
681+
GetShortPathNameW(watch_dirw, short_dirw, ARRAY_SIZE(short_dirw)) !=0&&
682+
GetLongPathNameW(watch_dirw, long_dirw, ARRAY_SIZE(long_dirw)) !=0&&
683+
_wcsicmp(short_dirw, long_dirw) !=0&&
684+
WideCharToMultiByte(CP_UTF8, 0, short_dirw, -1,
685+
short_dir, (int) short_n, NULL, NULL) !=0)
686+
return1;
687+
688+
uv_fs_rmdir(NULL, &req, watch_dir, NULL);
689+
uv_fs_req_cleanup(&req);
690+
return0;
691+
}
692+
635693
TEST_IMPL(fs_event_watch_dir_short_path) {
636694
uv_loop_t*loop;
637-
uv_fs_treq;
695+
chartemp_path[MAX_PATH];
696+
charwatch_dir[MAX_PATH];
697+
charwatch_file[MAX_PATH];
698+
charshort_dir[MAX_PATH];
699+
size_ttemp_len;
638700
inthas_shortnames;
639701
intr;
640702

641-
/* Setup */
642703
loop=uv_default_loop();
643-
delete_file("watch_dir/file1");
644-
delete_dir("watch_dir/");
645-
create_dir("watch_dir");
646-
create_file("watch_dir/file1");
647704

648-
/* Newer version of Windows ship with
649-
HKLM\SYSTEM\CurrentControlSet\Control\FileSystem\NtfsDisable8dot3NameCreation
650-
not equal to 0. So we verify the files we created are addressable by a 8.3
651-
short name */
652-
has_shortnames=uv_fs_stat(NULL, &req, "watch_~1", NULL) !=UV_ENOENT;
705+
/* This test needs the watched directory to have an 8.3 short component. The
706+
generated "watch_dirXXXXXX" name is > 8 chars, so it gets a short alias on
707+
volumes where 8.3 name creation is enabled. For non-system volumes on
708+
newer Windows it's disabled by default (NtfsDisable8dot3NameCreation=3).
709+
The temp dir and the cwd may be on different volumes, so try each and use
710+
whichever has a short alias, and skip if neither does. */
711+
has_shortnames=0;
712+
temp_len=sizeof(temp_path);
713+
if (uv_os_tmpdir(temp_path, &temp_len) ==0)
714+
has_shortnames=short_path_make(temp_path,
715+
watch_dir, sizeof(watch_dir),
716+
short_dir, sizeof(short_dir));
717+
if (!has_shortnames)
718+
has_shortnames=short_path_make("",
719+
watch_dir, sizeof(watch_dir),
720+
short_dir, sizeof(short_dir));
721+
653722
if (has_shortnames) {
723+
snprintf(watch_file, sizeof(watch_file), "%s\\file1", watch_dir);
724+
/* short_path_file is used in the timer callback to touch the file. */
725+
snprintf(short_path_file, sizeof(short_path_file), "%s\\file1", short_dir);
726+
/* The directory was just created, so file1 cannot exist yet. */
727+
create_file(watch_file);
728+
654729
r=uv_fs_event_init(loop, &fs_event);
655730
ASSERT_OK(r);
656-
r=uv_fs_event_start(&fs_event, fs_event_cb_dir, "watch_~1", 0);
731+
r=uv_fs_event_start(&fs_event, fs_event_cb_dir, short_dir, 0);
657732
ASSERT_OK(r);
658733
r=uv_timer_init(loop, &timer);
659734
ASSERT_OK(r);
660-
r=uv_timer_start(&timer, timer_cb_file, 100, 0);
735+
r=uv_timer_start(&timer, short_path_timer_cb, 100, 0);
661736
ASSERT_OK(r);
662737

663738
uv_run(loop, UV_RUN_DEFAULT);
664739

665740
ASSERT_EQ(1, fs_event_cb_called);
666741
ASSERT_EQ(1, timer_cb_called);
667742
ASSERT_EQ(1, close_cb_called);
668-
}
669743

670-
/* Cleanup */
671-
delete_file("watch_dir/file1");
672-
delete_dir("watch_dir/");
744+
/* Cleanup */
745+
delete_file(watch_file);
746+
delete_dir(watch_dir);
747+
}
673748

674749
MAKE_VALGRIND_HAPPY(loop);
675750

0 commit comments

Comments
 (0)