C:/usr/local/lib/php/blueshoes-4.2/core/file/Bs_FileSystem.class.phpandrej arn <andrej at blueshoes dot org>sam blume <sam at blueshoes dot org>Basic filesystem class. gets extended by Bs_File and Bs_Dir.Based on this object we have a dir and file object:FileSystem|+-----+-------+Dir FileNOTE: The path format for input may be windows-like with '\' backslashes.(Even some PHP functions spit out that fomat on Winblows).BUT in all output we use iX path format with '/' forslash.Luckelly Winblows has no problem with this format.Main concept change !=====================This class will have no knowlege of a dir-possition given by paramters.It's an attribute for the Dir- and File-class. In this way all routinescan be looked as static. --sam 7.6.2001not all methods. for example not getFileAttr() because of $this->_lastFetchedPathwe'd need to work around that. 2001/10/04 --andrejIn reality, a dir is not much different from a file. Actually on unix a dir *is* a file.But because you usually do different stuff with them (files -> read|write) and directoriescan 'hold' subdirs and files, we separate them.So wath do Dir and File have in commen?iX (Unix) | Windows NTo Methods:move X | Xdelete X | Xrename X | Xo Touch:create time X | Xaccess time X | X // If it's a dir == create timemodify time X | X // If it's a dir == create timeo File Access:writeable X | Xreadable X | Xexecuteable X | ? 1*)hidden, archive - | X // We will ignor this oneso File Rightsowner X | ? 2*)group X | ? 2*)all X | ? 2*)o Ownershipowner X | ? 3*)group X | ? 3*)o Linkinghard/soft link X | - 4*)short cut - 4*)| X1*) How does windows react? TRUE if readable? dser2*) Windows hat directory sharing. Is that what we see? What about files?3*) How does windows react? Who's the owner?4*) A 'short cut' is normal files (like a batch file) and *NOT* a link!Ever looked at a 'short cut' in the Windows-'Command Promt' (DOS-window)?It's just a stupid normal file that ends with ".lnk". Any file ending with ".lnk"is look as a 'short cut' to Windows.Lets say we have a the 'short cut' foo.lnk that 'links' to a text file foo.txt.Now wath would you expect when you type:more foo.lnkIf it were a link you would expect the content of foo.txt. But *suprise* you'll geta dump of the binary foo.lnk file. *brrrr*It's realy stupid and cheap! I did it 10 years ago by writing a normal ".bat"-file (batch files)that switched to the right dir and called that program. The difference is that 'short cut'-filesare binary and therefore not editable in a text editor.That's way you only can have a 'short cut' to files (no dirs).MEMO: Lots of problems with php's filesystem functions when we're on a winblows box :(1) many methods just don't work - as the docu says2) many bugs listed at php.netno dependencies here.FileSystem4.0.$id$blueshoes.orgConstructor.clearstatcache()see note aboveFALSE if file does not existthis function only gets called fromNOTE: Invoking the stat or lstat system call on most systems is quite expensive.Therefore, the result of the last call to many of the status functions inPHP are stored for use on the next such call using the same file/dir-name.If you wish to force a new status check, for instance if the file isbeing checked many times and may change or disappear, set the param '$clearCache'to TRUE to force a system reread.!!!This value is only cached for the lifetime of a single request.!!!Return most of the file attribute info. (Should work with Windows too).A stanadardized path with '/' instead of '\'(Even some PHP functions spit out that fomat on Winblows).BUT in all output we use iX path format with '/' forslash.Luckelly Winblows has no problem with this format.The path format for input may be windows-like with '\' backslashes.A path to the current working directory of the current process.converting the result to our standard.Gets the current process working directory by using PHP's getcwd() andgetRealPathSplit()realPath()realPathSplit()a path or a part of itthe real pathbool FALSE if the path does not existAND(!) checks for existence!This method basically executes our Bs_FileSystem::getRealPathSplit() function and checks for fileexistens.Make On windows, something like 'c:/dir////dir2' is converted to 'c:\dir\dir2', but i want to haveit converted to 'c:/dir/dir2/'. I like to have foreslashes on all systems. And in this case,dir2 was a directory even if the trailing slash was missing. realPath() should come with theintelligence to add it if dir2 is not a file, imo.Returns canonicalized real pathname *with* ending '/' if it's a dirgetRealPath()realPath()realPathSplit()a path or a part of itbool FALSE if the path does not existAND(!) checks for existence!This method basically executes our Bs_FileSystem::getRealPathSplit() function and checks for fileexistens.returns a hash: ['pathRoot'] <- Things like '/', 'c:/', 'http://', 'ftp://'['pathCore'] <- e.g. 'path/to/a/subdir/'['file'] <- if a file was in the path find it here['tailDir'] <- for convinience the last dir of the ['pathCore'] e.g. 'subdir'['realPath'] <- for convinience ['pathRoot'] . ['pathCore'] . ['file'];Returns a splited canonicalized real pathname *with* ending '/' if it's a dir.getRealPath()getRealPathSplit()realPath()a path or a part of itNo existence check!NOTE 1: No file systems checks are made! So path may or *may not* exsist!See Bs_FileSystem::getRealPathSplit()returns a hash: ['pathRoot'] <- Things like '/', 'c:/', 'http://', 'ftp://'['pathCore'] <- e.g. 'path/to/a/subdir/'['file'] <- if a file was in the path find it here['tailDir'] <- for convinience the last dir of the ['pathCore'] e.g. 'subdir'['realPath'] <- for convinience ['pathRoot'] . ['pathCore'] . ['file'];Returns a splited canonicalized real pathname *with* ending '/' if it's a dir.a pathTRUE if it's a new and valid dir, FALSE if it did not change.Set our view to the directory or file passed by '$workingDir'.returns the directory or file that this object (subclassed file or dir object) is looking at.a paththe path (without filename)falseExamples on Windows: (on *nix there is of course no drive prefix 'f:')"f:/dir 790/asdf/file.xyz.html" => "f:/dir 790/asdf/""f:\\dir 790\\asdf\\file.xyz.html" => "f:/dir 790/asdf/""f:\\dir 790\\asdf/" => "f:/dir 790/asdf/""f:\\dir 790\\asdf" => "f:/dir 790/" <= even if asdf is a dir!! (see note II)NOTE I: PHP's dirname() doesn't return the trailing slash, but we do.NOTE II: This method doesn't try to check if the last part is a file or adir, when the trailing slash is not given. because the fullPathgiven doesn't need to exist (on this system)...so even if in 'c:/one/two' two is a directory, only 'c:/one/' willbe returned.Get the stem part of a path.filename and/or paththe filename if found else ''Get the file name from a path.(a path to a dir or file on that machine)the file extensionexamples:'c:\myFile.php' -> 'php''c:\myFile.class.php' -> 'php''c:\myFile' -> '''c:\myFile.class.php.lnk' -> 'php' <= special case on winblows for linksmay be used without param, then it will be for the file/dir that iscurrently in use. otherwise it is used pseudostatic.Get the file extension from a path.replacement to php's basename() function which sucks.The path you give is first standardized replace '\' with '/'see http://www.php.net/manual/en/function.basename.phpreturns the base name of a path (filename).1) cannot have one of these characters: \ / : * ? " < > |2) cannot start or end with a space3) cannot start with a dot '.'if you want to test with a scary filename, use this one: {}d % test.txt {} _-d°§+@ #ç&()=~^`´'$£no file can be named '.' or '..' (which could cause bugs with these unix-like things).linux filename1) cannot have one of these characters: &2) some more, don't know.windows filename and dirname (tested on winnt 4.0 german)(a path to a dir or file on that machine)uses php's is_link() on *nix and something handmade on winblows.may be used without param, then it will be for the file/dir that iscurrently in use. otherwise it is used pseudostatic.tells wheter the current file/path (or $fullPath) is a link or not.''Hash with the attributes of the current file.Used with $this->getFileInfo() as cach info.''array()4.0.$x$isexisexceptiontostringtohtmlpersistunpersistbs_objectbbsetoutputbbawakebbisawakebbxmsgbbxfunctionstartbbxfunctionendbbxechobbxvarbbxvardumpbbforcetracebbbufferstartbbbuffergetbbbufferendflushbbbufferendcleanbs_object_versionBs_ObjectBs_ObjectBs_DirBs_File