d7dd4f55e28699bb783563b8bece5bf23f392995 chmalee Wed May 13 11:07:57 2026 -0700 Adds hg.conf myVariantsDataDir for writing ctfiles outside trash/, per-db short/long label rename on hgTrackUi, and a shared removal helper so the hgTrackUi remove button, hgTracks trash icon, and hgCustom checkbox all function the same, refs #33808 diff --git src/hg/inc/myVariants.h src/hg/inc/myVariants.h index 9ccd82e17a3..c7cc409d698 100644 --- src/hg/inc/myVariants.h +++ src/hg/inc/myVariants.h @@ -1,150 +1,166 @@ #ifndef MYVARIANTS_H #define MYVARIANTS_H #include "jksql.h" #include "asParse.h" #include "common.h" #include "cart.h" +#include "customTrack.h" #define MYVARIANTS_NUM_COLS 17 /* number of default columns before any user-added custom columns */ struct myVariants /* An item in a myVariants type track. */ { struct myVariants *next; /* Next in singly linked list. */ unsigned bin; /* Bin for range index */ char *chrom; /* Reference sequence chromosome or scaffold */ unsigned chromStart; /* Start position in chromosome */ unsigned chromEnd; /* End position in chromosome */ char *name; /* Name of item - up to 16 chars */ unsigned score; /* 0-1000. Higher numbers are darker. */ char strand[2]; /* + or - for strand */ unsigned thickStart; /* Start of thick part */ unsigned thickEnd; /* End position of thick part */ unsigned itemRgb; /* RGB 8 bits each as in bed */ char *description; /* Longer item description */ char *db; /* database name of this annotation */ char *ref; /* reference allele */ char *alt; /* alternate allele */ char *project; /* project name for grouping variants */ char *mouseover; /* short mouseover text for hover display */ unsigned id; /* Unique ID for item */ struct slPair *customFields; /* user-defined custom field name/value pairs */ }; void myVariantsStaticLoad(char **row, struct myVariants *ret); /* Load a row from myVariants table into ret. The contents of ret will be replaced at the next call to this function. */ struct myVariants *myVariantsLoadByQuery(struct sqlConnection *conn, char *query); /* Load all myVariants from table that satisfy the query given. Dispose of this with myVariantsFreeList(). */ void myVariantsSaveToDb(struct sqlConnection *conn, struct myVariants *el, char *tableName, int updateSize); /* Save myVariants as a row to the table specified by tableName. * Uses explicit column names so custom fields in el->customFields are included. * If el->name is NULL or empty, fills it in post-INSERT as "Variant N" using * the row's auto-increment id; sqlLastAutoId wraps MariaDB's mysql_insert_id, * which is per-connection and unaffected by concurrent INSERTs on other * connections. */ struct myVariants *myVariantsLoad(char **row); /* Load a myVariants from row fetched with select * from myVariants from database. Dispose of this with myVariantsFree(). */ struct myVariants *myVariantsLoadAll(char *fileName); /* Load all myVariants from whitespace-separated file. Dispose of this with myVariantsFreeList(). */ struct myVariants *myVariantsLoadAllByChar(char *fileName, char chopper); /* Load all myVariants from chopper separated file. Dispose of this with myVariantsFreeList(). */ #define myVariantsLoadAllByTab(a) myVariantsLoadAllByChar(a, '\t'); /* Load all myVariants from tab separated file. Dispose of this with myVariantsFreeList(). */ struct myVariants *myVariantsCommaIn(char **pS, struct myVariants *ret); /* Create a myVariants out of a comma separated string. This will fill in ret if non-null, otherwise will return a new myVariants */ void myVariantsFree(struct myVariants **pEl); /* Free a single dynamically allocated myVariants such as created with myVariantsLoad(). */ void myVariantsFreeList(struct myVariants **pList); /* Free a list of dynamically allocated myVariants's */ void myVariantsOutput(struct myVariants *el, FILE *f, char sep, char lastSep); /* Print out myVariants. Separate fields with sep. Follow last field with lastSep. */ #define myVariantsTabOut(el,f) myVariantsOutput(el,f,'\t','\n'); #define myVariantsCommaOut(el,f) myVariantsOutput(el,f,',',','); struct asObject *myVariantsAsObj(); /* Return asObject describing fields of myVariants */ char *myVariantsGetDatabaseForUser(char *userName); /* Hash the userName and map it to 1..31 inclusive for deciding what * database the table should be created in */ char *myVariantsGetTableName(char *userName); /* Create the table for this users' myVariants */ char *myVariantsGetDbTable(char *userName); /* Return the string db.tableName based on the userName for use in sql statements * without specifying the database */ char *myVariantsTableExists(char *userName); /* See if we already have a table for this user. If so, return the name * of the table (in db.tableName format), else NULL */ char *myVariantsCreateTable(char *userName); /* Return TRUE if the myVariants table for userName exists or we can create it. Return FALSE on an error */ char *myVariantsResolveDbTableForCustomTrack(char *trackName, struct cart *cart); /* For a custom-track name of the form "myVariants_*", return the fully * qualified SQL table (db.tableName) holding the items. Handles both own * tracks and shared tracks. For shared tracks, revalidates the share against * hgcentral; returns NULL if the share has been revoked, downgraded out of * scope, or is not for the current user. */ struct myVariantsShare; struct myVariantsShare *myVariantsResolveSharedTrack(char *trackName, struct cart *cart); /* For a "myVariants_shared_*" custom-track name, look up and revalidate the * share record from hgcentral. Returns NULL if the track is not a shared * track, the cart cookie is missing, the share has been revoked, or the * current user is not authorized (target user mismatch). The returned share * carries the validated owner/db/project/permission; callers should use these * (not the cart-supplied values) for authorization or scoping decisions. * Caller frees with myVariantsShareFree. */ char *myVariantsSharedScopeWhere(char *trackName, struct cart *cart); /* For a "myVariants_shared_*" custom-track, return a SQL WHERE-clause * fragment that limits a query to the share's authorized project and db * (e.g. "db='hg38' and project='Variants'", or "db='hg38'" alone when the * share's project is "*"). Returns NULL for non-shared tracks or revoked * shares. Memoized per-process: callers receive a fresh cloneString that * they own. */ void myVariantsStripHiddenFields(struct slName **pFieldList); /* Remove any field whose name starts with "_hidden_" from the list in place. * Handles bare names ("_hidden_foo") and dotted/qualified names * ("db.table._hidden_foo") by checking the segment after the last '.'. * Used by hgTables for myVariants_shared_* tables so a recipient does not * see columns the owner has hidden. (Custom non-hidden columns are kept, * since they are part of the data the owner intentionally shared.) */ void myVariantsDeleteForDb(char *userName, char *targetDb); /* Delete the user's myVariants items for the given assembly. No-op if the * table doesn't exist. */ +void myVariantsUnlinkCtFile(char *userName, char *targetDb); +/* Delete the on-disk ctfile for this user+assembly if it exists. Uses the + * same path resolution as myVariantsWriteCtFile so it targets either the + * persistent dir (myVariantsDataDir) or the trash fallback. */ + +boolean myVariantsHandleCtRemoval(struct customTrack *ct, struct cart *cart, + char *database); +/* If ct is a myVariants own track: delete the user's rows for the current + * assembly, unlink the persistent ctfile, drop the per-db renamed labels + * and the visibility var. If ct is a myVariants shared track: drop the + * share-acceptance cart var and the visibility var. Returns TRUE when ct + * was a myVariants track and this function fully handled the cart cleanup + * (caller must skip its own per-track cart cleanup so other-assembly + * labels are preserved); FALSE otherwise. */ + char *myVariantsWriteCtFile(char *userName, char *targetDb, struct cart *cart); /* Write a CT file to trash for user's myVariants in targetDb and any shared tracks * found in cart. Return filename or NULL if nothing to write. */ struct slName *myVariantsGetProjects(char *userName); /* Return list of distinct non-empty project values for this user's myVariants table. * Caller must slFreeList the result. Returns NULL if no projects or table doesn't exist. */ struct slName *myVariantsGetCustomFields(char *userName); /* Return list of user-added custom column names for this user's myVariants table. * Skips the first MYVARIANTS_NUM_COLS default columns and filters out _hidden_ prefixed columns. * Caller must slFreeList the result. Returns NULL if no custom fields or table doesn't exist. */ struct slName *myVariantsGetHiddenFields(char *userName); /* Return list of hidden custom column names (with _hidden_ prefix stripped) for this user's * myVariants table. Caller must slFreeList the result. Returns NULL if none. */ #endif /* MYVARIANTS_H */