Client side of a tool for reading and writing the lcm staff logs (both admins and 150). Requests are sent via ssh using user's account.
The GET
method is called with the -g
option and is used to print all the logs that meet the required criteria.
The POST
method is called with the -p
option and is used to add a log to the database. Accented characters are allowed and automatically transformed using quotation marks or backticks.
The UPDATE
method is called with the -u
option and is used to regenerate the internal server database. It should only be called if a log file is added by hand, or if some of the log files get renamed or corrupted. It assumes that all the log files are correctly formatted. CURRENTLY NOT WORKING.
To choose the server to communicate with, ssh uses a config file located in ~/.config/lcmlog
. The configuration file is named config
and is a ssh config file: so, for more help, refer to ssh_config manuals (i.e. run man ssh_config
on your terminal).
The script always checks if the config file exist: if false, it asks you if you want to generate it. Here the config file template generated by the program (~/.config/lcmlog/config
):
# lcmlog config file
# Write this file as a ssh_config file.
# For more info, run the command 'man ssh_config'.
# Host is 'server': do not change the name.
Host server
HostName
# User and Port parameters should be used only out of the lcm cluster.
#User
#Port
After the generation, you should edit the file and add the correct HostName
(and eventually also User
and Port
). This script automatically open the config file after its generation using nano
editor.
You can't use this program until the config file is generated in the default folder (~/.config/lcmlog
).
The default editor is nano
. If you want to use another editor, currently you have to edit the source code and change the variable EDITOR
. In a future update, this customization will be included in the configuration file.
[ ] Implement custom editor in the configuration file.
[ ] Implement the UPDATE
method