3.5.2.7. FileSystems
File: classes/FileSystems.php
There are two classes used to support user file systems: TProtection and TFile_Systems.
3.5.2.7.1. TProtection
TProtection encapsulates a file protection value. A protection code specification has
the form:
<user><friends><site><server><world><group>
where "<user>" contains the protection codes for the owner, "<friends>" are the protection codes for friends, and so forth.
The class contains the following fields:
| |
|---|
| $user | owner protection |
| $friends | friend protection |
| $site | site protection |
| $server | server protection |
| $world | world protection |
| $group | group protection |
The four protection codes for each level of protection are:
- R: Read access allowed
- W: Write access allowed
- D: Delete access allowed
- C: Control access allowed
Thus, a full protection code specification might look something like this:
RWDCRW R
which would indicate that the owner had all permissions for the file, friends have
read and write permission, site users had read permission, and anyone else has no
permission.
3.5.2.7.1.1. __construct
Format: result = new TProtection(code)
where "code" is the protection specification to assign to the object.
Example: $prot = new TProtection("RWCD");
This creates a new TProtection instance with the given protection code.
3.5.2.7.1.2. get_protection
Format: result = get_protection()
Example: $code = $prot->get_protection();
This method returns the current protection settings of the object as a full protection
code specification.
3.5.2.7.2. File_Systems
The File_Systems class implements the user file system for EWE.
3.5.2.7.2.1. add_device
Format: result = add_device(name,location,public=True)
where "name" is the file system device name, "location" is the local folder path,
and "public" is true if this device is public, or fatlse otherwise.
Example: $result = $fs->add_device($name,$location,False);
This adds a new database set with the given parameters.
3.5.2.7.2.2. Allowed
Format: result = Allowed(uid,site,protection,operation='R')
where "uid" is the user id of the file in question, "site" is the site for the file
in question, "protection" is the file protection code to check against, and
"operation" is the type of operation (R for read, W for write, D for delete, and C
for control).
Example: $result = $fs->Allowed($uid,$site,$prot,$op='R');
This method checks the current user against the passed file protection to see if the
indicated operation is allowed. It returns true if so, and false otherwise.
3.5.2.7.2.3. Create_File
Format: result = Create_File(user,site,path,&fileName,fileSize,protection='RWCD',group=0)
where "user" is the user id of the file in question, "site" is the site for the file
in question, "path" is the path within the file system where to create the file, "fileName" is the name of the file when passed and the file id on return, "fileSize" is the size of the file, "protection" is the file protection code to assign to the file, and
"group" is reserved for future use - 0 should always be passed for this.
Example: $result = $fs->Create_File($uid,$site,$path,&$fileName,$fileSize,$prot='RWCD');
This method checks the current user against the passed file protection to see if the
indicated operation is allowed. It returns true if so, and false otherwise.
3.5.2.7.2.4. Create_Folder
Format: result = Create_Folder(user,site,path,name,protection='RWCD ')
where "user" is the user id of the file in question, "site" is the site for the file
in question, "path" is the path within the file system where to create the folder, "name" is the name of the file, and "protection" is the file protection code to assign to the folder.
Example: $result = $fs->Create_Folder($target,$site,$path,$name,$prot='RWCD ');
This method checks the current user against the passed file protection to see if the
indicated operation is allowed. It returns true if so, and false otherwise.
3.5.2.7.2.5. delete_device
Format: result = delete_device(id)
where "id" is the device id of the device to delete.
Example: $result = $fs->delete_device($id);
This method checks the current user against the passed file protection to see if the
indicated operation is allowed. It returns true if so, and false otherwise.
3.5.2.7.2.6. delete_file
Format: result = delete_file(fid)
where "fid" is the id of the file to delete.
Example: $result = $fs->delete_file($fid);
This method removes the indicated file from the file system.
3.5.2.7.2.7. get_device
Format: result = get_device(id)
where "id" is the id of the device.
Example: $result = $fs->get_device($id);
This method returns an array of information about the specified device.
3.5.2.7.2.8. get_device_location
Format: result = get_device_location(fsid)
where "fsid" is the id of the device.
Example: $result = $fs->get_device_location($fsid);
This method returns the host computer path for the specified device.
3.5.2.7.2.9. get_devices
Format: result = get_devices()
Example: $result = $fs->get_devices();
This method returns an array of file system devices. Each element is an array of
information about the device.
3.5.2.7.2.10. get_file
Format: result = get_file(fsid)
where "fsid" is the file id of the file to obtain.
Example: $result = $fs->get_file($fid);
This method returns an array of information about the file with the specified
ID.
3.5.2.7.2.11. Path_To_FID
Format: result = Path_To_FID(site,uid,path)
where "site" is the site id and "uid" is the user id of the file, "path" is the
path name in the user file system.
Example: $path = $fs->Path_To_FID($site,$uid,$path);
This method converts the specified path to a file system ID.
3.5.2.7.2.12. reset_views
Format: result = reset_views(fid)
where "fid" is the file id of the file to modify.
Example: $path = $fs->reset_views($fid);
This method sets the view/download count to 0 for the specified file.
3.5.2.7.2.13. scandir
Format: result = scandir(site,uid,path)
where "site" is the site id of the path, "uid" is the user id, and "path" is
the name of the path to scan.
Example: $files = $fs->scandir($site,$uid,$path);
This method sets the view/download count to 0 for the specified file.
3.5.2.7.2.14. set_device
Format: result = set_device(id,name,location,public)
where "id" is the device system ID of the file, "name" is the new device name, "location"
is the host computer path for the device, and "public" is True to make the device public,
or false otherwise.
Example: $result = $fs->set_device($id,$name,$location,$public);
This method sets the parameters of the specified device.
3.5.2.7.2.15. set_file_protection
Format: result = set_file_protection(fid,prot)
where "fid" is the file ID of the file and "protection" is the new file protection specification.
Example: $result = $fs->set_file_protection($fid,$prot);
This method sets the protection of the specified file/folder in the user file system.
3.5.2.7.2.16. show_file
Format: result = show_file(fid)
where "fid" is the file ID of the file.
Example: $result = $fs->show_file($fid);
This method outputs the specified file, including appropriate headers.