32cd2100d9dd11140705c848850e86c4f79191c4
max
Tue Sep 1 07:02:04 2026 -0700
Reusable "view snapshot" sessions for durable, minimal Share-a-link links
"Share a link" could only share the whole cart: it saved a session holding
every track, setting and position, which bloated the central db and leaked
the sharer's unrelated tracks to whoever opened the link. Anonymous share
sessions (under the reserved user "l") were also never reaped, so they
accumulated forever, and their 8-char names were generated client-side with
no uniqueness check, so two shares could collide and silently overwrite.
Adds a lightweight "snapshot session" facility (lib/snapshotSession.c): a
snapshot stores only the handful of cart variables a feature declares (a
registered snapshotType, e.g. "blat" -> {db, blatLastBigBed}), moves only
those variables' trash files into durable sessionData storage, and is saved
under a "__"-prefixed name. The "__" marks it machine-made: hidden from the
My Sessions list by default and eligible for reaping. For the anonymous "l"
owner the durable files fan out over two extra hash levels so one directory
never fills with millions of entries.
Every anonymous link now shares one server-side name generator
(snapshotNewName): a unique (db-checked), crypto-strong, "__"-prefixed token,
so tokens never collide. The hgSession doSaveSessionJson endpoint gained
hgS_snapshotType (save a minimal snapshot rather than the whole cart) and
hgS_doAnonName (reserve a unique anonymous name without saving, so the
top-right dialog can preview the exact link before it is created).
Wired three callers to the facility:
- hgc htcBlatAlign "Share a link": a minimal "blat" snapshot instead of a
full-cart anonymous session.
- hgBlat results "Share a link": creates a "blat" snapshot on click and
reveals its ?u=&s= reopen link (rebuilt from the durable bigPsl by the
existing doShareReopen), replacing the trash-only reveal.
- top-right "Share a link": anonymous links use the reserved server name;
logged-in named shares are unchanged.
snapshotReaper (hg/utils) garbage-collects abandoned anonymous snapshots: it
deletes user "l" "__" rows whose lastUse is older than the TTL (hg.conf
snapshot.ttlDays, default ~4 years) and removes their durable files. lastUse
is bumped on every open by the existing session load, so a link stays alive
as long as it is used. Meant to run from the trash-cleaner cron.
Also folds in the recent Share-dialog work in these files: the auto share
name is a short "_" prefix instead of "share_", the dialog previews the link
and creates it only when the button is clicked (no orphan session just from
opening the dialog), an optional name field with an overwrite warning, and
the anonymous save path forces the reap-eligible "__" name.
refs #38197
diff --git src/hg/inc/sessionData.h src/hg/inc/sessionData.h
index 2c2a1a248c6..15129352ccd 100644
--- src/hg/inc/sessionData.h
+++ src/hg/inc/sessionData.h
@@ -1,21 +1,25 @@
/* sessionData - functions for moving user data out of trash into permanent storage
*
* Copyright (C) 2019-2024 The Regents of the University of California
* See kent/LICENSE or http://genome.ucsc.edu/license/ for licensing information. */
#ifndef SESSIONDATA_H
#define SESSIONDATA_H
char *sessionDataSaveTrashFile(char *trashPath, char *sessionDir);
/* If trashPath exists and is not already a soft-link to sessionDir, alloc and return a new path in
* sessionDir; move trashPath to new path and soft-link from trashPath to new path.
* If trashPath is already a soft-link, return the path that it links to.
* Return NULL if trashPath does not exist (can happen with expired custom track files). */
+char *sessionDirFromNames(char *sessionDataDir, char *encUserName, char *encSessionName);
+/* Alloc and return the per-session data directory under sessionDataDir (hashed by user and session
+ * name), or NULL if sessionDataDir is empty. errAborts if sessionDataDir is not an absolute path. */
+
void sessionDataSaveSession(struct cart *cart, char *encUserName, char *encSessionName,
char *dbSuffix);
/* If hg.conf specifies safe places to store files and/or tables that belong to user sessions,
* then scan cart for trashDir files and/or customTrash tables, store them in safe locations,
* and update cart to point to the new locations. */
#endif // SESSIONDATA_H