forked from extern/egroupware
move from old projct to new one
This commit is contained in:
reinerj
parent
059dd57a50
commit
ee0cefe3c0
@ -1,6 +1,6 @@
|
||||
/**************************************************************************\
|
||||
* phpGroupWare API - Contacts class documentation *
|
||||
* This file written by Miles Lott <milosch@phpgroupware.org> *
|
||||
* eGroupWare API - Contacts class documentation *
|
||||
* This file written by Miles Lott <milosch@groupwhare.org> *
|
||||
* -------------------------------------------------------------------------*
|
||||
* This library is free software; you can redistribute it and/or modify it *
|
||||
* under the terms of the GNU Lesser General Public License as published by *
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<title>phpgroupware.org</title>
|
||||
<title>egroupware.org</title>
|
||||
<link rel="STYLESHEET" type="text/css" href="phpgw.css">
|
||||
</head>
|
||||
|
||||
@ -14,7 +14,7 @@
|
||||
<td align="right">
|
||||
<table border="0" cellspacing="3" cellpadding="3">
|
||||
<tr>
|
||||
<td><a href="http://www.phpgroupware.org/"><img src="../templates/default/images/logo.gif"></a></td>
|
||||
<td><a href="http://www.egroupware.org/"><img src="../templates/default/images/logo.gif"></a></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
@ -22,16 +22,16 @@
|
||||
<tr>
|
||||
<td valign="top" width="85%">
|
||||
<table border="0" cellpadding="2"><tr><td>
|
||||
<p>You can get your own copy of the phpGroupWare CVS tree by using a CVS client from your own system. If you don't already
|
||||
<p>You can get your own copy of the eGroupWare CVS tree by using a CVS client from your own system. If you don't already
|
||||
have one, you can find one at <a href="http://www.cvshome.org">http://www.cvshome.org</a>.
|
||||
You can get your own copy of the tree with the commands:</p>
|
||||
|
||||
<pre>cvs -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware login</pre>
|
||||
<pre>cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/egroupware login</pre>
|
||||
|
||||
<p>When it asks you for a password, simply press the Enter key</p>
|
||||
<p>Then type:</p>
|
||||
|
||||
<pre>cvs -z3 -d:pserver:anonymous@cvs.phpgroupware.sourceforge.net:/cvsroot/phpgroupware co [ -r <TAG> ] <MODULE></pre>
|
||||
<pre>cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/egroupware co [ -r <TAG> ] <MODULE></pre>
|
||||
|
||||
<p>This will create a <tt><MODULE></tt> directory in your current
|
||||
directory. It may take a bit of time, especially if your network connection
|
||||
@ -55,59 +55,30 @@ wish to checkout. At this time, tags that would be of use are:
|
||||
|
||||
<p>Valid module names are:</p>
|
||||
<table border="0" cellpadding="1" cellspacing="1">
|
||||
<tr><td>phpgroupware * </td><td>The core phpGroupWare libraries</td></tr>
|
||||
<tr><td>phpgwapi * </td><td>The phpGroupWare API</td></tr>
|
||||
<tr><td>egroupware * </td><td>The core eGoupWare libraries</td></tr>
|
||||
<tr><td>phpgwapi * </td><td>The eGoupWare API</td></tr>
|
||||
<tr><td>addressbook * </td><td>an addressbook</td></tr>
|
||||
<tr><td>admin * </td><td>Administration module</td></tr>
|
||||
<tr><td>bookkeeping </td><td>Personal finance manager</td></tr>
|
||||
<tr><td>bookmarks </td><td>Bookmark manager</td></tr>
|
||||
<tr><td>calendar * </td><td>personal/Group calendar</td></tr>
|
||||
<tr><td>cart </td><td>?</td></tr>
|
||||
<tr><td>cdb </td><td>Contact Database Manager (work in progress)</td></tr>
|
||||
<tr><td>chat </td><td>chat system</td></tr>
|
||||
<tr><td>chora </td><td>CVS repository front-end</td></tr>
|
||||
<tr><td>comic </td><td>Comic Strip system</td></tr>
|
||||
<tr><td>cron * </td><td>cron files for administrative uses</td></tr>
|
||||
<tr><td>dj </td><td>MP3 list manager (Indirectly interfacing with icecast)</td></tr>
|
||||
<tr><td>eldaptdir </td><td>LDAP Browser</td></tr>
|
||||
<tr><td>email * </td><td>EMAIL reader (interfaces to IMAP/POP3)</td></tr>
|
||||
<tr><td>filemanager * </td><td>Personal/Group Filemanagement</td></tr>
|
||||
<tr><td>files * </td><td>Simple Structure for filemanager system</td></tr>
|
||||
<tr><td>forum </td><td>A forum system</td></tr>
|
||||
<tr><td>ftp </td><td>web based FTP client</td></tr>
|
||||
<tr><td>headlines </td><td>news site headline system</td></tr>
|
||||
<tr><td>hr </td><td>Human Resource module</td></tr>
|
||||
<tr><td>inv </td><td>Invoice system</td></tr>
|
||||
<tr><td>manual * </td><td>online phpGroupWare manual</td></tr>
|
||||
<tr><td>mediadb </td><td>Media database tracking system</td></tr>
|
||||
<tr><td>news_admin </td><td>create system wide news for your phpGroupWare installation</td></tr>
|
||||
<tr><td>nntp * </td><td>Network News Reader</td></tr>
|
||||
<tr><td>notes * </td><td>create personal/group notes</td></tr>
|
||||
<tr><td>phonelog * </td><td>Phonelog system</td></tr>
|
||||
<tr><td>bookkeeping </td><td>Personal finance manager</td></tr>
|
||||
<tr><td>phpgroupware * </td><td>The core phpGroupWare libraries</td></tr>
|
||||
<tr><td>phpgwapi * </td><td>The phpGroupWare API</td></tr>
|
||||
<tr><td>phpgwnetsaint </td><td>Netsaint viewer</td></tr>
|
||||
<tr><td>manual * </td><td>online eGoupWare manual</td></tr>
|
||||
<tr><td>news_admin </td><td>create system wide news for your eGoupWare installation</td></tr>
|
||||
<tr><td>polls * </td><td>create/administer polls</td></tr>
|
||||
<tr><td>preferences * </td><td>Manage phpGroupWare user preferences</td></tr>
|
||||
<tr><td>projectbilling </td><td>?</td></tr>
|
||||
<tr><td>projectdelivery </td><td>?</td></tr>
|
||||
<tr><td>projecthours </td><td>?</td></tr>
|
||||
<tr><td>preferences * </td><td>Manage eGoupWare user preferences</td></tr>
|
||||
<tr><td>projects </td><td>?</td></tr>
|
||||
<tr><td>projectstatistics</td><td>?</td></tr>
|
||||
<tr><td>rbs </td><td>Remote Booking System (soon to be merged into calendar)</td></tr>
|
||||
<tr><td>setup * </td><td>phpGroupWare setup</td></tr>
|
||||
<tr><td>squirrelmail * </td><td>EMAIL reader (interfaces to IMAP/POP3)</td></tr>
|
||||
<tr><td>setup * </td><td>eGoupWare setup</td></tr>
|
||||
<tr><td>stocks </td><td>stock info grabber</td></tr>
|
||||
<tr><td>todo * </td><td>TO-DO List manger</td></tr>
|
||||
<tr><td>transy * </td><td>Language translation management</td></tr>
|
||||
<tr><td>tts </td><td>Trouble Ticket System</td></tr>
|
||||
<tr><td>wap </td><td>Wireless Application Protocol templates</td></tr>
|
||||
<tr><td>weather </td><td>weather information grabber</td></tr>
|
||||
</table>
|
||||
|
||||
<p>You should probably check out <code>phpgroupware</code> first, then
|
||||
<code>cd phpgroupware</code>, and then check out any additional modules that you
|
||||
<p>You should probably check out <code>egroupware</code> first, then
|
||||
<code>cd egroupware</code>, and then check out any additional modules that you
|
||||
want.<br>We suggest at a minimum that you install those modules that mare marked with an "*".</p>
|
||||
|
||||
<p>Please keep in mind that the CVS '-r HEAD' version may not always work correctly,
|
||||
|
||||
@ -14,7 +14,7 @@ Previous
|
||||
<HR>
|
||||
<H2><A NAME="sec:introduction"></A> <A NAME="s1">1.</A> <A HREF="vfs.html#toc1">Introduction and Purpose</A></H2>
|
||||
|
||||
<P>The latest version of the VFS for phpGroupWare combines actual
|
||||
<P>The latest version of the VFS for eGroupWare combines actual
|
||||
file system manipulation with fully integrated database support.
|
||||
It features nearly transparent handling of files and directories,
|
||||
as well as files inside and outside the virtual root. This document
|
||||
|
||||
@ -23,7 +23,7 @@ An example:</P>
|
||||
<P>
|
||||
<PRE>
|
||||
$GLOBALS['phpgw_info']['flags'] = array(
|
||||
'currentapp' => 'phpwebhosting',
|
||||
'currentapp' => 'filemanaer',
|
||||
'noheader' => False,
|
||||
'noappheader' => False,
|
||||
'enable_vfs_class' => True,
|
||||
@ -99,8 +99,8 @@ to use the virtual paths. For example, instead of using:</P>
|
||||
<P>
|
||||
<PRE>
|
||||
$GLOBALS['phpgw']->vfs->cp (array(
|
||||
'from' => '/var/www/phpgroupware/files/home/user/file1',
|
||||
'to' => '/var/www/phpgroupware/files/home/user/file2',
|
||||
'from' => '/var/www/egroupware/files/home/user/file1',
|
||||
'to' => '/var/www/egroupware/files/home/user/file2',
|
||||
'relatives' => array(
|
||||
RELATIVE_NONE|VFS_REAL,
|
||||
RELATIVE_NONE|VFS_REAL
|
||||
|
||||
@ -71,8 +71,8 @@ $p = $GLOBALS['phpgw']->vfs->path_parts (array(
|
||||
<LI>$p->fake_leading_dirs - /home/jason/dir</LI>
|
||||
<LI>$p->fake_extra_path - home/jason/dir</LI>
|
||||
<LI>$p->fake_name - file</LI>
|
||||
<LI>$p->real_full_path - /var/www/phpgroupware/files/home/jason/dir/file</LI>
|
||||
<LI>$p->real_leading_dirs - /var/www/phpgroupware/files/home/jason/dir
|
||||
<LI>$p->real_full_path - /var/www/egroupware/files/home/jason/dir/file</LI>
|
||||
<LI>$p->real_leading_dirs - /var/www/egroupware/files/home/jason/dir
|
||||
</LI>
|
||||
<LI>$p->real_extra_path - home/jason/dir</LI>
|
||||
<LI>$p->real_name - file</LI>
|
||||
@ -89,7 +89,7 @@ with it using different paths and relativities as we explore relativity.</P>
|
||||
<H2><A NAME="sec:cd"></A> <A NAME="ss3.2">3.2</A> <A HREF="vfs.html#toc3.2">cd ()</A>
|
||||
</H2>
|
||||
|
||||
<P>Part of the overall goal for the VFS in phpGroupWare is to give
|
||||
<P>Part of the overall goal for the VFS in eGroupWare is to give
|
||||
the user a seamless experience during their session. For example,
|
||||
if they upload a file using a file manager to the directory /home/my_group/project1,
|
||||
and then go to download an email attachment, the default directory
|
||||
|
||||
@ -29,7 +29,7 @@ right off the bat to keep things neater.</P>
|
||||
<P>One of the design challenges for a Virtual File System is to
|
||||
try to figure out whether the calling application is referring to
|
||||
a file inside or outside the virtual root, and if inside, exactly
|
||||
where. To solve this problem, the phpGroupWare VFS uses RELATIVE
|
||||
where. To solve this problem, the eGoupWare VFS uses RELATIVE
|
||||
defines that are used in bitmasks passed to each function. The result
|
||||
is that any set of different relativities can be used in combination
|
||||
with each other. Let's look at a few examples. Say you want to move
|
||||
@ -59,12 +59,12 @@ MOVE "$fakebase/jason/logo.png" TO "$fakebase/my_group/project1/logo.png"
|
||||
<P>and the actual file system call would be:</P>
|
||||
<P>
|
||||
<PRE>
|
||||
rename ('/var/www/phpgroupware/files/home/jason/logo.php', '/var/www/phpgroupware/files/home/my_group/project1/logo.png');
|
||||
rename ('/var/www/egroupware/files/home/jason/logo.php', '/var/www/egroupware/files/home/my_group/project1/logo.png');
|
||||
</PRE>
|
||||
</P>
|
||||
<P>Those used to the old VFS will note that you do not have to translate
|
||||
the path beforehand. Let's look at another example. Suppose you were
|
||||
moving an email attachment stored in phpGroupWare's temporary directory
|
||||
moving an email attachment stored in eGoupWare's temporary directory
|
||||
to the 'attachments' directory within the user's home directory (we're
|
||||
assuming the attachments directory exists). Note that the temporary
|
||||
directory is <EM>outside</EM> the virtual root.</P>
|
||||
@ -92,7 +92,7 @@ like this (keep in mind that $randomdir and $randomfile
|
||||
are just random strings):</P>
|
||||
<P>
|
||||
<PRE>
|
||||
rename ('/var/www/phpgroupware/tmp/0ak5adftgh7/jX42sC9M', '/var/www/phpgroupware/files/home/jason/attachments/actual_name.ext');
|
||||
rename ('/var/www/egroupware/tmp/0ak5adftgh7/jX42sC9M', '/var/www/egroupware/files/home/jason/attachments/actual_name.ext');
|
||||
</PRE>
|
||||
</P>
|
||||
<P>Of course you don't have to know that, nor should you be concerned
|
||||
|
||||
@ -15,7 +15,7 @@
|
||||
<H2><A NAME="sec:function_reference"></A> <A NAME="s5">5.</A> <A HREF="vfs.html#toc5">Function reference</A></H2>
|
||||
|
||||
<P>To view the function reference for the VFS, use the doc/inlinedocparser.php
|
||||
script that comes with phpGroupWare, ie
|
||||
script that comes with eGroupWare, ie
|
||||
<A HREF="http://localhost/doc/inlinedocparser.php?fn=class.vfs_sql.inc.php">http://localhost/doc/inlinedocparser.php?fn=class.vfs_sql.inc.php</A>.</P>
|
||||
<HR>
|
||||
<A HREF="vfs-6.html">Next</A>
|
||||
|
||||
@ -33,9 +33,7 @@ quotes, and GLOBALS.</P>
|
||||
<H2><A NAME="ss7.3">7.3</A> <A HREF="vfs.html#toc7.3">Contributing</A>
|
||||
</H2>
|
||||
|
||||
<P>Contributions are always welcome. Please send to the current
|
||||
maintainer, Jason Wies,
|
||||
<A HREF="mailto:zone@phpgroupware.org">zone@phpgroupware.org</A>.</P>
|
||||
<HR>
|
||||
Next
|
||||
<A HREF="vfs-6.html">Previous</A>
|
||||
|
||||
@ -17,7 +17,7 @@ Contents
|
||||
<H2>Jason Wies</H2>June 2001, February 2002
|
||||
<HR>
|
||||
<EM>The VFS, or Virtual File System, handles all file system activity
|
||||
for phpGroupWare.</EM>
|
||||
for eGroupWare.</EM>
|
||||
<HR>
|
||||
<P>
|
||||
<H2><A NAME="toc1">1.</A> <A HREF="vfs-1.html">Introduction and Purpose</A></H2>
|
||||
|
||||
@ -45,7 +45,7 @@ Introduction and Purpose
|
||||
|
||||
\layout Standard
|
||||
|
||||
The latest version of the VFS for phpGroupWare combines actual file system
|
||||
The latest version of the VFS for eGoupWare combines actual file system
|
||||
manipulation with fully integrated database support.
|
||||
It features nearly transparent handling of files and directories, as well
|
||||
as files inside and outside the virtual root.
|
||||
@ -210,10 +210,10 @@ can
|
||||
$GLOBALS['phpgw']->vfs->cp (array(
|
||||
\layout Verbatim
|
||||
|
||||
'from' => '/var/www/phpgroupware/files/home/user/file1',
|
||||
'from' => '/var/www/egroupware/files/home/user/file1',
|
||||
\layout Verbatim
|
||||
|
||||
'to' => '/var/www/phpgroupware/files/home/user/file2',
|
||||
'to' => '/var/www/egroupware/files/home/user/file2',
|
||||
\layout Verbatim
|
||||
|
||||
'relatives' => array(
|
||||
@ -392,10 +392,10 @@ $p->fake_extra_path - home/jason/dir
|
||||
$p->fake_name - file
|
||||
\layout Itemize
|
||||
|
||||
$p->real_full_path - /var/www/phpgroupware/files/home/jason/dir/file
|
||||
$p->real_full_path - /var/www/egroupware/files/home/jason/dir/file
|
||||
\layout Itemize
|
||||
|
||||
$p->real_leading_dirs - /var/www/phpgroupware/files/home/jason/dir
|
||||
$p->real_leading_dirs - /var/www/egroupware/files/home/jason/dir
|
||||
\layout Itemize
|
||||
|
||||
$p->real_extra_path - home/jason/dir
|
||||
@ -430,7 +430,7 @@ cd ()
|
||||
|
||||
\layout Standard
|
||||
|
||||
Part of the overall goal for the VFS in phpGroupWare is to give the user
|
||||
Part of the overall goal for the VFS in eGoupWare is to give the user
|
||||
a seamless experience during their session.
|
||||
For example, if they upload a file using a file manager to the directory
|
||||
/home/my_group/project1, and then go to download an email attachment, the
|
||||
@ -538,7 +538,7 @@ What is it and how does it work?
|
||||
One of the design challenges for a Virtual File System is to try to figure
|
||||
out whether the calling application is referring to a file inside or outside
|
||||
the virtual root, and if inside, exactly where.
|
||||
To solve this problem, the phpGroupWare VFS uses RELATIVE defines that
|
||||
To solve this problem, the eGoupWare VFS uses RELATIVE defines that
|
||||
are used in bitmasks passed to each function.
|
||||
The result is that any set of different relativities can be used in combination
|
||||
with each other.
|
||||
@ -608,14 +608,14 @@ $fakebase/my_group/project1/logo.png
|
||||
and the actual file system call would be:
|
||||
\layout Verbatim
|
||||
|
||||
rename ('/var/www/phpgroupware/files/home/jason/logo.php', '/var/www/phpgroupware
|
||||
rename ('/var/www/egroupware/files/home/jason/logo.php', '/var/www/egroupware
|
||||
/files/home/my_group/project1/logo.png');
|
||||
\layout Standard
|
||||
|
||||
Those used to the old VFS will note that you do not have to translate the
|
||||
path beforehand.
|
||||
Let's look at another example.
|
||||
Suppose you were moving an email attachment stored in phpGroupWare's temporary
|
||||
Suppose you were moving an email attachment stored in eGoupWare's temporary
|
||||
directory to the 'attachments' directory within the user's home directory
|
||||
(we're assuming the attachments directory exists).
|
||||
Note that the temporary directory is
|
||||
@ -668,7 +668,7 @@ outside
|
||||
$randomdir and $randomfile are just random strings):
|
||||
\layout Verbatim
|
||||
|
||||
rename ('/var/www/phpgroupware/tmp/0ak5adftgh7/jX42sC9M', '/var/www/phpgroupware
|
||||
rename ('/var/www/egroupware/tmp/0ak5adftgh7/jX42sC9M', '/var/www/egroupware
|
||||
/files/home/jason/attachments/actual_name.ext');
|
||||
\layout Standard
|
||||
|
||||
@ -878,7 +878,7 @@ Function reference
|
||||
\layout Standard
|
||||
|
||||
To view the function reference for the VFS, use the doc/inlinedocparser.php
|
||||
script that comes with phpGroupWare, ie
|
||||
script that comes with eGoupWare, ie
|
||||
\begin_inset LatexCommand \url[http://localhost/doc/inlinedocparser.php?fn=class.vfs_sql.inc.php]{http://localhost/doc/inlinedocparser.php?fn=class.vfs_sql.inc.php}
|
||||
|
||||
\end_inset
|
||||
@ -1110,7 +1110,7 @@ Contributing
|
||||
|
||||
Contributions are always welcome.
|
||||
Please send to the current maintainer, Jason Wies,
|
||||
\begin_inset LatexCommand \url[zone@phpgroupware.org]{mailto:zone@phpgroupware.org}
|
||||
|
||||
|
||||
\end_inset
|
||||
|
||||
|
||||
@ -13,12 +13,12 @@ June 2001, February 2002
|
||||
</date>
|
||||
<abstract>
|
||||
The VFS, or Virtual File System, handles all file system activity
|
||||
for phpGroupWare.
|
||||
for eGoupWare.
|
||||
</abstract>
|
||||
<sect>
|
||||
Introduction and Purpose<label id="sec:introduction" >
|
||||
<p>
|
||||
The latest version of the VFS for phpGroupWare combines actual
|
||||
The latest version of the VFS for eGoupWare combines actual
|
||||
file system manipulation with fully integrated database support.
|
||||
It features nearly transparent handling of files and directories,
|
||||
as well as files inside and outside the virtual root. This document
|
||||
@ -119,8 +119,8 @@ One of the VFS's responsibilities is to translate paths for you.
|
||||
<p>
|
||||
<verb>
|
||||
$GLOBALS['phpgw']->vfs->cp (array(
|
||||
'from' => '/var/www/phpgroupware/files/home/user/file1',
|
||||
'to' => '/var/www/phpgroupware/files/home/user/file2',
|
||||
'from' => '/var/www/egroupware/files/home/user/file1',
|
||||
'to' => '/var/www/egroupware/files/home/user/file2',
|
||||
'relatives' => array(
|
||||
RELATIVE_NONE|VFS_REAL,
|
||||
RELATIVE_NONE|VFS_REAL
|
||||
@ -229,9 +229,9 @@ Just like you would think, fake_full_path contains the full virtual
|
||||
<item>
|
||||
$p->fake_name - file
|
||||
<item>
|
||||
$p->real_full_path - /var/www/phpgroupware/files/home/jason/dir/file
|
||||
$p->real_full_path - /var/www/egroupware/files/home/jason/dir/file
|
||||
<item>
|
||||
$p->real_leading_dirs - /var/www/phpgroupware/files/home/jason/dir
|
||||
$p->real_leading_dirs - /var/www/egroupware/files/home/jason/dir
|
||||
|
||||
<item>
|
||||
$p->real_extra_path - home/jason/dir
|
||||
@ -251,7 +251,7 @@ As you can see, path_parts () is a very useful function and will
|
||||
<sect1>
|
||||
cd ()<label id="sec:cd" >
|
||||
<p>
|
||||
Part of the overall goal for the VFS in phpGroupWare is to give
|
||||
Part of the overall goal for the VFS in eGoupWare is to give
|
||||
the user a seamless experience during their session. For example,
|
||||
if they upload a file using a file manager to the directory /home/my_group/project1,
|
||||
and then go to download an email attachment, the default directory
|
||||
@ -307,7 +307,7 @@ What is it and how does it work?
|
||||
One of the design challenges for a Virtual File System is to
|
||||
try to figure out whether the calling application is referring to
|
||||
a file inside or outside the virtual root, and if inside, exactly
|
||||
where. To solve this problem, the phpGroupWare VFS uses RELATIVE
|
||||
where. To solve this problem, the eGoupWare VFS uses RELATIVE
|
||||
defines that are used in bitmasks passed to each function. The result
|
||||
is that any set of different relativities can be used in combination
|
||||
with each other. Let's look at a few examples. Say you want to move
|
||||
@ -340,12 +340,12 @@ and the actual file system call would be:
|
||||
</p>
|
||||
<p>
|
||||
<verb>
|
||||
rename ('/var/www/phpgroupware/files/home/jason/logo.php', '/var/www/phpgroupware/files/home/my_group/project1/logo.png');
|
||||
rename ('/var/www/egroupware/files/home/jason/logo.php', '/var/www/egroupware/files/home/my_group/project1/logo.png');
|
||||
</verb>
|
||||
</p><p>
|
||||
Those used to the old VFS will note that you do not have to translate
|
||||
the path beforehand. Let's look at another example. Suppose you were
|
||||
moving an email attachment stored in phpGroupWare's temporary directory
|
||||
moving an email attachment stored in eGoupWare's temporary directory
|
||||
to the 'attachments' directory within the user's home directory (we're
|
||||
assuming the attachments directory exists). Note that the temporary
|
||||
directory is <em>outside</em> the virtual root.
|
||||
@ -375,7 +375,7 @@ Those used to the old VFS will note that you do not have to translate
|
||||
</p>
|
||||
<p>
|
||||
<verb>
|
||||
rename ('/var/www/phpgroupware/tmp/0ak5adftgh7/jX42sC9M', '/var/www/phpgroupware/files/home/jason/attachments/actual_name.ext');
|
||||
rename ('/var/www/egroupware/tmp/0ak5adftgh7/jX42sC9M', '/var/www/egroupware/files/home/jason/attachments/actual_name.ext');
|
||||
</verb>
|
||||
</p><p>
|
||||
Of course you don't have to know that, nor should you be concerned
|
||||
@ -494,7 +494,7 @@ You should notice that no relativity array is needed in the other
|
||||
Function reference<label id="sec:function_reference" >
|
||||
<p>
|
||||
To view the function reference for the VFS, use the doc/inlinedocparser.php
|
||||
script that comes with phpGroupWare, ie <url url="http://localhost/doc/inlinedocparser.php?fn=class.vfs_sql.inc.php" name="http://localhost/doc/inlinedocparser.php?fn=class.vfs_sql.inc.php">.
|
||||
script that comes with eGoupWare, ie <url url="http://localhost/doc/inlinedocparser.php?fn=class.vfs_sql.inc.php" name="http://localhost/doc/inlinedocparser.php?fn=class.vfs_sql.inc.php">.
|
||||
</p>
|
||||
<sect>
|
||||
Notes<label id="sec:notes" >
|
||||
@ -641,7 +641,7 @@ Updated February 2002 to include arrayized parameters, single
|
||||
Contributing
|
||||
<p>
|
||||
Contributions are always welcome. Please send to the current
|
||||
maintainer, Jason Wies, <url url="mailto:zone@phpgroupware.org" name="zone@phpgroupware.org">.
|
||||
maintainer, Jason Wies,
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
Next Previous Contents
|
||||
===============================================================================
|
||||
***** 1. Introduction_and_Purpose *****
|
||||
The latest version of the VFS for phpGroupWare combines actual file system
|
||||
The latest version of the VFS for eGoupWare combines actual file system
|
||||
manipulation with fully integrated database support. It features nearly
|
||||
transparent handling of files and directories, as well as files inside and
|
||||
outside the virtual root. This document is intended to provide API and
|
||||
@ -63,8 +63,8 @@ One of the VFS's responsibilities is to translate paths for you. While you
|
||||
certainly can operate using full paths, it is much simpler to use the virtual
|
||||
paths. For example, instead of using:
|
||||
$GLOBALS['phpgw']->vfs->cp (array(
|
||||
'from' => '/var/www/phpgroupware/files/home/user/file1',
|
||||
'to' => '/var/www/phpgroupware/files/home/user/file2',
|
||||
'from' => '/var/www/egroupware/files/home/user/file1',
|
||||
'to' => '/var/www/egroupware/files/home/user/file2',
|
||||
'relatives' => array(
|
||||
RELATIVE_NONE|VFS_REAL,
|
||||
RELATIVE_NONE|VFS_REAL
|
||||
@ -133,8 +133,8 @@ $p = $GLOBALS['phpgw']->vfs->path_parts (array(
|
||||
* $p->fake_leading_dirs - /home/jason/dir
|
||||
* $p->fake_extra_path - home/jason/dir
|
||||
* $p->fake_name - file
|
||||
* $p->real_full_path - /var/www/phpgroupware/files/home/jason/dir/file
|
||||
* $p->real_leading_dirs - /var/www/phpgroupware/files/home/jason/dir
|
||||
* $p->real_full_path - /var/www/egroupware/files/home/jason/dir/file
|
||||
* $p->real_leading_dirs - /var/www/egroupware/files/home/jason/dir
|
||||
* $p->real_extra_path - home/jason/dir
|
||||
* $p->real_name - file
|
||||
As you can see, path_parts () is a very useful function and will save you from
|
||||
@ -145,7 +145,7 @@ translation, but it is an internal function only. Applications should only use
|
||||
path_parts (). We have shown you how to use path_parts () so you can experiment
|
||||
with it using different paths and relativities as we explore relativity.
|
||||
***** 3.2 cd_() *****
|
||||
Part of the overall goal for the VFS in phpGroupWare is to give the user a
|
||||
Part of the overall goal for the VFS in eGoupWare is to give the user a
|
||||
seamless experience during their session. For example, if they upload a file
|
||||
using a file manager to the directory /home/my_group/project1, and then go to
|
||||
download an email attachment, the default directory will be /home/my_group/
|
||||
@ -192,7 +192,7 @@ to keep things neater.
|
||||
One of the design challenges for a Virtual File System is to try to figure out
|
||||
whether the calling application is referring to a file inside or outside the
|
||||
virtual root, and if inside, exactly where. To solve this problem, the
|
||||
phpGroupWare VFS uses RELATIVE defines that are used in bitmasks passed to each
|
||||
eGoupWare VFS uses RELATIVE defines that are used in bitmasks passed to each
|
||||
function. The result is that any set of different relativities can be used in
|
||||
combination with each other. Let's look at a few examples. Say you want to move
|
||||
'logo.png' from the user's home directory to the current directory.
|
||||
@ -210,11 +210,11 @@ So if the current directory was "$fakebase/my_group/project1", the call to mv
|
||||
() would be processed as:
|
||||
MOVE "$fakebase/jason/logo.png" TO "$fakebase/my_group/project1/logo.png"
|
||||
and the actual file system call would be:
|
||||
rename ('/var/www/phpgroupware/files/home/jason/logo.php', '/var/www/
|
||||
phpgroupware/files/home/my_group/project1/logo.png');
|
||||
rename ('/var/www/egroupware/files/home/jason/logo.php', '/var/www/
|
||||
egroupware/files/home/my_group/project1/logo.png');
|
||||
Those used to the old VFS will note that you do not have to translate the path
|
||||
beforehand. Let's look at another example. Suppose you were moving an email
|
||||
attachment stored in phpGroupWare's temporary directory to the 'attachments'
|
||||
attachment stored in eGoupWare's temporary directory to the 'attachments'
|
||||
directory within the user's home directory (we're assuming the attachments
|
||||
directory exists). Note that the temporary directory is outside the virtual
|
||||
root.
|
||||
@ -235,8 +235,8 @@ as well, to say that the file is outside the virtual root, somewhere else in
|
||||
the file system. Once again, RELATIVE_USER means relative to the user's home
|
||||
directory. So the actual file system call might look like this (keep in mind
|
||||
that $randomdir and $randomfile are just random strings):
|
||||
rename ('/var/www/phpgroupware/tmp/0ak5adftgh7/jX42sC9M', '/var/www/
|
||||
phpgroupware/files/home/jason/attachments/actual_name.ext');
|
||||
rename ('/var/www/egroupware/tmp/0ak5adftgh7/jX42sC9M', '/var/www/
|
||||
egroupware/files/home/jason/attachments/actual_name.ext');
|
||||
Of course you don't have to know that, nor should you be concerned with it; you
|
||||
can take it for granted that the VFS will translate the paths correctly. Let's
|
||||
take a look at one more example, this time using the RELATIVE_USER_APP define.
|
||||
@ -329,7 +329,7 @@ Next Previous Contents
|
||||
===============================================================================
|
||||
***** 5. Function_reference *****
|
||||
To view the function reference for the VFS, use the doc/inlinedocparser.php
|
||||
script that comes with phpGroupWare, ie http://localhost/doc/
|
||||
script that comes with eGoupWare, ie http://localhost/doc/
|
||||
inlinedocparser.php?fn=class.vfs_sql.inc.php.
|
||||
===============================================================================
|
||||
Next Previous Contents
|
||||
@ -420,6 +420,6 @@ Updated February 2002 to include arrayized parameters, single quotes, and
|
||||
GLOBALS.
|
||||
***** 7.3 Contributing *****
|
||||
Contributions are always welcome. Please send to the current maintainer, Jason
|
||||
Wies, zone@phpgroupware.org.
|
||||
Wies,
|
||||
===============================================================================
|
||||
Next Previous Contents
|
||||
|
||||
@ -8,11 +8,11 @@ NAME="GENERATOR"
|
||||
CONTENT="Modular DocBook HTML Stylesheet Version 1.64
|
||||
"><LINK
|
||||
REL="HOME"
|
||||
TITLE=" phpGroupWare XML-RPC/SOAP Methodology
|
||||
TITLE=" eGroupWare XML-RPC/SOAP Methodology
|
||||
"
|
||||
HREF="phpgw_server.html"><LINK
|
||||
REL="PREVIOUS"
|
||||
TITLE=" phpGroupWare XML-RPC/SOAP Methodology
|
||||
TITLE=" eGroupWare XML-RPC/SOAP Methodology
|
||||
"
|
||||
HREF="phpgw_server.html"><LINK
|
||||
REL="NEXT"
|
||||
@ -32,7 +32,7 @@ CELLSPACING="0"
|
||||
><TH
|
||||
COLSPAN="3"
|
||||
ALIGN="center"
|
||||
>phpGroupWare XML-RPC/SOAP Methodology</TH
|
||||
>eGroupWare XML-RPC/SOAP Methodology</TH
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
@ -70,7 +70,7 @@ NAME="AEN33"
|
||||
>Business layer requests</A
|
||||
></H1
|
||||
><P
|
||||
> Once a successful login return packet has been received and sessionid/kp3 have been extracted, every subsequent packet sent to the phpgroupware server must be preceded by an Authorization header. Here is a sample header:
|
||||
> Once a successful login return packet has been received and sessionid/kp3 have been extracted, every subsequent packet sent to the egroupware server must be preceded by an Authorization header. Here is a sample header:
|
||||
</P
|
||||
><TABLE
|
||||
BORDER="0"
|
||||
@ -80,7 +80,7 @@ WIDTH="100%"
|
||||
><TD
|
||||
><PRE
|
||||
CLASS="PROGRAMLISTING"
|
||||
>POST /phpgroupware/xmlrpc.php HTTP/1.0
|
||||
>POST /egroupware/xmlrpc.php HTTP/1.0
|
||||
User-Agent: PHP XMLRPC 1.0
|
||||
Host: my.local.host
|
||||
Authorization: Basic ZDgxNDIyZDRkYjg5NDEyNGNiMzZlMDhhZTdlYzAxZmY6NTU3YzkyYjBmNGE4ZDVlOTUzMzI2YmU2OTQyNjM3YjQ=
|
||||
|
||||
@ -8,7 +8,7 @@ NAME="GENERATOR"
|
||||
CONTENT="Modular DocBook HTML Stylesheet Version 1.64
|
||||
"><LINK
|
||||
REL="HOME"
|
||||
TITLE=" phpGroupWare XML-RPC/SOAP Methodology
|
||||
TITLE=" eGoupWare XML-RPC/SOAP Methodology
|
||||
"
|
||||
HREF="phpgw_server.html"><LINK
|
||||
REL="PREVIOUS"
|
||||
@ -28,7 +28,7 @@ CELLSPACING="0"
|
||||
><TH
|
||||
COLSPAN="3"
|
||||
ALIGN="center"
|
||||
>phpGroupWare XML-RPC/SOAP Methodology</TH
|
||||
>eGoupWare XML-RPC/SOAP Methodology</TH
|
||||
></TR
|
||||
><TR
|
||||
><TD
|
||||
@ -63,7 +63,7 @@ NAME="AEN43"
|
||||
>More to come...</A
|
||||
></H1
|
||||
><P
|
||||
> Documenting every single call will be difficult, but should be done. In leiu of this, please see the class.bo{APPNAME}.inc.php files in each application/inc directory in the phpgroupware cvs. In this file will be a list_methods() function, which returns the information to the server about input/output structure for each call. If the file does not have this function, then it is not yet workable via this interface. As for the actual functions, they are also in this file. Generally, they will all accept associative array input and return same, but not always. This code is in flux, have fun.
|
||||
> Documenting every single call will be difficult, but should be done. In leiu of this, please see the class.bo{APPNAME}.inc.php files in each application/inc directory in the egroupware cvs. In this file will be a list_methods() function, which returns the information to the server about input/output structure for each call. If the file does not have this function, then it is not yet workable via this interface. As for the actual functions, they are also in this file. Generally, they will all accept associative array input and return same, but not always. This code is in flux, have fun.
|
||||
</P
|
||||
></DIV
|
||||
><DIV
|
||||
|
||||
@ -354,12 +354,12 @@ Business layer requests
|
||||
\layout Standard
|
||||
|
||||
Once a successful login return packet has been received and sessionid/kp3
|
||||
have been extracted, every subsequent packet sent to the phpgroupware server
|
||||
have been extracted, every subsequent packet sent to the egroupware server
|
||||
must be preceded by an Authorization header.
|
||||
Here is a sample header:
|
||||
\layout Code
|
||||
|
||||
POST /phpgroupware/xmlrpc.php HTTP/1.0
|
||||
POST /egroupware/xmlrpc.php HTTP/1.0
|
||||
\layout Code
|
||||
|
||||
User-Agent: PHP XMLRPC 1.0
|
||||
|
||||
@ -456,10 +456,10 @@ y(</params>)396 3202 y(</methodResponse>)-2 3876 y Ff(2.)34
|
||||
b(Business)h(la)n(y)o(er)f(requests)396 4044 y Fd(Once)20
|
||||
b(a)h(successful)f(login)f(return)g(pack)o(et)h(has)g(been)g(recei)n(v)
|
||||
o(ed)e(and)i(sessionid/kp3)f(ha)n(v)o(e)g(been)h(e)o(xtracted,)e(e)n(v)
|
||||
o(ery)396 4152 y(subsequent)h(pack)o(et)g(sent)h(to)g(the)g(phpgroupw)o
|
||||
o(ery)396 4152 y(subsequent)h(pack)o(et)g(sent)h(to)g(the)g(egroupw)o
|
||||
(are)c(serv)o(er)j(must)h(be)g(preceded)e(by)h(an)h(Authorization)d
|
||||
(header)-5 b(.)19 b(Here)h(is)396 4259 y(a)h(sample)f(header:)396
|
||||
4440 y Fb(POST)44 b(/phpgroupware/xmlrpc.php)d(HTTP/1.0)396
|
||||
4440 y Fb(POST)44 b(/egroupware/xmlrpc.php)d(HTTP/1.0)396
|
||||
4537 y(User-Agent:)i(PHP)i(XMLRPC)e(1.0)396 4634 y(Host:)h
|
||||
(my.local.host)396 4731 y(Authorization:)f(Basic)h
|
||||
(ZDgxNDIyZDRkYjg5NDEyNGNiMzZlMDhhZTdlYz)o(AxZmY6)o(NTU3Y)o(zkyYjB)o
|
||||
|
||||
@ -171,10 +171,10 @@
|
||||
Business layer requests
|
||||
</title>
|
||||
<para>
|
||||
Once a successful login return packet has been received and sessionid/kp3 have been extracted, every subsequent packet sent to the phpgroupware server must be preceded by an Authorization header. Here is a sample header:
|
||||
Once a successful login return packet has been received and sessionid/kp3 have been extracted, every subsequent packet sent to the egroupware server must be preceded by an Authorization header. Here is a sample header:
|
||||
</para>
|
||||
<programlisting>
|
||||
<![ CDATA [POST /phpgroupware/xmlrpc.php HTTP/1.0
|
||||
<![ CDATA [POST /egroupware/xmlrpc.php HTTP/1.0
|
||||
]]><![ CDATA [User-Agent: PHP XMLRPC 1.0
|
||||
]]><![ CDATA [Host: my.local.host
|
||||
]]><![ CDATA [Authorization: Basic ZDgxNDIyZDRkYjg5NDEyNGNiMzZlMDhhZTdlYzAxZmY6NTU3YzkyYjBmNGE4ZDVlOTUzMzI2YmU2OTQyNjM3YjQ=
|
||||
|
||||
@ -231,10 +231,10 @@ Logout worked:
|
||||
|
||||
Once a successful login return packet has been received and
|
||||
sessionid/kp3 have been extracted, every subsequent packet
|
||||
sent to the phpgroupware server must be preceded by an Authorization
|
||||
sent to the egroupware server must be preceded by an Authorization
|
||||
header. Here is a sample header:
|
||||
|
||||
POST /phpgroupware/xmlrpc.php HTTP/1.0
|
||||
POST /egroupware/xmlrpc.php HTTP/1.0
|
||||
|
||||
User-Agent: PHP XMLRPC 1.0
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user