storage.au3 - localStorage and sessionStorage

[Jefrey 65]

Needed a way to store global temporary & permanent information and came up with this.

This is inspired by NodeJS's store and store2 packages, as well as W3 specs' localStorage and sessionStorage, offering multiple ways of usage.

This is not related to any browser's storage, nor will allow you to access or modify browsers storage - although this is possible and not a hard task, this is not what this UDF is intended to do.

This UDF offers functions for temporary storage (that gets cleaned up once the application is shutdown) that is kept on memory using ScriptingDictionary, as well as for permanent storage, that is saved on the harddisk as an encrypted file.

sessionStorage (temporary storage)

It's useful to keep application state and temporary settings accessible by any part of your script (although it could also be done with a global variable, I still prefer this method).

You have multiple ways, at your choice, to:

; add or modify a key
sessionStorage("foo", "bar")
store("foo", "bar")
sessionStorage_set("foo", "bar")
sessionStorage_setItem("foo", "bar")

; read a key (returns false if key does not exist)
$read = sessionStorage("foo")
$read = store("foo")
$read = sessionStorage_get("foo")
$read = sessionStorage_getItem("foo")

; delete a key
sessionStorage_remove("foo")

; delete all keys
sessionStorage_clear()
sessionStorage_clearAll()

localStorage (permanent storage)

It's useful to store user-defined settings.

; initialize
; this is optional, but allows you to control
; how things are going to be saved
localStorage_startup([file where you want the settings to be saved], [crypt password])
; by default, if not supplied, if supplied the "Default" keyword (or if you dont initialize),
; the file will be a random-named file (based on @ScriptFullPath) at user's %APPDATA%
; and the password will also be based on @ScriptFullPath
; you can set only the crypt password if you want:
; localStorage_startup(Default, "mypassword")

; the usage is the same as sessionStorage

; add or modify a key
localStorage("foo", "bar")
store2("foo", "bar") ; notice the '2'
localStorage_set("foo", "bar")
localStorage_setItem("foo", "bar")

; read a key (returns false if key does not exist)
$read = localStorage("foo")
$read = store2("foo")
$read = localStorage_get("foo")
$read = localStorage_getItem("foo")

; delete a key
localStorage_remove("foo")

; delete all keys
localStorage_clear()
localStorage_clearAll()

Download

Edited March 24, 2018 by Jefrey

[Bilgus 147]

Interesting Idea have you done any speed comparisons between global variables and using your method (once initialized)?

I like the Idea of being able to save / load the whole shebang  encrypted in one shot

Edited March 24, 2018 by Bilgus