Synchronet v3.16c-Win32 (install) has been released (Aug-2015).

You can donate to the Synchronet project using PayPal.

Tickit

Tickit (exec/tickit.js) is a simple incoming TICK (TIC File) processor for Synchronet.

It is configured via the file: ctrl/tickit.ini

In a recent change to SBBSecho/EchoCfg v3 and tickit.js, the TIC file password for each FTN-linked node is now stored in the TicFilePwd key of the corresponding [node] section of the sbbsecho.ini file and can be managed via AreaFix and via echocfg.

Setup

You should create an event to run it when you get .TIC files…

Internal Code                   TICKIT    
Start-up Directory                        
Command Line                    ?tickit.js
Enabled                         Yes       
Execution Node                  1         
Execution Months                Any       
Execution Days of Month         Any       
Execution Days of Week          None      
Execution Time                  00:00     
Requires Exclusive Execution    No        
Force Users Off-line For Event  No        
Native Executable               No        
Use Shell to Execute            No        
Background Execution            No        
Always Run After Init/Re-init   No        

For BinkD, use a line like this to create the semaphore file:

flag /synchronet/sbbs/data/tickit.now *.tic *.TIC

BinkIT automatically runs the TICKIT event when a TIC file is received.

Configuration

ctrl/tickit.ini

Global Options

The following global options are used by TickIT:

  • Path Default local path to store files in. If this is set, the file will NOT be imported into a local sub.
  • Dir Default BBS file directory internal code to store files in. addfiles will be called to import the file.
  • Links Comma-separated list of FTN addresses to forward *all* files to.
  • IgnorePassword Set to true to ignore the password in the TIC file along with the packet password for the node. This will allow anyone who can send a TIC file to your board to overwrite files in your file bases, so should be used with caution (and only used with SecureOnly).
  • SecureOnly Set to true to only import TIC files from the secure inbound.
  • Handler Set to the filename of a handler script as defined below.
  • HandlerArg a string that is passed to the handler function.

Path and Dir cannot be used together.

Sections

Each section is a FDN area. This must match the AREA tag in the TIC file. Each area supports the following options:

  • Path Local path to store files in. If this is set, the file will NOT be imported into a local sub.
  • Dir BBS file directory internal code to store files in. addfiles will be called to import the file.
  • Links Comma-separated list of FTN addresses to forward the files to.
  • Handler Set to the filename of a handler script as defined below. If present, this overrides the global Handler, they do not both run.
  • HandlerArg a string that is passed to the handler function.

Handler Scripts

TIC files can be passed to a handler for special processing. The handler is declared in a separate JS file which must not have a null last statement. If the handler returns a true value, the TIC file is assumed to have been processed and no further import actions are taken. A simple “do-nothing” handler script would be as follows:

function Handle_TIC(tic, ctx, arg)
{
    // Do nothing...
    return false;
}
 
0;

If the script returns true, it must ensure that tic.full_path is updated to the path where the unmodified file can be found to ensure it can be transferred to downlinks. If the handler wants to avoid it being sent to downlinks, it can stuff all the downlink addresses into the tic.seenby array like this:

function Handle_TIC(tic, ctx, arg)
{
    if (blackhole(tic)) {
        ctx.tickit.gcfg.links.forEach(function(link) {
            tic.seenby.push(link);
        });
        ctx.tickit.acfg[tic.area.toLowerCase()].links.forEach(function(link) {
            tic.seenby.push(link);
        });
        return true;
    }
    return false;
}
 
0;

Included Handler Scripts

There are some TIC handler scripts in CVS now. They live in the exec/load/tickit directory.

nodelist_handler.js

This handler script is for keeping nodelists up to date. The HandlerArg is a JSON string containing a domain and optionally a filespec for the received file and for the nodelist file in the archive, as well as a return code. It uses the configured packers from sbbsecho.ini/sbbsecho.cfg, so ensure that the archiver used is defined there. It returns false so the file can also be processed normally (ie: imported into your local file area), and is forwarded to downlinks normally.

Here is my tickit.ini entry:

[DAILYLIST]
Dir=DAILYLIST
Handler=tickit/nodelist_handler.js
HandlerArg={"domain":"fidonet", "match"="NODELIST.Z*", "nlmatch"="nodelist.*"}

This means that the Fido file area “DAILYLIST”, files are imported into my BBS file area “DAILYLIST”, and the tickit/nodelist_handler.js file contains the handler for this area. The handler is passed all of the available arguments.

  • domain the FTN domain this is the nodelist for. This value is required.
  • match the filespec for nodelist archives in this area. If the incoming file doesn't match this, the nodelist is not updated. This defaults to '*.*' on Windows and '*' everywhere else.
  • nlmatch the filespec for the nodelist file inside the archive. There must be exactly one file matching this filespec inside the archive, or the nodelist will not be updated. . This defaults to '*.*' on Windows and '*' everywhere else.

See Also


In Other Languages
Translations of this page:
QR Code
QR Code Tickit (generated for current page)