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, tVFS_Mount *Mount, 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, tVFS_Mount **MountPoint)
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);
196 // For root we always fast return
197 if(Path[0] == '/' && Path[1] == '\0') {
199 *TruePath = malloc( gVFS_RootMount->MountPointLen+1 );
200 strcpy(*TruePath, gVFS_RootMount->MountPoint);
202 LEAVE('p', gVFS_RootMount->RootNode);
203 return gVFS_RootMount->RootNode;
206 // Check if there is anything mounted
208 Log_Error("VFS", "VFS_ParsePath - No filesystems mounted");
213 longestMount = gVFS_RootMount;
214 for(mnt = gVFS_Mounts; mnt; mnt = mnt->Next)
217 if( Path[mnt->MountPointLen] != '/' && Path[mnt->MountPointLen] != '\0')
219 // Length Check - If the length is smaller than the longest match sofar
220 if(mnt->MountPointLen < longestMount->MountPointLen) continue;
222 cmp = strcmp(Path, mnt->MountPoint);
225 // Fast Break - Request Mount Root
228 *TruePath = malloc( mnt->MountPointLen+1 );
229 strcpy(*TruePath, mnt->MountPoint);
233 LEAVE('p', mnt->RootNode);
234 return mnt->RootNode;
237 // Not a match, continue
238 if(cmp != '/') continue;
242 // Save to shorter variable
245 LOG("mnt = {MountPoint:\"%s\"}", mnt->MountPoint);
250 // Assumes that the resultant path (here) will not be > strlen(Path) + 1
251 *TruePath = malloc( strlen(Path) + 1 );
252 strcpy(*TruePath, mnt->MountPoint);
253 retLength = mnt->MountPointLen;
256 curNode = mnt->RootNode;
257 curNode->ReferenceCount ++;
259 ofs = mnt->MountPointLen+1;
260 for(; (nextSlash = strpos(&Path[ofs], '/')) != -1; ofs += nextSlash + 1)
262 char pathEle[nextSlash+1];
265 if(nextSlash == 0) continue;
267 memcpy(pathEle, &Path[ofs], nextSlash);
268 pathEle[nextSlash] = 0;
270 // Check permissions on root of filesystem
271 if( !VFS_CheckACL(curNode, VFS_PERM_EXECUTE) ) {
272 if(curNode->Close) curNode->Close( curNode );
277 //Log("Permissions fail on '%s'", Path);
282 // Check if the node has a FindDir method
283 if( !curNode->FindDir )
285 if(curNode->Close) curNode->Close(curNode);
290 //Log("FindDir fail on '%s'", Path);
294 LOG("FindDir{=%p}(%p, '%s')", curNode->FindDir, curNode, pathEle);
296 tmpNode = curNode->FindDir(curNode, pathEle);
297 LOG("tmpNode = %p", tmpNode);
299 //LOG2("curNode->Close = %p", curNode->Close);
300 curNode->Close(curNode);
306 LOG("Node '%s' not found in dir '%s'", pathEle, Path);
311 //Log("Child fail on '%s' ('%s)", Path, pathEle);
316 // Handle Symbolic Links
317 if(curNode->Flags & VFS_FFLAG_SYMLINK) {
323 Log_Warning("VFS", "VFS_ParsePath - Read of symlink node %p'%s' is NULL",
325 if(curNode->Close) curNode->Close(curNode);
326 // No need to free *TruePath, it should already be NULL
331 if(iNestedLinks > MAX_NESTED_LINKS) {
332 if(curNode->Close) curNode->Close(curNode);
337 // Parse Symlink Path
338 // - Just update the path variable and restart the function
339 // > Count nested symlinks and limit to some value (counteracts loops)
341 int remlen = strlen(Path) - (ofs + nextSlash);
342 if( curNode->Size + remlen > MAX_PATH_LEN ) {
343 if(curNode->Close) curNode->Close(curNode);
344 Log_Warning("VFS", "VFS_ParsePath - Symlinked path too long");
348 curNode->Read( curNode, 0, curNode->Size, path_buffer );
349 path_buffer[ curNode->Size ] = '\0';
350 strcat(path_buffer, Path + ofs+nextSlash);
353 // Log_Debug("VFS", "VFS_ParsePath: Symlink translated to '%s'", Path);
361 // Handle Non-Directories
362 if( !(curNode->Flags & VFS_FFLAG_DIRECTORY) )
364 Log_Warning("VFS", "VFS_ParsePath - Path segment is not a directory");
365 if(TruePath) free(*TruePath);
370 // Check if path needs extending
371 if(!TruePath) continue;
373 // Increase buffer space
374 tmp = realloc( *TruePath, retLength + strlen(pathEle) + 1 + 1 );
375 // Check if allocation succeeded
377 Log_Warning("VFS", "VFS_ParsePath - Unable to reallocate true path buffer");
380 if(curNode->Close) curNode->Close(curNode);
386 (*TruePath)[retLength] = '/';
387 strcpy(*TruePath+retLength+1, pathEle);
389 LOG("*TruePath = '%s'", *TruePath);
392 retLength += nextSlash + 1;
395 if( !curNode->FindDir ) {
396 if(curNode->Close) curNode->Close(curNode);
401 Log_Warning("VFS", "VFS_ParsePath - FindDir doesn't exist for element of '%s'", Path);
407 LOG("FindDir(%p, '%s')", curNode, &Path[ofs]);
408 tmpNode = curNode->FindDir(curNode, &Path[ofs]);
409 LOG("tmpNode = %p", tmpNode);
410 if(curNode->Close) curNode->Close(curNode);
411 // Check if file was found
413 LOG("Node '%s' not found in dir '%s'", &Path[ofs], Path);
414 //Log("Child fail '%s' ('%s')", Path, &Path[ofs]);
415 if(TruePath) free(*TruePath);
416 if(curNode->Close) curNode->Close(curNode);
423 // Increase buffer space
424 tmp = realloc(*TruePath, retLength + strlen(&Path[ofs]) + 1 + 1);
425 // Check if allocation succeeded
427 Log_Warning("VFS", "VFS_ParsePath - Unable to reallocate true path buffer");
429 if(tmpNode->Close) tmpNode->Close(curNode);
435 (*TruePath)[retLength] = '/';
436 strcpy(*TruePath + retLength + 1, &Path[ofs]);
438 //retLength += strlen(tmpNode->Name) + 1;
450 * \brief Create and return a handle number for the given node and mode
452 int VFS_int_CreateHandle( tVFS_Node *Node, tVFS_Mount *Mount, int Mode )
456 i |= (Mode & VFS_OPENFLAG_EXEC) ? VFS_PERM_EXECUTE : 0;
457 i |= (Mode & VFS_OPENFLAG_READ) ? VFS_PERM_READ : 0;
458 i |= (Mode & VFS_OPENFLAG_WRITE) ? VFS_PERM_WRITE : 0;
463 if( !VFS_CheckACL(Node, i) ) {
464 if(Node->Close) Node->Close( Node );
465 Log_Log("VFS", "VFS_int_CreateHandle: Permissions Failed");
470 i = VFS_AllocHandle( !!(Mode & VFS_OPENFLAG_USER), Node, Mode );
472 Log_Notice("VFS", "VFS_int_CreateHandle: Out of handles");
477 VFS_GetHandle(i)->Mount = Mount;
483 * \fn int VFS_Open(const char *Path, Uint Mode)
486 int VFS_Open(const char *Path, Uint Mode)
492 ENTER("sPath xMode", Path, Mode);
495 absPath = VFS_GetAbsPath(Path);
496 if(absPath == NULL) {
497 Log_Warning("VFS", "VFS_Open: Path expansion failed '%s'", Path);
500 LOG("absPath = \"%s\"", absPath);
501 // Parse path and get mount point
502 node = VFS_ParsePath(absPath, NULL, &mnt);
503 // Free generated path
507 LOG("Cannot find node");
512 // Check for symlinks
513 if( !(Mode & VFS_OPENFLAG_NOLINK) && (node->Flags & VFS_FFLAG_SYMLINK) )
515 char tmppath[node->Size+1];
516 if( node->Size > MAX_PATH_LEN ) {
517 Log_Warning("VFS", "VFS_Open - Symlink is too long (%i)", node->Size);
521 Log_Warning("VFS", "VFS_Open - No read method on symlink");
524 // Read symlink's path
525 node->Read( node, 0, node->Size, tmppath );
526 tmppath[ node->Size ] = '\0';
527 if(node->Close) node->Close( node );
529 node = VFS_ParsePath(tmppath, NULL, &mnt);
531 LOG("Cannot find symlink target node (%s)", tmppath);
537 LEAVE_RET('x', VFS_int_CreateHandle(node, mnt, Mode));
542 * \brief Open a file from an open directory
544 int VFS_OpenChild(int FD, const char *Name, Uint Mode)
549 ENTER("xFD sName xMode", FD, Name, Mode);
552 h = VFS_GetHandle(FD);
554 Log_Warning("VFS", "VFS_OpenChild - Invalid file handle 0x%x", FD);
559 // Check for directory
560 if( !(h->Node->Flags & VFS_FFLAG_DIRECTORY) ) {
561 Log_Warning("VFS", "VFS_OpenChild - Passed handle is not a directory", FD);
567 node = h->Node->FindDir(h->Node, Name);
573 LEAVE_RET('x', VFS_int_CreateHandle(node, h->Mount, Mode));
576 int VFS_OpenInode(Uint32 Mount, Uint64 Inode, int Mode)
581 ENTER("iMount iInode xMode", Mount, Inode, Mode);
584 mnt = VFS_GetMountByIdent(Mount);
586 LOG("Mount point ident invalid");
591 // Does the filesystem support this?
592 if( !mnt->Filesystem->GetNodeFromINode ) {
598 node = mnt->Filesystem->GetNodeFromINode(mnt->RootNode, Inode);
604 LEAVE_RET('x', VFS_int_CreateHandle(node, mnt, Mode));
608 * \fn void VFS_Close(int FD)
609 * \brief Closes an open file handle
611 void VFS_Close(int FD)
616 h = VFS_GetHandle(FD);
618 Log_Warning("VFS", "Invalid file handle passed to VFS_Close, 0x%x", FD);
622 #if VALIDATE_VFS_FUNCTIPONS
623 if(h->Node->Close && !MM_GetPhysAddr(h->Node->Close)) {
624 Log_Warning("VFS", "Node %p's ->Close method is invalid (%p)",
625 h->Node, h->Node->Close);
631 h->Node->Close( h->Node );
637 * \brief Change current working directory
639 int VFS_ChDir(const char *Dest)
646 buf = VFS_GetAbsPath(Dest);
648 Log("VFS_ChDir: Path expansion failed");
652 // Check if path exists
653 fd = VFS_Open(buf, VFS_OPENFLAG_EXEC);
655 Log("VFS_ChDir: Path is invalid");
659 // Get node so we can check for directory
660 h = VFS_GetHandle(fd);
661 if( !(h->Node->Flags & VFS_FFLAG_DIRECTORY) ) {
662 Log("VFS_ChDir: Path is not a directory");
670 // Free old working directory
671 if( CFGPTR(CFG_VFS_CWD) )
672 free( CFGPTR(CFG_VFS_CWD) );
674 CFGPTR(CFG_VFS_CWD) = buf;
676 Log("Updated CWD to '%s'", buf);
682 * \fn int VFS_ChRoot(char *New)
683 * \brief Change current root directory
685 int VFS_ChRoot(const char *New)
691 if(New[0] == '/' && New[1] == '\0')
692 return 1; // What a useless thing to ask!
695 buf = VFS_GetAbsPath(New);
697 LOG("Path expansion failed");
701 // Check if path exists
702 fd = VFS_Open(buf, VFS_OPENFLAG_EXEC);
704 LOG("Path is invalid");
708 // Get node so we can check for directory
709 h = VFS_GetHandle(fd);
710 if( !(h->Node->Flags & VFS_FFLAG_DIRECTORY) ) {
711 LOG("Path is not a directory");
719 // Free old working directory
720 if( CFGPTR(CFG_VFS_CHROOT) )
721 free( CFGPTR(CFG_VFS_CHROOT) );
723 CFGPTR(CFG_VFS_CHROOT) = buf;
725 LOG("Updated Root to '%s'", buf);