Events Manager Plug-in - Events Variable Usage Chart

The following chart lists what variables can be used with each event. Only variables charted with a YES will work with the associated variable. All variables are CASE-SENSITIVE. A description of what each variable does is provided after the chart.

EVENT

            VARIABLES                
  %FILE %FILE_8.3 %FILENAME %FILENAME_8.3 %FILEEXT %FILENOEXT %FILEPATH %FILEPATH_8.3 %FILESIZE %DATE %TIME %USERNAME %USERGROUP %USERIP %USERPASS
ON ADMIN MESSAGE                   YES YES  YES YES YES YES
ON DIR CREATED YES YES         YES YES    YES YES YES YES YES YES
ON DIR DELETED YES YES         YES YES    YES YES YES YES YES YES
ON EVERY 5 MINUTES                   YES YES           
ON EVERY DAY                    YES YES           
ON EVERY HOUR                    YES YES           
ON FILE DELETED YES YES YES YES YES YES YES YES YES YES YES YES YES YES YES
ON FILE DOWNLOADED YES YES YES YES YES YES YES YES YES YES YES YES YES YES YES
ON FILE RENAMED YES YES YES YES YES YES YES YES YES YES YES YES YES YES YES
ON FILE UPLOADED YES YES YES YES YES YES YES YES YES YES YES YES YES YES YES
ON FILE UPLOADED FAILED YES YES YES YES YES YES YES YES YES YES YES YES YES YES YES
ON SAME IP CONNECT                   YES YES YES YES YES YES
ON SERVER CLOSED                   YES YES        
ON SERVER STARTED                   YES YES        
ON SERVER STOPPED                   YES YES        
ON TOO MANY USERS                   YES YES YES YES YES YES
ON USER & PASS                   YES YES         
ON USER DISCONNECT                   YES YES YES YES YES YES
ON USER HAMMERING                   YES YES     YES  
ON USER IS BANNED                   YES YES     YES  
ON USER TIME OUT                   YES YES YES YES YES YES
ON WELCOME USER                   YES YES YES YES YES YES

VARIABLES DESCRIPTIONS:

%FILE - Complete path to file, including the filename

%FILE_8.3 - Same as %FILE, but in the 8.3 path format

%FILENAME - Only the filename

%FILENAME_8.3 - Same as %FILENAME, but in the 8.3 path format

%FILEEXT - Extension of the file in uppercase

%FILENOEXT - Filename without the extension

%FILEPATH - The path to the file, without the filename

%FILEPATH_8.3 - Same as %FILEPATH, but in the 8.3 path format

%FILESIZE - The size of the file in bytes

%DATE - Current date in xx.xx.xx [ Month.Day.Year ] format

%TIME - Current time in xx.xx.xx [ Hour.Minute.Seconds ] format

%USERNAME - The user account

%USERGROUP - The group name the user is a member of

%USERIP - The user's IP address

%USERPASS - The password the user supplied via the FTP client

EXAMPLES:  
** WE WELCOME MORE EXAMPLES. EMAIL US AT guildftpd@ztnet.com **

OnFileUpload: c: \myad\ upload.bat %FILEEXT %FILE

REM Contents of  Upload.bat

IF "%1"==".RAR" GOTO RARFILE
IF "%1"==".ZIP" GOTO ZIPFILE
GOTO QUIT
:RARFILE
c:\rar\rar.exe a %2 c:\myad\ad.txt
GOTO QUIT
:ZIPFILE
c:\pkzip\pkzip.exe -a %2 c:\myad\ad.txt
GOTO QUIT
:QUIT

END Contents

OnEveryDay: c: \evryday.bat %DATE

REM Contents of evrydat.bat

c:
cd\
md "uploads_for_%1"
xcopy c: \myuploadsdirectory c: \uploads_for_%1

END Contents

This will put all the uploads into separate directories for each day... i.e. c: \uploads_for_09.02.01