 |
||||
| The following variables can be inserted into anywhere in the RaidenFTPD events message files (message/*.msg) , and the physical path , virtual path , owner , group columns in the virtual filesystem files (*.vfs) , or even can be inserted into event triggers lines in the *.ftpd file , ex: onFileUploaded= | ||||
|
user
information variables
|
||||
|
var
|
description
|
.msg
|
.vfs
|
|
| %S | name of logged in user |
Y
|
Y
|
|
| %z | name of logged in user (left aligned with padding spaces up to 14 chars , do not use in *.vfs) |
Y
|
N
|
|
| %g | user's group (primary) |
Y
|
Y
|
|
| %/ | user's group (all groups , if user is in multi groups) |
Y
|
N
|
|
| %Z | user's group (left aligned with padding spaces up to 14 chars , do not use in *.vfs) |
Y
|
N
|
|
| %Y | user's tag line ( comment line , all spaces are replaced by %20 , do not use in *.vfs) |
Y
|
N
|
|
| %T | user's tag line ( comment line , left aligned with padding spaces up to 25 chars , do not use in *.vfs) |
Y
|
N
|
|
| %d | number of bytes downloaded in the current session |
Y
|
N
|
|
| %p | number of bytes uploaded in the current session |
Y
|
N
|
|
| %v | last download speed (kb/sec) |
Y
|
N
|
|
| %V | last upload speed (kb/sec) |
Y
|
N
|
|
| %x | history downloaded mega bytes |
Y
|
N
|
|
| %X | history uploaded mega bytes |
Y
|
N
|
|
| %w | history downloaded kilo bytes |
Y
|
N
|
|
| %W | history uploaded kilo bytes |
Y
|
N
|
|
| %C | user's credit (mega bytes) |
Y
|
N
|
|
| %c | user's credit (kilo bytes) |
Y
|
N
|
|
| %i | the IP address from which the user is logged in |
Y
|
N
|
|
| %D | the user's idle time |
Y
|
N
|
|
| %E | user's ratio (1:x or unlimited) |
Y
|
N
|
|
| %e | current directory |
Y
|
N
|
|
| %P | password of anonymous user (usually email address) , this will be empty value for normal users |
Y
|
N
|
|
| %$ | the user's leve , 0-4 0=root , 1=super , 2=normal , 3=guest |
Y
|
N
|
|
|
system
information variables
|
||||
|
var
|
description
|
.msg
|
.vfs
|
|
| %h | server's name |
Y
|
N
|
|
| %u | server's up time ( HH : MM : SS ) format |
Y
|
N
|
|
| %y | string of today ( ex: 0707 for July 7th ) |
Y
|
Y
|
|
| %U | server's startup time ( YYYY/MM/DD HH:MM ) |
Y
|
N
|
|
| %t | current date and time |
Y
|
N
|
|
| %N | maximum number of anonymous and registered users |
Y
|
N
|
|
| %n | number of users logged in (anonymous and registered) |
Y
|
N
|
|
| %f | free disk space under current virtual path ( not including virtual mount points ) |
Y
|
N
|
|
| %I | max allowed connections from the same IP |
Y
|
N
|
|
| %o | server output byte status |
Y
|
N
|
|
| %l | server input byte status |
Y
|
N
|
|
| %b | success files count in current *.sfv or *.md5 lists |
Y
|
N
|
|
| %> | the current uploaded file's crc32 value (only available for onSfvSuccess/onSfvFailed events) |
Y
|
N
|
|
| %R | files count in *.sfv or *.md5 files |
Y
|
N
|
|
| %^ | the current physical path where the client is staying inside |
Y
|
N
|
|
| %H | the virtual dir/file name which the client just accessed (or accessing)by RETR/STOR/MKD/RMD and site nuke , however all space characters are converted to %20 |
Y
|
N
|
|
| %r | the virtual dir/file name which the client just accessed (or accessing)by RETR/STOR/MKD/RMD and site nuke/move |
Y
|
N
|
|
| %m | the full physical dir/file name which the client just accessed (or accessing)by RETR/STOR/MKD/RMD and site move |
Y
|
N
|
|
| %G | the full physical dir/file name which the client just accessed (or accessing)by RETR/STOR/MKD/RMD , however all space characters are converted to %20 |
Y
|
N
|
|
| %q | the full physical path name (short path name) which the client just accessed (or accessing) by RETR/STOR command |
Y
|
N
|
|
| %= | the filename (short path name) which the client just accessed (or accessing) by RETR/STOR command |
Y
|
N
|
|
| %Q | the filename (short path name) which the client just accessed (or accessing) by RETR/STOR command |
Y
|
N
|
|
| %- | the filepath (short path name) which the client just accessed (or accessing) by RETR/STOR command , without the file name |
Y
|
N
|
|
| %+ | the file extension of the file which the client just accessed (or accessing) by RETR/STOR command |
Y
|
N
|
|
| %M | the filesize (in kilobytes) of the file which the client just accessed (or accessing) by RETR/STOR , or the target directory size for site move command |
Y
|
N
|
|
| %F | the reason of the directory just got nuked by site nuke command |
Y
|
N
|
|
| %j | the multiplier of the directory just got nuked by site nuke command |
Y
|
N
|
|
| %O | the reason of the file being marked as a dupe file (a file that already existed in this virtual file system) |
Y
|
N
|
|
| %L | Mp3 ID3 tag's song title , if the last file being uploaded is a mp3 file (30 chars with space appended) |
Y
|
N
|
|
| %k | Mp3 ID3 tag's artist name , if the last file being uploaded is a mp3 file (30 chars with space appended) |
Y
|
N
|
|
| %K | Mp3 ID3 tag's album name , if the last file being uploaded is a mp3 file (30 chars with space appended) |
Y
|
N
|
|
| %a | Mp3 header's bit rate , if the last file being uploaded is a mp3 file (10 chars with space appended) |
Y
|
N
|
|
| %J | Mp3 ID3 tag's year , if the last file being uploaded is a mp3 file (4 chars with space appended) |
Y
|
N
|
|
| %A | Mp3 header's sampling frequency , if the last file being uploaded is a mp3 file (8 chars with space appended) |
Y
|
N
|
|
| %B | Mp3 ID3 tag's genre , if the last file being uploaded is a mp3 file (32 chars with space appended) |
Y
|
N
|
|
| %s | Mp3 ID3 tag's genre , if the last file being uploaded is a mp3 file (32 chars with space appended) , however all space characters are converted to %20 |
Y
|
N
|
|
| %! | Whole string for site command , not including 'site' itself , this variable is for use with onSiteCmd event only |
Y
|
N
|
|
| %~ | user's domain name (maybe empty) |
Y
|
N
|
|
| %* | nuked user when executing site nuke command |
Y
|
N
|
|
| %@ | Global unique client ID , a 32 bit number translated to string , can be used to identify ftp client object , see here |
Y
|
N
|
|
| %& | number of online people downloading , evaluated on RETR/STOR/APPE commands |
Y
|
N
|
|
| %( | number of online people uploading , evaluated on RETR/STOR/APPE commands |
Y
|
N
|
|
| %) | number of logins downloading under this user name , evaluated on RETR/STOR/APPE commands |
Y
|
N
|
|
| %_ | number of logins uploading under this user name , evaluated on RETR/STOR/APPE commands |
Y
|
N
|
|
| %| | number of logins downloading under this group name , evaluated on RETR/STOR/APPE commands |
Y
|
N
|
|
| %\ | number of logins uploading under this group name , evaluated on RETR/STOR/APPE commands |
Y
|
N
|
|
|
system
functions ( must be placed in the beginning of a line )
|
||||
|
var
|
description
|
.msg
|
.vfs
|
|
| %0 | output the latest 10 directories made on this server |
Y
|
N
|
|
| %1 | output the top 10 uploaders on this server |
Y
|
N
|
|
| %2 | output the top 10 downloaders on this server |
Y
|
N
|
|
| %3 | output the current user's detail information |
Y
|
N
|
|
| %4 | output the currently online users list |
Y
|
N
|
|
| %5 | output the directory info of the current virtual directory , the directory info contains files , total file size , uploaders/groups information of the current virtual directory |
Y
|
N
|
|
| %# |
output another *.msg file in /message dir , ex : %#site-help.msg , this will include the content of /message/site-help.msg into current *.msg file |
Y
|
N
|
|
|
other
variables
|
||||
|
var
|
description
|
.msg
|
.vfs
|
|
| %% | percent character |
Y
|
N
|
|
Copyright © RaidenFTPD TEAM , ALL RIGHT RESERVED
REVISION 2.2 , 2002/06/12