3 * - Open, Close and ChDir
12 #define OPEN_MOUNT_ROOT 1
13 #define MAX_PATH_SLASHES 256
14 #define MAX_NESTED_LINKS 4
15 #define MAX_PATH_LEN 255
18 extern tVFS_Node gVFS_MemRoot;
19 extern tVFS_Mount *gVFS_RootMount;
20 extern int VFS_AllocHandle(int bIsUser, tVFS_Node *Node, int Mode);
23 int VFS_int_CreateHandle( tVFS_Node *Node, int Mode );
27 * \fn char *VFS_GetAbsPath(const char *Path)
28 * \brief Create an absolute path from a relative one
30 char *VFS_GetAbsPath(const char *Path)
33 int pathLen = strlen(Path);
34 char *pathComps[MAX_PATH_SLASHES];
38 const char *chroot = CFGPTR(CFG_VFS_CHROOT);
40 const char *cwd = CFGPTR(CFG_VFS_CWD);
47 ret = malloc(strlen(Path)+1);
49 Log_Warning("VFS", "VFS_GetAbsPath: malloc() returned NULL");
58 if( chroot == NULL ) {
62 chrootLen = strlen(chroot);
65 // Check if the path is already absolute
67 ret = malloc(chrootLen + pathLen + 1);
69 Log_Warning("VFS", "VFS_GetAbsPath: malloc() returned NULL");
72 strcpy(ret + chrootLen, Path);
82 // Prepend the current directory
83 ret = malloc(chrootLen + cwdLen + 1 + pathLen + 1 );
84 strcpy(ret+chrootLen, cwd);
86 strcpy(ret+chrootLen+cwdLen+1, Path);
87 //Log("ret = '%s'", ret);
91 pathComps[iPos++] = tmpStr = ret+chrootLen+1;
96 pathComps[iPos++] = tmpStr;
97 if(iPos == MAX_PATH_SLASHES) {
98 LOG("Path '%s' has too many elements", Path);
105 pathComps[iPos] = NULL;
109 while(pathComps[iPos])
111 tmpStr = pathComps[iPos];
112 // Always Increment iPos
115 if(tmpStr[0] == '.' && tmpStr[1] == '.' && (tmpStr[2] == '/' || tmpStr[2] == '\0') )
122 if(tmpStr[0] == '.' && (tmpStr[1] == '/' || tmpStr[1] == '\0') )
127 if(tmpStr[0] == '/' || tmpStr[0] == '\0')
133 pathComps[iPos2] = tmpStr;
136 pathComps[iPos2] = NULL;
139 iPos2 = chrootLen + 1; iPos = 0;
141 while(pathComps[iPos])
143 tmpStr = pathComps[iPos];
144 while(*tmpStr && *tmpStr != '/')
146 ret[iPos2++] = *tmpStr;
157 // Prepend the chroot
158 memcpy( ret, chroot, chrootLen );
161 // Log_Debug("VFS", "VFS_GetAbsPath: RETURN '%s'", ret);
166 * \fn char *VFS_ParsePath(const char *Path, char **TruePath)
167 * \brief Parses a path, resolving sysmlinks and applying permissions
169 tVFS_Node *VFS_ParsePath(const char *Path, char **TruePath)
171 tVFS_Mount *mnt, *longestMount;
172 int cmp, retLength = 0;
174 int iNestedLinks = 0;
175 tVFS_Node *curNode, *tmpNode;
177 char path_buffer[MAX_PATH_LEN+1];
179 ENTER("sPath pTruePath", Path, TruePath);
184 *TruePath = malloc(strlen(Path)+1);
185 strcpy(*TruePath, Path);
187 curNode = gVFS_MemRoot.FindDir(&gVFS_MemRoot, Path);
193 // For root we always fast return
194 if(Path[0] == '/' && Path[1] == '\0') {
196 *TruePath = malloc( gVFS_RootMount->MountPointLen+1 );
197 strcpy(*TruePath, gVFS_RootMount->MountPoint);
199 LEAVE('p', gVFS_RootMount->RootNode);
200 return gVFS_RootMount->RootNode;
203 // Check if there is anything mounted
205 Log_Error("VFS", "VFS_ParsePath - No filesystems mounted");
210 longestMount = gVFS_RootMount;
211 for(mnt = gVFS_Mounts; mnt; mnt = mnt->Next)
214 if( Path[mnt->MountPointLen] != '/' && Path[mnt->MountPointLen] != '\0')
216 // Length Check - If the length is smaller than the longest match sofar
217 if(mnt->MountPointLen < longestMount->MountPointLen) continue;
219 cmp = strcmp(Path, mnt->MountPoint);
222 // Fast Break - Request Mount Root
225 *TruePath = malloc( mnt->MountPointLen+1 );
226 strcpy(*TruePath, mnt->MountPoint);
228 LEAVE('p', mnt->RootNode);
229 return mnt->RootNode;
232 // Not a match, continue
233 if(cmp != '/') continue;
237 // Save to shorter variable
240 LOG("mnt = {MountPoint:\"%s\"}", mnt->MountPoint);
245 // Assumes that the resultant path (here) will not be > strlen(Path) + 1
246 *TruePath = malloc( strlen(Path) + 1 );
247 strcpy(*TruePath, mnt->MountPoint);
248 retLength = mnt->MountPointLen;
251 curNode = mnt->RootNode;
252 curNode->ReferenceCount ++;
254 ofs = mnt->MountPointLen+1;
255 for(; (nextSlash = strpos(&Path[ofs], '/')) != -1; ofs += nextSlash + 1)
257 char pathEle[nextSlash+1];
260 if(nextSlash == 0) continue;
262 memcpy(pathEle, &Path[ofs], nextSlash);
263 pathEle[nextSlash] = 0;
265 // Check permissions on root of filesystem
266 if( !VFS_CheckACL(curNode, VFS_PERM_EXECUTE) ) {
267 if(curNode->Close) curNode->Close( curNode );
272 //Log("Permissions fail on '%s'", Path);
277 // Check if the node has a FindDir method
278 if( !curNode->FindDir )
280 if(curNode->Close) curNode->Close(curNode);
285 //Log("FindDir fail on '%s'", Path);
289 LOG("FindDir{=%p}(%p, '%s')", curNode->FindDir, curNode, pathEle);
291 tmpNode = curNode->FindDir(curNode, pathEle);
292 LOG("tmpNode = %p", tmpNode);
294 //LOG2("curNode->Close = %p", curNode->Close);
295 curNode->Close(curNode);
301 LOG("Node '%s' not found in dir '%s'", pathEle, Path);
306 //Log("Child fail on '%s' ('%s)", Path, pathEle);
311 // Handle Symbolic Links
312 if(curNode->Flags & VFS_FFLAG_SYMLINK) {
318 Log_Warning("VFS", "VFS_ParsePath - Read of symlink node %p'%s' is NULL",
320 if(curNode->Close) curNode->Close(curNode);
321 // No need to free *TruePath, it should already be NULL
326 if(iNestedLinks > MAX_NESTED_LINKS) {
327 if(curNode->Close) curNode->Close(curNode);
332 // Parse Symlink Path
333 // - Just update the path variable and restart the function
334 // > Count nested symlinks and limit to some value (counteracts loops)
336 int remlen = strlen(Path) - (ofs + nextSlash);
337 if( curNode->Size + remlen > MAX_PATH_LEN ) {
338 if(curNode->Close) curNode->Close(curNode);
339 Log_Warning("VFS", "VFS_ParsePath - Symlinked path too long");
343 curNode->Read( curNode, 0, curNode->Size, path_buffer );
344 path_buffer[ curNode->Size ] = '\0';
345 strcat(path_buffer, Path + ofs+nextSlash);
348 // Log_Debug("VFS", "VFS_ParsePath: Symlink translated to '%s'", Path);
356 // Handle Non-Directories
357 if( !(curNode->Flags & VFS_FFLAG_DIRECTORY) )
359 Log_Warning("VFS", "VFS_ParsePath - Path segment is not a directory");
360 if(TruePath) free(*TruePath);
365 // Check if path needs extending
366 if(!TruePath) continue;
368 // Increase buffer space
369 tmp = realloc( *TruePath, retLength + strlen(pathEle) + 1 + 1 );
370 // Check if allocation succeeded
372 Log_Warning("VFS", "VFS_ParsePath - Unable to reallocate true path buffer");
375 if(curNode->Close) curNode->Close(curNode);
381 (*TruePath)[retLength] = '/';
382 strcpy(*TruePath+retLength+1, pathEle);
384 LOG("*TruePath = '%s'", *TruePath);
387 retLength += nextSlash + 1;
390 if( !curNode->FindDir ) {
391 if(curNode->Close) curNode->Close(curNode);
396 Log_Warning("VFS", "VFS_ParsePath - FindDir doesn't exist for element of '%s'", Path);
402 LOG("VFS_ParsePath: FindDir(%p, '%s')", curNode, &Path[ofs]);
403 tmpNode = curNode->FindDir(curNode, &Path[ofs]);
404 LOG("tmpNode = %p", tmpNode);
405 if(curNode->Close) curNode->Close(curNode);
406 // Check if file was found
408 LOG("Node '%s' not found in dir '%s'", &Path[ofs], Path);
409 //Log("Child fail '%s' ('%s')", Path, &Path[ofs]);
410 if(TruePath) free(*TruePath);
411 if(curNode->Close) curNode->Close(curNode);
418 // Increase buffer space
419 tmp = realloc(*TruePath, retLength + strlen(&Path[ofs]) + 1 + 1);
420 // Check if allocation succeeded
422 Log_Warning("VFS", "VFS_ParsePath - Unable to reallocate true path buffer");
424 if(tmpNode->Close) tmpNode->Close(curNode);
430 (*TruePath)[retLength] = '/';
431 strcpy(*TruePath + retLength + 1, &Path[ofs]);
433 //retLength += strlen(tmpNode->Name) + 1;
441 * \brief Create and return a handle number for the given node and mode
443 int VFS_int_CreateHandle( tVFS_Node *Node, int Mode )
447 i |= (Mode & VFS_OPENFLAG_EXEC) ? VFS_PERM_EXECUTE : 0;
448 i |= (Mode & VFS_OPENFLAG_READ) ? VFS_PERM_READ : 0;
449 i |= (Mode & VFS_OPENFLAG_WRITE) ? VFS_PERM_WRITE : 0;
454 if( !VFS_CheckACL(Node, i) ) {
455 if(Node->Close) Node->Close( Node );
456 Log_Log("VFS", "VFS_int_CreateHandle: Permissions Failed");
461 i = VFS_AllocHandle( !!(Mode & VFS_OPENFLAG_USER), Node, Mode );
463 Log_Notice("VFS", "VFS_int_CreateHandle: Out of handles");
472 * \fn int VFS_Open(const char *Path, Uint Mode)
475 int VFS_Open(const char *Path, Uint Mode)
480 ENTER("sPath xMode", Path, Mode);
483 absPath = VFS_GetAbsPath(Path);
484 if(absPath == NULL) {
485 Log_Warning("VFS", "VFS_Open: Path expansion failed '%s'", Path);
488 LOG("absPath = \"%s\"", absPath);
489 // Parse path and get mount point
490 node = VFS_ParsePath(absPath, NULL);
491 // Free generated path
495 LOG("Cannot find node");
500 // Check for symlinks
501 if( !(Mode & VFS_OPENFLAG_NOLINK) && (node->Flags & VFS_FFLAG_SYMLINK) )
503 char tmppath[node->Size+1];
504 if( node->Size > MAX_PATH_LEN ) {
505 Log_Warning("VFS", "VFS_Open - Symlink is too long (%i)", node->Size);
509 Log_Warning("VFS", "VFS_Open - No read method on symlink");
512 // Read symlink's path
513 node->Read( node, 0, node->Size, tmppath );
514 tmppath[ node->Size ] = '\0';
515 if(node->Close) node->Close( node );
517 node = VFS_ParsePath(tmppath, NULL);
519 LOG("Cannot find symlink target node (%s)", tmppath);
525 LEAVE_RET('x', VFS_int_CreateHandle(node, Mode));
530 * \brief Open a file from an open directory
532 int VFS_OpenChild(int FD, const char *Name, Uint Mode)
537 ENTER("xFD sName xMode", FD, Name, Mode);
540 h = VFS_GetHandle(FD);
542 Log_Warning("VFS", "VFS_OpenChild - Invalid file handle 0x%x", FD);
547 // Check for directory
548 if( !(h->Node->Flags & VFS_FFLAG_DIRECTORY) ) {
549 Log_Warning("VFS", "VFS_OpenChild - Passed handle is not a directory", FD);
555 node = h->Node->FindDir(h->Node, Name);
561 LEAVE_RET('x', VFS_int_CreateHandle(node, Mode));
564 int VFS_OpenInode(Uint32 Mount, Uint64 Inode, int Mode)
569 ENTER("iMount iInode xMode", Mount, Inode, Mode);
572 mnt = VFS_GetMountByIdent(Mount);
574 LOG("Mount point ident invalid");
579 // Does the filesystem support this?
580 if( !mnt->Filesystem->GetNodeFromINode ) {
586 node = mnt->Filesystem->GetNodeFromINode(mnt->RootNode, Inode);
592 LEAVE_RET('x', VFS_int_CreateHandle(node, Mode));
596 * \fn void VFS_Close(int FD)
597 * \brief Closes an open file handle
599 void VFS_Close(int FD)
604 h = VFS_GetHandle(FD);
606 Log_Warning("VFS", "Invalid file handle passed to VFS_Close, 0x%x", FD);
610 #if VALIDATE_VFS_FUNCTIPONS
611 if(h->Node->Close && !MM_GetPhysAddr(h->Node->Close)) {
612 Log_Warning("VFS", "Node %p's ->Close method is invalid (%p)",
613 h->Node, h->Node->Close);
619 h->Node->Close( h->Node );
625 * \brief Change current working directory
627 int VFS_ChDir(const char *Dest)
634 buf = VFS_GetAbsPath(Dest);
636 Log("VFS_ChDir: Path expansion failed");
640 // Check if path exists
641 fd = VFS_Open(buf, VFS_OPENFLAG_EXEC);
643 Log("VFS_ChDir: Path is invalid");
647 // Get node so we can check for directory
648 h = VFS_GetHandle(fd);
649 if( !(h->Node->Flags & VFS_FFLAG_DIRECTORY) ) {
650 Log("VFS_ChDir: Path is not a directory");
658 // Free old working directory
659 if( CFGPTR(CFG_VFS_CWD) )
660 free( CFGPTR(CFG_VFS_CWD) );
662 CFGPTR(CFG_VFS_CWD) = buf;
664 Log("Updated CWD to '%s'", buf);
670 * \fn int VFS_ChRoot(char *New)
671 * \brief Change current root directory
673 int VFS_ChRoot(const char *New)
679 if(New[0] == '/' && New[1] == '\0')
680 return 1; // What a useless thing to ask!
683 buf = VFS_GetAbsPath(New);
685 LOG("Path expansion failed");
689 // Check if path exists
690 fd = VFS_Open(buf, VFS_OPENFLAG_EXEC);
692 LOG("Path is invalid");
696 // Get node so we can check for directory
697 h = VFS_GetHandle(fd);
698 if( !(h->Node->Flags & VFS_FFLAG_DIRECTORY) ) {
699 LOG("Path is not a directory");
707 // Free old working directory
708 if( CFGPTR(CFG_VFS_CHROOT) )
709 free( CFGPTR(CFG_VFS_CHROOT) );
711 CFGPTR(CFG_VFS_CHROOT) = buf;
713 LOG("Updated Root to '%s'", buf);