2001-06-20 10:16:13 +02:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
|
|
|
|
<HTML>
|
|
|
|
|
<HEAD>
|
2003-08-28 16:31:11 +02:00
|
|
|
<META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.17">
|
2001-06-20 10:16:13 +02:00
|
|
|
<TITLE>phpgwapi - VFS Class: Notes</TITLE>
|
2001-06-23 10:30:14 +02:00
|
|
|
<LINK HREF="vfs-7.html" REL=next>
|
2001-06-20 10:16:13 +02:00
|
|
|
<LINK HREF="vfs-5.html" REL=previous>
|
|
|
|
|
<LINK HREF="vfs.html#toc6" REL=contents>
|
|
|
|
|
</HEAD>
|
|
|
|
|
<BODY>
|
2001-06-23 10:30:14 +02:00
|
|
|
<A HREF="vfs-7.html">Next</A>
|
2001-06-20 10:16:13 +02:00
|
|
|
<A HREF="vfs-5.html">Previous</A>
|
|
|
|
|
<A HREF="vfs.html#toc6">Contents</A>
|
|
|
|
|
<HR>
|
|
|
|
|
<H2><A NAME="sec:notes"></A> <A NAME="s6">6.</A> <A HREF="vfs.html#toc6">Notes</A></H2>
|
|
|
|
|
|
|
|
|
|
<H2><A NAME="sec:database"></A> <A NAME="ss6.1">6.1</A> <A HREF="vfs.html#toc6.1">Database</A>
|
|
|
|
|
</H2>
|
|
|
|
|
|
2002-02-25 09:45:41 +01:00
|
|
|
<P>Data about the files and directories within the virtual root
|
|
|
|
|
is kept in the SQL database. Currently, this information includes:</P>
|
2001-06-20 10:16:13 +02:00
|
|
|
<P>
|
|
|
|
|
<UL>
|
|
|
|
|
<LI>File ID (used internally, primary key for table)</LI>
|
|
|
|
|
<LI>Owner ID (phpGW account_id)</LI>
|
|
|
|
|
<LI>Created by ID (phpGW account_id)</LI>
|
|
|
|
|
<LI>Modified by ID (phpGW account_id)</LI>
|
|
|
|
|
<LI>Created (date)</LI>
|
|
|
|
|
<LI>Modified (date)</LI>
|
|
|
|
|
<LI>Size (bytes)</LI>
|
|
|
|
|
<LI>MIME type</LI>
|
|
|
|
|
<LI>Deleteable (Y/N/Other?)</LI>
|
|
|
|
|
<LI>Comment</LI>
|
|
|
|
|
<LI>App (appname of application that created the file)</LI>
|
|
|
|
|
<LI>Directory (directory the file or directory is in)</LI>
|
|
|
|
|
<LI>Name (name of file or directory)</LI>
|
2002-02-25 09:45:41 +01:00
|
|
|
<LI>Link directory (if the file or directory is linked, what the
|
|
|
|
|
actual directory is)</LI>
|
|
|
|
|
<LI>Link name (if the file or directory is linked, what the actual
|
|
|
|
|
name is)</LI>
|
|
|
|
|
<LI>Version (numeric version of the file)</LI>
|
2001-06-20 10:16:13 +02:00
|
|
|
</UL>
|
|
|
|
|
</P>
|
2002-02-25 09:45:41 +01:00
|
|
|
<P>The internal names of these (the database column names) are stored
|
|
|
|
|
in the $GLOBALS['phpgw']->vfs->attributes
|
|
|
|
|
array, which is useful for loops, and is guaranteed to be up-to-date.</P>
|
|
|
|
|
<P>Note that no information is kept about files outside the virtual
|
|
|
|
|
root. If a file is moved outside, all records of it are deleted from
|
|
|
|
|
the database (other than the journaling records). If a file is moved
|
|
|
|
|
into the virtual root, some information, specifically MIME-type,
|
|
|
|
|
is not always stored in the database. The vital information has defaults:
|
|
|
|
|
owner is based on where the file is being stored; size is correctly
|
|
|
|
|
read; deleteable is set to Y.</P>
|
2001-06-20 10:16:13 +02:00
|
|
|
<H2><A NAME="sec:acl_support"></A> <A NAME="ss6.2">6.2</A> <A HREF="vfs.html#toc6.2">ACL support</A>
|
|
|
|
|
</H2>
|
|
|
|
|
|
2002-02-25 09:45:41 +01:00
|
|
|
<P>ACL support is built into the VFS. vfs->acl_check () does
|
|
|
|
|
the actual checking, and is called from all VFS functions as needed.
|
|
|
|
|
If the file or directory sent to acl_check () doesn't exist, the
|
|
|
|
|
permissions for the parent directory are used to determine access.
|
|
|
|
|
ACL checking can be overridden at any time by setting vfs->override_acl.
|
|
|
|
|
For example:</P>
|
2001-06-20 10:16:13 +02:00
|
|
|
<P>
|
|
|
|
|
<PRE>
|
2002-02-25 09:45:41 +01:00
|
|
|
$GLOBALS['phpgw']->vfs->override_acl = 1;
|
|
|
|
|
$GLOBALS['phpgw']->vfs->mkdir (array(
|
|
|
|
|
'string' => $GLOBALS['fakebase']. '/' . $group_array['account_name'],
|
|
|
|
|
'relatives' => array(
|
|
|
|
|
RELATIVE_NONE
|
|
|
|
|
)
|
|
|
|
|
));
|
|
|
|
|
$GLOBALS['phpgw']->vfs->override_acl = 0;
|
2001-06-20 10:16:13 +02:00
|
|
|
</PRE>
|
|
|
|
|
</P>
|
|
|
|
|
<H2><A NAME="sec:function_aliases"></A> <A NAME="ss6.3">6.3</A> <A HREF="vfs.html#toc6.3">Function aliases</A>
|
|
|
|
|
</H2>
|
|
|
|
|
|
2002-02-25 09:45:41 +01:00
|
|
|
<P>You might have noticed there are some functions that just pass
|
|
|
|
|
the arguments on to other functions. These are provided in part because
|
|
|
|
|
of legacy and in part for convenience. You can use either. Here is
|
|
|
|
|
the list (alias -> actual):</P>
|
2001-06-20 10:16:13 +02:00
|
|
|
<P>
|
|
|
|
|
<UL>
|
|
|
|
|
<LI>copy -> cp</LI>
|
|
|
|
|
<LI>move -> rm</LI>
|
|
|
|
|
<LI>delete -> rm</LI>
|
|
|
|
|
<LI>dir -> ls</LI>
|
|
|
|
|
</UL>
|
|
|
|
|
</P>
|
|
|
|
|
<H2><A NAME="sec:fakebase"></A> <A NAME="ss6.4">6.4</A> <A HREF="vfs.html#toc6.4">Fakebase directory (changing /home)</A>
|
|
|
|
|
</H2>
|
|
|
|
|
|
2002-02-25 09:45:41 +01:00
|
|
|
<P>The old VFS was hard-coded to use '/home' as the fake base directory,
|
2001-06-20 10:16:13 +02:00
|
|
|
even though the user never saw it. With the new system, crafty administrators
|
2002-02-25 09:45:41 +01:00
|
|
|
may wish to change '/home' to something else, say '/users' or '/public_html'.
|
|
|
|
|
The fake base directory name is stored in $GLOBALS['phpgw']->vfs->fakebase,
|
|
|
|
|
and changing it will transparently change it throughout the VFS and
|
|
|
|
|
all applications. However, this must be done <EM>before</EM> any data is in
|
|
|
|
|
the VFS database. If you wish to change it afterwords, you'll have
|
|
|
|
|
to manually update the database, replacing the old value with the
|
|
|
|
|
new value. <EM>Application programmers need to recognize that /home is
|
|
|
|
|
not absolute, and use $GLOBALS['phpgw']->vfs->fakebase
|
|
|
|
|
instead</EM>. I suggest setting $fakebase = $GLOBALS['phpgw']->vfs->fakebase;
|
|
|
|
|
right off the bat to keep things neater.</P>
|
2001-06-20 10:16:13 +02:00
|
|
|
<HR>
|
2001-06-23 10:30:14 +02:00
|
|
|
<A HREF="vfs-7.html">Next</A>
|
2001-06-20 10:16:13 +02:00
|
|
|
<A HREF="vfs-5.html">Previous</A>
|
|
|
|
|
<A HREF="vfs.html#toc6">Contents</A>
|
|
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|
