Difference between revisions of "HFS: Event scripts"

From rejetto wiki
Jump to: navigation, search
(Network events)
(Network events)
Line 17: Line 17:
 
== Events list ==  
 
== Events list ==  
 
=== Network events ===
 
=== Network events ===
 +
; server start : HFS was switched on, to accept connections.
 +
; server stop : HFS was switched off, connections are accepted no more.
 
; request : an HTTP request has been made, this includes browsing, icons, archives, and normal downloads.
 
; request : an HTTP request has been made, this includes browsing, icons, archives, and normal downloads.
 
; request completed : the request was fulfilled.
 
; request completed : the request was fulfilled.
; download : a download was requested.
 
; download completed : a download has just finished.
 
 
; unauthorized : this user has no permission to access the requested resource.
 
; unauthorized : this user has no permission to access the requested resource.
; server start : HFS was switched on, to accept connections.
 
; server stop : HFS was switched off, connections are accepted no more.
 
 
; connected : a new connection was established by a client.
 
; connected : a new connection was established by a client.
 
; disconnected : a connection is ended.
 
; disconnected : a connection is ended.
 +
; download : a download was requested.
 +
; download completed : a download has just finished.
 
; upload completed : a file has been uploaded.
 
; upload completed : a file has been uploaded.
 
; upload failed : a file has failed to be uploaded.
 
; upload failed : a file has failed to be uploaded.

Revision as of 14:13, 25 July 2009

Warning: this feature requires version 2.3 or above.

Event scripts are scripts that run when something happens: an event.

The syntax is very similar to the one used in templates. The name of the event is on a line, surrounded by [square brakets]. The script commands follows.

Example:

[upload completed]
{.move|%item-resource%|C:\another_folder\%item-name%.}

Would you need to not overwrite an existing event script, you can prefix the event name with a "+" sign. Example: [+upload completed].

You can read more on the forum.

Events list

Network events

server start 
HFS was switched on, to accept connections.
server stop 
HFS was switched off, connections are accepted no more.
request 
an HTTP request has been made, this includes browsing, icons, archives, and normal downloads.
request completed 
the request was fulfilled.
unauthorized 
this user has no permission to access the requested resource.
connected 
a new connection was established by a client.
disconnected 
a connection is ended.
download 
a download was requested.
download completed 
a download has just finished.
upload completed 
a file has been uploaded.
upload failed 
a file has failed to be uploaded.
file deleted 
a file has been deleted.

Naming events

You can use these events to change the name that will be given to the file that is about to be uploaded or downloaded.

upload name
archive name
download name

Other events

start 
HFS was started.
quit 
HFS is quitting.
file deleted 
a file was remotely deleted. Use %item-deleted% to know the full path to it.

Timed events

You can ask HFS to run a script at a certain time, or interval.

To run a script at 1PM o'clock, you can make an event [at 13:00].

To run every 15 minutes instead you should make an event [every 15 minutes].

You can read more on the forum.