Synchronet v3.19b-Win32 (install) has been released (Jan-2022).

You can donate to the Synchronet project using PayPal.

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
module:logonlist [2019/10/30 12:35] – [Format] mention HTTP logons supported in list digital manmodule:logonlist [2024/07/17 13:25] (current) – [Configure] Add time_fmt digital man
Line 3: Line 3:
 The Logon List module (''[[dir:exec]]/logonlist.js'') is responsible for displaying and maintaining the list of BBS logons. It uses the ''logonlist_lib.js'' library to store/retrieve logon information in JSON Lines (''.jsonl'') format. The Logon List module (''[[dir:exec]]/logonlist.js'') is responsible for displaying and maintaining the list of BBS logons. It uses the ''logonlist_lib.js'' library to store/retrieve logon information in JSON Lines (''.jsonl'') format.
  
 +{{:module:logonlist.png?600|}}
 ===== Format ===== ===== Format =====
 The new ''[[dir:data]]/logon.jsonl'' file replaces the functionality of the old (but still supported/maintained) ''[[dir:data]]/logon.lst'' file. The new ''[[dir:data]]/logon.jsonl'' file replaces the functionality of the old (but still supported/maintained) ''[[dir:data]]/logon.lst'' file.
Line 8: Line 9:
 The advantages of the new format include: The advantages of the new format include:
   - Standard file format   - Standard file format
-  - Easily parseable by scripts/programs (especially JS)+  - Easily parse-able by scripts/programs (especially JS)
   - Supports non-terminal protocol logons (e.g. HTTP/HTTPS)   - Supports non-terminal protocol logons (e.g. HTTP/HTTPS)
   - No display-style (e.g. colors) embedded in the file   - No display-style (e.g. colors) embedded in the file
  
 +**Note:**\\
 +While the ''LastFewCallersFmt'' line in the ''[[dir:ctrl]]/[[custom:text.dat]]'' file is still used to generate the legacy ''logon.lst'' file, the ''modopts.ini'' file is used to customize the format/color used to display the new ''logon.jsonl'' file by ''logonlist.js''. See below for details.
 ===== Files ===== ===== Files =====
   * The current day's logons are stored in ''[[dir:data]]/logon.jsonl''   * The current day's logons are stored in ''[[dir:data]]/logon.jsonl''
Line 17: Line 20:
   * The logons from 2-days ago are stored in ''[[dir:data]]/logon.1.jsonl''   * The logons from 2-days ago are stored in ''[[dir:data]]/logon.1.jsonl''
   * etc...   * etc...
 +
 +The logon list files are normally maintained/rotated daily via an invocation of "?logonlist -m" (e.g. in [[util:SCFG]]->External Programs->Fixed Events->Daily Event).
  
 ===== Install =====  ===== Install ===== 
-To install the Logon List module, execute from a command-line: +This module (''logonlist'') should be the default value of SCFG->System->Loadable Modules->List Logons.
-  jsexec logonlist install+
  
 +If a sysop needs to install this module, it can be installed with the command-line ''[[util:jsexec]] logonlist install''.
 ===== Invoke ===== ===== Invoke =====
 +The default behavior of the Logon List module (when no command-line options are provided) is to display all user logons that have been logged so far today, in the order in which they were logged (normally, by the [[module:logon|Logon Module]]).
 +
 The Logon List module supports the following command-line options: The Logon List module supports the following command-line options:
  
 ^ Option  ^ Description ^ ^ Option  ^ Description ^
-| ''-l'' | Display only the "last few" logons (callers), the default is to display the entire list | +| ''-l //[count]//'' | Display only the "last few" logons (callers), possibly over multiple days | 
-| ''-y'' | Display logons from yesterday rather than today | +| ''-y'' | Display all logons that occurred yesterday | 
-| ''-m'' | Maintain the Logon List files, must be executed daily, e.g. via "System Timed Event" |+| ''//days//'' | Display all logons from the specified number of days ago | 
 +| ''-m'' | Maintain the Logon List files, must be executed daily, e.g. via "System Daily Event" or Timed Event |
  
 ===== Configure ===== ===== Configure =====
Line 43: Line 51:
 | ''backup_level''     | 10      | Number of previous logon list files to retain | | ''backup_level''     | 10      | Number of previous logon list files to retain |
 | ''today''            | "Today" | The word displayed to represent the current day | | ''today''            | "Today" | The word displayed to represent the current day |
-| ''yesterday''        | "Yesterday | The word to displayed to represent the day before the current day | +| ''yesterday''        | "Yesterday | The word displayed to represent the day before the current day | 
 +| ''time_fmt''         | "%H:%M" | The [[https://cplusplus.com/reference/ctime/strftime/|strftime]] format of the logon date/time to be displayed |
 ===== See Also ===== ===== See Also =====
   * [[:module:|module index]]   * [[:module:|module index]]

Trace: