2 * PROJECT: ReactOS Kernel
3 * LICENSE: GPL - See COPYING in the top level directory
4 * FILE: ntoskrnl/fsrtl/name.c
5 * PURPOSE: Provides DBCS parsing and other support routines for FSDs
6 * PROGRAMMERS: Alex Ionescu (alex.ionescu@reactos.org)
7 * Pierre Schweitzer (pierre.schweitzer@reactos.org)
10 /* INCLUDES ******************************************************************/
16 /* PUBLIC FUNCTIONS **********************************************************/
19 * @name FsRtlDissectDbcs
22 * Dissects a given path name into first and remaining part.
25 * ANSI string to dissect.
28 * Pointer to user supplied ANSI_STRING, that will later point
29 * to the first part of the original name.
31 * @param RemainingPart
32 * Pointer to user supplied ANSI_STRING, that will later point
33 * to the remaining part of the original name.
38 * Name: \test1\test2\test3
40 * RemainingPart: test2\test3
45 FsRtlDissectDbcs(IN ANSI_STRING Name
,
46 OUT PANSI_STRING FirstPart
,
47 OUT PANSI_STRING RemainingPart
)
49 ULONG FirstPosition
, i
;
50 ULONG SkipFirstSlash
= 0;
53 /* Zero the strings before continuing */
54 RtlZeroMemory(FirstPart
, sizeof(ANSI_STRING
));
55 RtlZeroMemory(RemainingPart
, sizeof(ANSI_STRING
));
57 /* Just quit if the string is empty */
58 if (!Name
.Length
) return;
60 /* Find first backslash */
61 FirstPosition
= Name
.Length
;
62 for (i
= 0; i
< Name
.Length
; i
++)
64 /* First make sure the character it's not the Lead DBCS */
65 if (FsRtlIsLeadDbcsCharacter(Name
.Buffer
[i
]))
69 /* If we found one... */
70 else if (Name
.Buffer
[i
] == '\\')
72 /* If it begins string, just notice it and continue */
79 /* Else, save its position and break out of the loop */
86 /* Set up the first result string */
87 FirstPart
->Buffer
= Name
.Buffer
+ SkipFirstSlash
;
88 FirstPart
->Length
= (FirstPosition
- SkipFirstSlash
);
89 FirstPart
->MaximumLength
= FirstPart
->Length
;
91 /* And second one, if necessary */
92 if (FirstPosition
< (Name
.Length
))
94 RemainingPart
->Buffer
= Name
.Buffer
+ FirstPosition
+ 1;
95 RemainingPart
->Length
= Name
.Length
- (FirstPosition
+ 1);
96 RemainingPart
->MaximumLength
= RemainingPart
->Length
;
101 * @name FsRtlDoesDbcsContainWildCards
104 * Returns TRUE if the given DbcsName contains wildcards such as *, ?,
105 * ANSI_DOS_STAR, ANSI_DOS_DOT, and ANSI_DOS_QM
110 * @return TRUE if there are wildcards, FALSE otherwise
117 FsRtlDoesDbcsContainWildCards(IN PANSI_STRING Name
)
122 /* Check every character */
123 for (i
= 0; i
< Name
->Length
; i
++)
125 /* First make sure it's not the Lead DBCS */
126 if (FsRtlIsLeadDbcsCharacter(Name
->Buffer
[i
]))
130 else if (FsRtlIsAnsiCharacterWild(Name
->Buffer
[i
]))
132 /* Now return if it has a wildcard */
137 /* We didn't return above...so none found */
142 * @name FsRtlIsDbcsInExpression
145 * Check if the Name string is in the Expression string.
148 * The string in which we've to find Name. It can contains wildcards
151 * The string to find. It cannot contain wildcards.
153 * @return TRUE if Name is found in Expression, FALSE otherwise
160 FsRtlIsDbcsInExpression(IN PANSI_STRING Expression
,
161 IN PANSI_STRING Name
)
163 ULONG ExpressionPosition
, NamePosition
, MatchingChars
= 0;
166 ASSERT(Name
->Length
);
167 ASSERT(Expression
->Length
);
168 ASSERT(!FsRtlDoesDbcsContainWildCards(Name
));
170 /* One can't be null, both can be */
171 if (!Expression
->Length
|| !Name
->Length
)
173 return !(Expression
->Length
^ Name
->Length
);
176 for (ExpressionPosition
= 0; ExpressionPosition
< Expression
->Length
; ExpressionPosition
++)
178 if ((Expression
->Buffer
[ExpressionPosition
] == Name
->Buffer
[MatchingChars
]) ||
179 (Expression
->Buffer
[ExpressionPosition
] == '?') ||
180 (Expression
->Buffer
[ExpressionPosition
] == ANSI_DOS_QM
) ||
181 (Expression
->Buffer
[ExpressionPosition
] == ANSI_DOS_DOT
&&
182 (Name
->Buffer
[MatchingChars
] == '.' || Name
->Buffer
[MatchingChars
] == '0')))
186 else if (Expression
->Buffer
[ExpressionPosition
] == '*')
188 MatchingChars
= Name
->Length
;
190 else if (Expression
->Buffer
[ExpressionPosition
] == ANSI_DOS_STAR
)
192 for (NamePosition
= MatchingChars
; NamePosition
< Name
->Length
; NamePosition
++)
194 if (Name
->Buffer
[NamePosition
] == '.')
196 MatchingChars
= NamePosition
;
205 if (MatchingChars
== Name
->Length
)
215 * @name FsRtlIsFatDbcsLegal
218 * Returns TRUE if the given DbcsName is a valid FAT filename (in 8.3)
221 * The filename to check. It can also contains pathname.
223 * @param WildCardsPermissible
224 * If this is set to FALSE and if filename contains wildcard, the function
227 * @param PathNamePermissible
228 * If this is set to FALSE and if the filename comes with a pathname, the
231 * @param LeadingBackslashPermissible
232 * If this is set to FALSE and if the filename starts with a backslash, the
235 * @return TRUE if the DbcsName is legal, FALSE otherwise
242 FsRtlIsFatDbcsLegal(IN ANSI_STRING DbcsName
,
243 IN BOOLEAN WildCardsPermissible
,
244 IN BOOLEAN PathNamePermissible
,
245 IN BOOLEAN LeadingBackslashPermissible
)
247 ANSI_STRING FirstPart
, RemainingPart
, Name
;
252 /* Just quit if the string is empty */
253 if (!DbcsName
.Length
)
256 /* DbcsName wasn't supposed to be started with \ */
257 if (!LeadingBackslashPermissible
&& DbcsName
.Buffer
[0] == '\\')
259 /* DbcsName was allowed to be started with \, but now, remove it */
260 else if (LeadingBackslashPermissible
&& DbcsName
.Buffer
[0] == '\\')
262 DbcsName
.Buffer
= DbcsName
.Buffer
+ 1;
263 DbcsName
.Length
= DbcsName
.Length
- 1;
264 DbcsName
.MaximumLength
= DbcsName
.MaximumLength
- 1;
267 /* Extract first part of the DbcsName to work on */
268 FsRtlDissectDbcs(DbcsName
, &FirstPart
, &RemainingPart
);
269 while (FirstPart
.Length
> 0)
271 /* Reset dots count */
274 /* Accept special filename if wildcards are allowed */
275 if (WildCardsPermissible
&& (FirstPart
.Length
== 1 || FirstPart
.Length
== 2) && FirstPart
.Buffer
[0] == '.')
277 if (FirstPart
.Length
== 2)
279 if (FirstPart
.Buffer
[1] == '.')
290 /* Filename must be 8.3 filename */
291 if (FirstPart
.Length
< 3 || FirstPart
.Length
> 12)
294 /* Now, we will parse the filename to find everything bad in */
295 for (i
= 0; i
< FirstPart
.Length
; i
++)
297 /* First make sure the character it's not the Lead DBCS */
298 if (FsRtlIsLeadDbcsCharacter(FirstPart
.Buffer
[i
]))
300 if (i
== (FirstPart
.Length
) - 1)
304 /* Then check for bad characters */
305 else if (!FsRtlIsAnsiCharacterLegalFat(FirstPart
.Buffer
[i
], WildCardsPermissible
))
309 else if (FirstPart
.Buffer
[i
] == '.')
311 /* Filename can only contain one dot */
317 /* We mustn't have spaces before dot or at the end of the filename
318 * and no dot at the beginning of the filename */
319 if ((i
== (FirstPart
.Length
) - 1) || i
== 0)
323 if (FirstPart
.Buffer
[i
- 1] == ' ')
326 /* Filename must be 8.3 filename and not 3.8 filename */
327 if ((FirstPart
.Length
- 1) - i
> 3)
332 /* Filename mustn't finish with a space */
333 if (FirstPart
.Buffer
[FirstPart
.Length
- 1] == ' ')
337 /* Preparing next loop */
338 Name
.Buffer
= RemainingPart
.Buffer
;
339 Name
.Length
= RemainingPart
.Length
;
340 Name
.MaximumLength
= RemainingPart
.MaximumLength
;
342 /* Call once again our dissect function */
343 FsRtlDissectDbcs(Name
, &FirstPart
, &RemainingPart
);
345 /* We found a pathname, it wasn't allowed */
346 if (FirstPart
.Length
> 0 && !PathNamePermissible
)
353 * @name FsRtlIsHpfsDbcsLegal
356 * Returns TRUE if the given DbcsName is a valid HPFS filename
359 * The filename to check. It can also contains pathname.
361 * @param WildCardsPermissible
362 * If this is set to FALSE and if filename contains wildcard, the function
365 * @param PathNamePermissible
366 * If this is set to FALSE and if the filename comes with a pathname, the
369 * @param LeadingBackslashPermissible
370 * If this is set to FALSE and if the filename starts with a backslash, the
373 * @return TRUE if the DbcsName is legal, FALSE otherwise
380 FsRtlIsHpfsDbcsLegal(IN ANSI_STRING DbcsName
,
381 IN BOOLEAN WildCardsPermissible
,
382 IN BOOLEAN PathNamePermissible
,
383 IN BOOLEAN LeadingBackslashPermissible
)
385 ANSI_STRING FirstPart
, RemainingPart
, Name
;
389 /* Just quit if the string is empty */
390 if (!DbcsName
.Length
)
393 /* DbcsName wasn't supposed to be started with \ */
394 if (!LeadingBackslashPermissible
&& DbcsName
.Buffer
[0] == '\\')
396 /* DbcsName was allowed to be started with \, but now, remove it */
397 else if (LeadingBackslashPermissible
&& DbcsName
.Buffer
[0] == '\\')
399 DbcsName
.Buffer
= DbcsName
.Buffer
+ 1;
400 DbcsName
.Length
= DbcsName
.Length
- 1;
401 DbcsName
.MaximumLength
= DbcsName
.MaximumLength
- 1;
404 /* Extract first part of the DbcsName to work on */
405 FsRtlDissectDbcs(DbcsName
, &FirstPart
, &RemainingPart
);
406 while (FirstPart
.Length
> 0)
408 /* Accept special filename if wildcards are allowed */
409 if (WildCardsPermissible
&& (FirstPart
.Length
== 1 || FirstPart
.Length
== 2) && FirstPart
.Buffer
[0] == '.')
411 if (FirstPart
.Length
== 2)
413 if (FirstPart
.Buffer
[1] == '.')
424 /* Filename must be 255 bytes maximum */
425 if (FirstPart
.Length
> 255)
428 /* Now, we will parse the filename to find everything bad in */
429 for (i
= 0; i
< FirstPart
.Length
; i
++)
431 /* First make sure the character it's not the Lead DBCS */
432 if (FsRtlIsLeadDbcsCharacter(FirstPart
.Buffer
[i
]))
434 if (i
== (FirstPart
.Length
) - 1)
438 /* Then check for bad characters */
439 else if (!!FsRtlIsAnsiCharacterLegalHpfs(FirstPart
.Buffer
[i
], WildCardsPermissible
))
445 /* Filename mustn't finish with a space or a dot */
446 if ((FirstPart
.Buffer
[FirstPart
.Length
- 1] == ' ') ||
447 (FirstPart
.Buffer
[FirstPart
.Length
- 1] == '.'))
451 /* Preparing next loop */
452 Name
.Buffer
= RemainingPart
.Buffer
;
453 Name
.Length
= RemainingPart
.Length
;
454 Name
.MaximumLength
= RemainingPart
.MaximumLength
;
456 /* Call once again our dissect function */
457 FsRtlDissectDbcs(Name
, &FirstPart
, &RemainingPart
);
459 /* We found a pathname, it wasn't allowed */
460 if (FirstPart
.Length
> 0 && !PathNamePermissible
)