2 * PROJECT: ReactOS Kernel
3 * LICENSE: GPL - See COPYING in the top level directory
4 * FILE: ntoskrnl/fsrtl/name.c
5 * PURPOSE: Provides name parsing and other support routines for FSDs
6 * PROGRAMMERS: Alex Ionescu (alex.ionescu@reactos.org)
7 * Filip Navara (navaraf@reactos.org)
8 * Pierre Schweitzer (pierre.schweitzer@reactos.org)
11 /* INCLUDES ******************************************************************/
17 /* PRIVATE FUNCTIONS *********************************************************/
20 FsRtlIsNameInExpressionPrivate(IN PUNICODE_STRING Expression
,
21 IN PUNICODE_STRING Name
,
22 IN BOOLEAN IgnoreCase
,
23 IN PWCHAR UpcaseTable OPTIONAL
)
25 ULONG i
= 0, j
, k
= 0;
28 ASSERT(!IgnoreCase
|| UpcaseTable
);
30 while (i
< Name
->Length
/ sizeof(WCHAR
) && k
< Expression
->Length
/ sizeof(WCHAR
))
32 if ((Expression
->Buffer
[k
] == (IgnoreCase
? UpcaseTable
[Name
->Buffer
[i
]] : Name
->Buffer
[i
])) ||
33 (Expression
->Buffer
[k
] == L
'?') || (Expression
->Buffer
[k
] == DOS_QM
) ||
34 (Expression
->Buffer
[k
] == DOS_DOT
&& (Name
->Buffer
[i
] == L
'.' || Name
->Buffer
[i
] == L
'0')))
39 else if (Expression
->Buffer
[k
] == L
'*')
41 if (k
< (Expression
->Length
/ sizeof(WCHAR
) - 1))
43 if (Expression
->Buffer
[k
+1] != L
'*' && Expression
->Buffer
[k
+1] != L
'?' &&
44 Expression
->Buffer
[k
+1] != DOS_DOT
&& Expression
->Buffer
[k
+1] != DOS_QM
&&
45 Expression
->Buffer
[k
+1] != DOS_STAR
)
47 while ((IgnoreCase
? UpcaseTable
[Name
->Buffer
[i
]] : Name
->Buffer
[i
]) != Expression
->Buffer
[k
+1] &&
48 i
< Name
->Length
/ sizeof(WCHAR
)) i
++;
52 if (!(Expression
->Buffer
[k
+1] != DOS_DOT
&& (Name
->Buffer
[i
] == L
'.' || Name
->Buffer
[i
] == L
'0')))
60 i
= Name
->Length
/ sizeof(WCHAR
);
64 else if (Expression
->Buffer
[k
] == DOS_STAR
)
67 while (j
< Name
->Length
/ sizeof(WCHAR
))
69 if (Name
->Buffer
[j
] == L
'.')
79 i
= Name
->Length
/ sizeof(WCHAR
);
83 return (k
== Expression
->Length
/ sizeof(WCHAR
) && i
== Name
->Length
/ sizeof(WCHAR
));
86 /* PUBLIC FUNCTIONS **********************************************************/
89 * @name FsRtlAreNamesEqual
92 * Compare two strings to check if they match
95 * First unicode string to compare
98 * Second unicode string to compare
101 * If TRUE, Case will be ignored when comparing strings
104 * Table for upcase letters. If NULL is given, system one will be used
106 * @return TRUE if the strings are equal
108 * @remarks From Bo Branten's ntifs.h v25.
113 FsRtlAreNamesEqual(IN PCUNICODE_STRING Name1
,
114 IN PCUNICODE_STRING Name2
,
115 IN BOOLEAN IgnoreCase
,
116 IN PCWCH UpcaseTable OPTIONAL
)
118 UNICODE_STRING UpcaseName1
;
119 UNICODE_STRING UpcaseName2
;
120 BOOLEAN StringsAreEqual
, MemoryAllocated
= FALSE
;
125 /* Well, first check their size */
126 if (Name1
->Length
!= Name2
->Length
) return FALSE
;
128 /* Check if the caller didn't give an upcase table */
129 if ((IgnoreCase
) && !(UpcaseTable
))
131 /* Upcase the string ourselves */
132 Status
= RtlUpcaseUnicodeString(&UpcaseName1
, Name1
, TRUE
);
133 if (!NT_SUCCESS(Status
)) RtlRaiseStatus(Status
);
135 /* Upcase the second string too */
136 RtlUpcaseUnicodeString(&UpcaseName2
, Name2
, TRUE
);
137 Name1
= &UpcaseName1
;
138 Name2
= &UpcaseName2
;
140 /* Make sure we go through the path below, but free the strings */
142 MemoryAllocated
= TRUE
;
145 /* Do a case-sensitive search */
148 /* Use a raw memory compare */
149 StringsAreEqual
= RtlEqualMemory(Name1
->Buffer
,
153 /* Check if we allocated strings */
157 RtlFreeUnicodeString(&UpcaseName1
);
158 RtlFreeUnicodeString(&UpcaseName2
);
161 /* Return the equality */
162 return StringsAreEqual
;
166 /* Case in-sensitive search */
167 for (i
= 0; i
< Name1
->Length
/ sizeof(WCHAR
); i
++)
169 /* Check if the character matches */
170 if (UpcaseTable
[Name1
->Buffer
[i
]] != UpcaseTable
[Name2
->Buffer
[i
]])
172 /* Non-match found! */
177 /* We finished the loop so we are equal */
183 * @name FsRtlDissectName
186 * Dissects a given path name into first and remaining part.
189 * Unicode string to dissect.
192 * Pointer to user supplied UNICODE_STRING, that will later point
193 * to the first part of the original name.
195 * @param RemainingPart
196 * Pointer to user supplied UNICODE_STRING, that will later point
197 * to the remaining part of the original name.
202 * Name: \test1\test2\test3
204 * RemainingPart: test2\test3
209 FsRtlDissectName(IN UNICODE_STRING Name
,
210 OUT PUNICODE_STRING FirstPart
,
211 OUT PUNICODE_STRING RemainingPart
)
213 ULONG FirstPosition
, i
;
214 ULONG SkipFirstSlash
= 0;
217 /* Zero the strings before continuing */
218 RtlZeroMemory(FirstPart
, sizeof(UNICODE_STRING
));
219 RtlZeroMemory(RemainingPart
, sizeof(UNICODE_STRING
));
221 /* Just quit if the string is empty */
222 if (!Name
.Length
) return;
224 /* Find first backslash */
225 FirstPosition
= Name
.Length
/ sizeof(WCHAR
) ;
226 for (i
= 0; i
< Name
.Length
/ sizeof(WCHAR
); i
++)
228 /* If we found one... */
229 if (Name
.Buffer
[i
] == L
'\\')
231 /* If it begins string, just notice it and continue */
238 /* Else, save its position and break out of the loop */
245 /* Set up the first result string */
246 FirstPart
->Buffer
= Name
.Buffer
+ SkipFirstSlash
;
247 FirstPart
->Length
= (FirstPosition
- SkipFirstSlash
) * sizeof(WCHAR
);
248 FirstPart
->MaximumLength
= FirstPart
->Length
;
250 /* And second one, if necessary */
251 if (FirstPosition
< (Name
.Length
/ sizeof(WCHAR
)))
253 RemainingPart
->Buffer
= Name
.Buffer
+ FirstPosition
+ 1;
254 RemainingPart
->Length
= Name
.Length
- (FirstPosition
+ 1) * sizeof(WCHAR
);
255 RemainingPart
->MaximumLength
= RemainingPart
->Length
;
260 * @name FsRtlDoesNameContainWildCards
263 * Checks if the given string contains WildCards
266 * Pointer to a UNICODE_STRING containing Name to examine
268 * @return TRUE if Name contains wildcards, FALSE otherwise
270 * @remarks From Bo Branten's ntifs.h v12.
275 FsRtlDoesNameContainWildCards(IN PUNICODE_STRING Name
)
280 /* Loop through every character */
283 Ptr
= Name
->Buffer
+ (Name
->Length
/ sizeof(WCHAR
)) - 1;
284 while ((Ptr
>= Name
->Buffer
) && (*Ptr
!= L
'\\'))
286 /* Check for Wildcard */
287 if (FsRtlIsUnicodeCharacterWild(*Ptr
)) return TRUE
;
297 * @name FsRtlIsNameInExpression
300 * Check if the Name string is in the Expression string.
303 * The string in which we've to find Name. It can contain wildcards.
304 * If IgnoreCase is set to TRUE, this string MUST BE uppercase.
307 * The string to find. It cannot contain wildcards
310 * If set to TRUE, case will be ignore with upcasing both strings
313 * If not NULL, and if IgnoreCase is set to TRUE, it will be used to
314 * upcase the both strings
316 * @return TRUE if Name is in Expression, FALSE otherwise
318 * @remarks From Bo Branten's ntifs.h v12. This function should be
319 * rewritten to avoid recursion and better wildcard handling
320 * should be implemented (see FsRtlDoesNameContainWildCards).
325 FsRtlIsNameInExpression(IN PUNICODE_STRING Expression
,
326 IN PUNICODE_STRING Name
,
327 IN BOOLEAN IgnoreCase
,
328 IN PWCHAR UpcaseTable OPTIONAL
)
332 UNICODE_STRING IntName
;
334 if (IgnoreCase
&& !UpcaseTable
)
336 Status
= RtlUpcaseUnicodeString(&IntName
, Name
, TRUE
);
337 if (Status
!= STATUS_SUCCESS
)
339 ExRaiseStatus(Status
);
346 IntName
.Buffer
= NULL
;
349 Result
= FsRtlIsNameInExpressionPrivate(Expression
, Name
, IgnoreCase
, UpcaseTable
);
351 if (IntName
.Buffer
!= NULL
)
353 RtlFreeUnicodeString(&IntName
);