cstimer-save-server

README

A simple userscript -> local server which saves my http://cstimer.net data every time I open cstimer in my browser

The userscript runs the underlying javascript export code whenever I open cstimer, and then POSTs it to localhost:8553, which the server receives and then writes to a file

Requires:

• go https://go.dev/
• a userscript manager. If you don't already have a userscript manager, I recommend Violentmonkey

To run:

• install the userscript from here, (or manually install it from cstimer_auto_download.js)
• go install 'github.com/seanbreckenridge/cstimer-save-server@latest
• Run cstimer-save-server in the background somewhere:

cstimer-save-server -save-to ~/Documents/cstimer

That saves to ~/Documents/cstimer/cstimer.json

$ cstimer-save-server -help
usage: cstimer-save-server [FLAG...]

  -port int
    	port to serve server on (default 8553)
  -save-to string
    	path to save datafile to.
  -timestamped
    	instead of writing to the same 'cstimer.json' file, write to a new file each time

Now whenever you open https://cstimer.net/, it should save your current solves to a local file:

$ cstimer-save-server -save-to . -timestamped
2022/10/16 10:20:53 cstimer-save-server saving to '.' on port 8553
2022/10/16 10:20:55 Saving data to '1665940855868.json'
2022/10/16 10:20:56 Saving data to '1665940856882.json'

If you have a port conflict, change the PORT variable in cstimer_auto_download.js, and supply the -port flag to change what port the server launches on

auth

I would recommend setting up Authentication for this, so no random application/service can hit the server endpoint, saving arbitrary data to the -save-to directory.

To do that set the const SECRET in the userscript (cstimer_auto_download.js) to something, e.g.:

const SECRET = "Rszhs3b24La87401";

Typically you can edit the userscript with the extension icon when on the page.

Then launch the server with that key:

CSTIMER_SECRET="Rszhs3b24La87401" cstimer-save-server -save-to .

local cstimer server

I run cstimer locally using this script, which means it doesn't run on cstimer.net, but localhost:4633. The cstimer_auto_download_personal.js script contains an additional match and redirect for that, as an example

bleanser

I use the -timestamp flag, which means the directory this saves to gets pretty large pretty quickly. To remove duplicate/'useless' data, I have a bleanser (backup cleanser) module which removes any files which don't include any new/unique data:

[ ~ ] $ python3 -m bleanser_sean.modules.cstimer prune ~/data/cubing/cstimer --remove --yes
[INFO    2022-10-16 10:57:04 bleanser.core.common main.py:144] processing 4 files (/home/sean/data/cubing/cstimer/1665942943939.json ... /home/sean/data/cubing/cstimer/1665943018015.json)
[INFO    2022-10-16 10:57:04 bleanser.core.common processor.py:95] using 1 workers
[INFO    2022-10-16 10:57:04 bleanser.core.common processor.py:373] processing /home/sean/data/cubing/cstimer/1665942943939.json (0/4)
[DEBUG   2022-10-16 10:57:04 bleanser.core.common processor.py:387] cleanup(/home/sean/data/cubing/cstimer/1665942943939.json): took 0.01 seconds
[INFO    2022-10-16 10:57:04 bleanser.core.common processor.py:373] processing /home/sean/data/cubing/cstimer/1665942944781.json (1/4)
[DEBUG   2022-10-16 10:57:04 bleanser.core.common processor.py:387] cleanup(/home/sean/data/cubing/cstimer/1665942944781.json): took 0.01 seconds
[INFO    2022-10-16 10:57:04 bleanser.core.common processor.py:373] processing /home/sean/data/cubing/cstimer/1665943017337.json (2/4)
[DEBUG   2022-10-16 10:57:04 bleanser.core.common processor.py:387] cleanup(/home/sean/data/cubing/cstimer/1665943017337.json): took 0.01 seconds
[INFO    2022-10-16 10:57:04 bleanser.core.common processor.py:373] processing /home/sean/data/cubing/cstimer/1665943018015.json (3/4)
[DEBUG   2022-10-16 10:57:04 bleanser.core.common processor.py:387] cleanup(/home/sean/data/cubing/cstimer/1665943018015.json): took 0.01 seconds
[DEBUG   2022-10-16 10:57:04 bleanser.core.common processor.py:468] emitting group pivoted on ['/home/sean/data/cubing/cstimer/1665942943939.json', '/home/sean/data/cubing/cstimer/1665943018015.json'], size 4
[DEBUG   2022-10-16 10:57:04 bleanser.core.common processor.py:1015] 0  /4   /home/sean/data/cubing/cstimer/1665942943939.json : Keep
[DEBUG   2022-10-16 10:57:04 bleanser.core.common processor.py:1015] 1  /4   /home/sean/data/cubing/cstimer/1665942944781.json : Prune
[DEBUG   2022-10-16 10:57:04 bleanser.core.common processor.py:1015] 2  /4   /home/sean/data/cubing/cstimer/1665943017337.json : Prune
[DEBUG   2022-10-16 10:57:04 bleanser.core.common processor.py:1015] 3  /4   /home/sean/data/cubing/cstimer/1665943018015.json : Keep
[INFO    2022-10-16 10:57:04 bleanser.core.common processor.py:1076] processing    0/   4 /home/sean/data/cubing/cstimer/1665942943939.json : will keep          ; pruned so far:    0 Mb /   0 Mb ,   0 /  1 files
[INFO    2022-10-16 10:57:04 bleanser.core.common processor.py:1076] processing    1/   4 /home/sean/data/cubing/cstimer/1665942944781.json : REMOVE             ; pruned so far:    0 Mb /   0 Mb ,   1 /  2 files
[INFO    2022-10-16 10:57:04 bleanser.core.common processor.py:1076] processing    2/   4 /home/sean/data/cubing/cstimer/1665943017337.json : REMOVE             ; pruned so far:    0 Mb /   0 Mb ,   2 /  3 files
[INFO    2022-10-16 10:57:04 bleanser.core.common processor.py:1076] processing    3/   4 /home/sean/data/cubing/cstimer/1665943018015.json : will keep          ; pruned so far:    0 Mb /   0 Mb ,   2 /  4 files
[INFO    2022-10-16 10:57:04 bleanser.core.common processor.py:1078] SUMMARY: pruned so far:    0 Mb /   0 Mb ,   2 /  4 files
[INFO    2022-10-16 10:57:04 bleanser.core.common processor.py:1122] rm /home/sean/data/cubing/cstimer/1665942944781.json
[INFO    2022-10-16 10:57:04 bleanser.core.common processor.py:1122] rm /home/sean/data/cubing/cstimer/1665943017337.json