A => LICENSE +165 -0
@@ 1,165 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+ This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+ 0. Additional Definitions.
+
+ As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+ "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+ An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+ A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+ The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+ The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+ 1. Exception to Section 3 of the GNU GPL.
+
+ You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+ 2. Conveying Modified Versions.
+
+ If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+ a) under this License, provided that you make a good faith effort to
+ ensure that, in the event an Application does not supply the
+ function or data, the facility still operates, and performs
+ whatever part of its purpose remains meaningful, or
+
+ b) under the GNU GPL, with none of the additional permissions of
+ this License applicable to that copy.
+
+ 3. Object Code Incorporating Material from Library Header Files.
+
+ The object code form of an Application may incorporate material from
+a header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+ a) Give prominent notice with each copy of the object code that the
+ Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the object code with a copy of the GNU GPL and this license
+ document.
+
+ 4. Combined Works.
+
+ You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+ a) Give prominent notice with each copy of the Combined Work that
+ the Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
+ document.
+
+ c) For a Combined Work that displays copyright notices during
+ execution, include the copyright notice for the Library among
+ these notices, as well as a reference directing the user to the
+ copies of the GNU GPL and this license document.
+
+ d) Do one of the following:
+
+ 0) Convey the Minimal Corresponding Source under the terms of this
+ License, and the Corresponding Application Code in a form
+ suitable for, and under terms that permit, the user to
+ recombine or relink the Application with a modified version of
+ the Linked Version to produce a modified Combined Work, in the
+ manner specified by section 6 of the GNU GPL for conveying
+ Corresponding Source.
+
+ 1) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (a) uses at run time
+ a copy of the Library already present on the user's computer
+ system, and (b) will operate properly with a modified version
+ of the Library that is interface-compatible with the Linked
+ Version.
+
+ e) Provide Installation Information, but only if you would otherwise
+ be required to provide such information under section 6 of the
+ GNU GPL, and only to the extent that such information is
+ necessary to install and execute a modified version of the
+ Combined Work produced by recombining or relinking the
+ Application with a modified version of the Linked Version. (If
+ you use option 4d0, the Installation Information must accompany
+ the Minimal Corresponding Source and Corresponding Application
+ Code. If you use option 4d1, you must provide the Installation
+ Information in the manner specified by section 6 of the GNU GPL
+ for conveying Corresponding Source.)
+
+ 5. Combined Libraries.
+
+ You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+ a) Accompany the combined library with a copy of the same work based
+ on the Library, uncombined with any other library facilities,
+ conveyed under the terms of this License.
+
+ b) Give prominent notice with the combined library that part of it
+ is a work based on the Library, and explaining where to find the
+ accompanying uncombined form of the same work.
+
+ 6. Revised Versions of the GNU Lesser General Public License.
+
+ The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+ If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
A => README.md +49 -0
@@ 1,49 @@
+# zqlsession
+A custom session store for [scs](https://github.com/alexedwards/scs) using the
+[zombiezen sqlite interface](https://github.com/zombiezen/go-sqlite).
+
+# usage
+```go
+func main() {
+ // Open your database.
+ db, err := sqlitex.NewPool("app.db", nil)
+ if err != nil {
+ log.Fatalln(err)
+ }
+ defer func() {
+ if err := db.Close(); err != nil {
+ log.Fatalln(err)
+ }
+ }()
+
+ // Setup session storage.
+ sessionManager := scs.New()
+ sessionManager.Store = zqlsession.New(db)
+
+ mux := http.NewServeMux()
+ mux.HandleFunc("/put", putHandler)
+ mux.HandleFunc("/get", getHandler)
+
+ // Wrap your handlers with the LoadAndSave() middleware.
+ http.ListenAndServe(":4000", sessionManager.LoadAndSave(mux))
+}
+
+func putHandler(w http.ResponseWriter, r *http.Request) {
+ // Store a new key and value in the session data.
+ sessionManager.Put(r.Context(), "message", "Hello from a session!")
+}
+
+func getHandler(w http.ResponseWriter, r *http.Request) {
+ // Use the GetString helper to retrieve the string value associated with a
+ // key. The zero value is returned if the key does not exist.
+ msg := sessionManager.GetString(r.Context(), "message")
+ io.WriteString(w, msg)
+}
+```
+
+# author
+Written and maintained by Dakota Walsh.
+Up-to-date sources can be found at https://git.sr.ht/~kota/zqlsession/
+
+# license
+GNU LGPL version 3 or later, see LICENSE.
A => go.mod +18 -0
@@ 1,18 @@
+module git.sr.ht/~kota/zqlsession
+
+go 1.20
+
+require zombiezen.com/go/sqlite v1.4.0
+
+require (
+ github.com/dustin/go-humanize v1.0.1 // indirect
+ github.com/google/uuid v1.6.0 // indirect
+ github.com/mattn/go-isatty v0.0.20 // indirect
+ github.com/ncruces/go-strftime v0.1.9 // indirect
+ github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
+ golang.org/x/sys v0.22.0 // indirect
+ modernc.org/libc v1.55.3 // indirect
+ modernc.org/mathutil v1.6.0 // indirect
+ modernc.org/memory v1.8.0 // indirect
+ modernc.org/sqlite v1.33.1 // indirect
+)
A => go.sum +47 -0
@@ 1,47 @@
+github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY=
+github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto=
+github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
+github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
+github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
+github.com/ncruces/go-strftime v0.1.9 h1:bY0MQC28UADQmHmaF5dgpLmImcShSi2kHU9XLdhx/f4=
+github.com/ncruces/go-strftime v0.1.9/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJmn9CehxcKcls=
+github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec h1:W09IVJc94icq4NjY3clb7Lk8O1qJ8BdBEF8z0ibU0rE=
+github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo=
+golang.org/x/mod v0.16.0 h1:QX4fJ0Rr5cPQCF7O9lh9Se4pmwfwskqZfq5moyldzic=
+golang.org/x/mod v0.16.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI=
+golang.org/x/sys v0.22.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
+golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
+golang.org/x/tools v0.19.0 h1:tfGCXNR1OsFG+sVdLAitlpjAvD/I6dHDKnYrpEZUHkw=
+golang.org/x/tools v0.19.0/go.mod h1:qoJWxmGSIBmAeriMx19ogtrEPrGtDbPK634QFIcLAhc=
+modernc.org/cc/v4 v4.21.4 h1:3Be/Rdo1fpr8GrQ7IVw9OHtplU4gWbb+wNgeoBMmGLQ=
+modernc.org/cc/v4 v4.21.4/go.mod h1:HM7VJTZbUCR3rV8EYBi9wxnJ0ZBRiGE5OeGXNA0IsLQ=
+modernc.org/ccgo/v4 v4.19.2 h1:lwQZgvboKD0jBwdaeVCTouxhxAyN6iawF3STraAal8Y=
+modernc.org/ccgo/v4 v4.19.2/go.mod h1:ysS3mxiMV38XGRTTcgo0DQTeTmAO4oCmJl1nX9VFI3s=
+modernc.org/fileutil v1.3.0 h1:gQ5SIzK3H9kdfai/5x41oQiKValumqNTDXMvKo62HvE=
+modernc.org/fileutil v1.3.0/go.mod h1:XatxS8fZi3pS8/hKG2GH/ArUogfxjpEKs3Ku3aK4JyQ=
+modernc.org/gc/v2 v2.4.1 h1:9cNzOqPyMJBvrUipmynX0ZohMhcxPtMccYgGOJdOiBw=
+modernc.org/gc/v2 v2.4.1/go.mod h1:wzN5dK1AzVGoH6XOzc3YZ+ey/jPgYHLuVckd62P0GYU=
+modernc.org/libc v1.55.3 h1:AzcW1mhlPNrRtjS5sS+eW2ISCgSOLLNyFzRh/V3Qj/U=
+modernc.org/libc v1.55.3/go.mod h1:qFXepLhz+JjFThQ4kzwzOjA/y/artDeg+pcYnY+Q83w=
+modernc.org/mathutil v1.6.0 h1:fRe9+AmYlaej+64JsEEhoWuAYBkOtQiMEU7n/XgfYi4=
+modernc.org/mathutil v1.6.0/go.mod h1:Ui5Q9q1TR2gFm0AQRqQUaBWFLAhQpCwNcuhBOSedWPo=
+modernc.org/memory v1.8.0 h1:IqGTL6eFMaDZZhEWwcREgeMXYwmW83LYW8cROZYkg+E=
+modernc.org/memory v1.8.0/go.mod h1:XPZ936zp5OMKGWPqbD3JShgd/ZoQ7899TUuQqxY+peU=
+modernc.org/opt v0.1.3 h1:3XOZf2yznlhC+ibLltsDGzABUGVx8J6pnFMS3E4dcq4=
+modernc.org/opt v0.1.3/go.mod h1:WdSiB5evDcignE70guQKxYUl14mgWtbClRi5wmkkTX0=
+modernc.org/sortutil v1.2.0 h1:jQiD3PfS2REGJNzNCMMaLSp/wdMNieTbKX920Cqdgqc=
+modernc.org/sortutil v1.2.0/go.mod h1:TKU2s7kJMf1AE84OoiGppNHJwvB753OYfNl2WRb++Ss=
+modernc.org/sqlite v1.33.1 h1:trb6Z3YYoeM9eDL1O8do81kP+0ejv+YzgyFo+Gwy0nM=
+modernc.org/sqlite v1.33.1/go.mod h1:pXV2xHxhzXZsgT/RtTFAPY6JJDEvOTcTdwADQCCWD4k=
+modernc.org/strutil v1.2.0 h1:agBi9dp1I+eOnxXeiZawM8F4LawKv4NzGWSaLfyeNZA=
+modernc.org/strutil v1.2.0/go.mod h1:/mdcBmfOibveCTBxUl5B5l6W+TTH1FXPLHZE6bTosX0=
+modernc.org/token v1.1.0 h1:Xl7Ap9dKaEs5kLoOQeQmPWevfnk/DM5qcLcYlA8ys6Y=
+modernc.org/token v1.1.0/go.mod h1:UGzOrNV1mAFSEB63lOFHIpNRUVMvYTc6yu1SMY/XTDM=
+zombiezen.com/go/sqlite v1.4.0 h1:N1s3RIljwtp4541Y8rM880qgGIgq3fTD2yks1xftnKU=
+zombiezen.com/go/sqlite v1.4.0/go.mod h1:0w9F1DN9IZj9AcLS9YDKMboubCACkwYCGkzoy3eG5ik=
A => zqlsession.go +178 -0
@@ 1,178 @@
+// License: LGPL-3.0-only
+// (c) 2024 Dakota Walsh <kota@nilsu.org>
+package zqlsession
+
+import (
+ "context"
+ "log"
+ "time"
+
+ "zombiezen.com/go/sqlite"
+ "zombiezen.com/go/sqlite/sqlitex"
+)
+
+// SQLitexStore represents the session store.
+type SQLitexStore struct {
+ db *sqlitex.Pool
+ stopCleanup chan bool
+}
+
+// New returns a new SQLitexStore instance, with a background cleanup goroutine
+// that runs every 5 minutes to remove expired session data.
+func New(db *sqlitex.Pool) *SQLitexStore {
+ return NewWithCleanupInterval(db, 5*time.Minute)
+}
+
+// NewWithCleanupInterval returns a new SQLitexStore instance. The cleanupInterval
+// parameter controls how frequently expired session data is removed by the
+// background cleanup goroutine. Setting it to 0 prevents the cleanup goroutine
+// from running (i.e. expired sessions will not be removed).
+func NewWithCleanupInterval(db *sqlitex.Pool, cleanupInterval time.Duration) *SQLitexStore {
+ p := &SQLitexStore{db: db}
+ if cleanupInterval > 0 {
+ go p.startCleanup(cleanupInterval)
+ }
+ return p
+}
+
+// Find returns the data for a given session token from the SQLitexStore instance.
+// If the session token is not found or is expired, the returned exists flag will
+// be set to false.
+func (p *SQLitexStore) Find(token string) ([]byte, bool, error) {
+ conn, err := p.db.Take(context.Background())
+ if err != nil {
+ return nil, false, err
+ }
+ defer p.db.Put(conn)
+
+ var found bool
+ var b []byte
+ err = sqlitex.Execute(conn,
+ "SELECT data FROM sessions WHERE token = $1 AND julianday('now') < expiry",
+ &sqlitex.ExecOptions{
+ ResultFunc: func(stmt *sqlite.Stmt) error {
+ found = true
+ b = make([]byte, stmt.ColumnLen(0))
+ stmt.ColumnBytes(0, b)
+ return nil
+ },
+ Args: []any{token},
+ })
+
+ if !found {
+ return nil, false, nil
+ }
+ if err != nil {
+ return nil, false, err
+ }
+ return b, true, nil
+}
+
+// Commit adds a session token and data to the SQLitexStore instance with the
+// given expiry time. If the session token already exists, then the data and expiry
+// time are updated.
+func (p *SQLitexStore) Commit(token string, b []byte, expiry time.Time) error {
+ conn, err := p.db.Take(context.Background())
+ if err != nil {
+ return err
+ }
+ defer p.db.Put(conn)
+
+ err = sqlitex.Execute(conn,
+ "REPLACE INTO sessions (token, data, expiry) VALUES ($1, $2, julianday($3))",
+ &sqlitex.ExecOptions{
+ Args: []any{token, b, expiry.UTC().Format("2006-01-02T15:04:05.999")},
+ })
+ return err
+}
+
+// Delete removes a session token and corresponding data from the SQLitexStore
+// instance.
+func (p *SQLitexStore) Delete(token string) error {
+ conn, err := p.db.Take(context.Background())
+ if err != nil {
+ return err
+ }
+ defer p.db.Put(conn)
+
+ err = sqlitex.Execute(conn, "DELETE FROM sessions WHERE token = $1",
+ &sqlitex.ExecOptions{
+ Args: []any{token},
+ })
+ return err
+}
+
+// All returns a map containing the token and data for all active (i.e.
+// not expired) sessions in the SQLitexStore instance.
+func (p *SQLitexStore) All() (map[string][]byte, error) {
+ conn, err := p.db.Take(context.Background())
+ if err != nil {
+ return nil, err
+ }
+ defer p.db.Put(conn)
+
+ sessions := make(map[string][]byte)
+
+ err = sqlitex.Execute(conn, "SELECT token, data FROM sessions WHERE julianday('now') < expiry",
+ &sqlitex.ExecOptions{
+ ResultFunc: func(stmt *sqlite.Stmt) error {
+ var data []byte
+ var token = stmt.ColumnText(0)
+ data = make([]byte, stmt.ColumnLen(1))
+ stmt.ColumnBytes(1, data)
+ sessions[token] = data
+ return nil
+ },
+ })
+ if err != nil {
+ return nil, err
+ }
+ return sessions, nil
+}
+
+func (p *SQLitexStore) startCleanup(interval time.Duration) {
+ p.stopCleanup = make(chan bool)
+ ticker := time.NewTicker(interval)
+ for {
+ select {
+ case <-ticker.C:
+ err := p.deleteExpired()
+ if err != nil {
+ log.Println(err)
+ }
+ case <-p.stopCleanup:
+ ticker.Stop()
+ return
+ }
+ }
+}
+
+// StopCleanup terminates the background cleanup goroutine for the SQLitexStore
+// instance. It's rare to terminate this; generally SQLitexStore instances and
+// their cleanup goroutines are intended to be long-lived and run for the lifetime
+// of your application.
+//
+// There may be occasions though when your use of the SQLitexStore is transient.
+// An example is creating a new SQLitexStore instance in a test function. In this
+// scenario, the cleanup goroutine (which will run forever) will prevent the
+// SQLitexStore object from being garbage collected even after the test function
+// has finished. You can prevent this by manually calling StopCleanup.
+func (p *SQLitexStore) StopCleanup() {
+ if p.stopCleanup != nil {
+ p.stopCleanup <- true
+ }
+}
+
+func (p *SQLitexStore) deleteExpired() error {
+ conn, err := p.db.Take(context.Background())
+ if err != nil {
+ return err
+ }
+ defer p.db.Put(conn)
+
+ return sqlitex.Execute(
+ conn,
+ "DELETE FROM sessions WHERE expiry < julianday('now')",
+ nil,
+ )
+}