/*
** Copyright (c) 2010 D. Richard Hipp
**
** This program is free software; you can redistribute it and/or
** modify it under the terms of the Simplified BSD License (also
** known as the "2-Clause License" or "FreeBSD License".)
** This program is distributed in the hope that it will be useful,
** but without any warranty; without even the implied warranty of
** merchantability or fitness for a particular purpose.
**
** Author contact information:
** drh@sqlite.org
**
*******************************************************************************
**
** This file contains code used to implement the "stash" command.
*/
#include "config.h"
#include "stash.h"
#include <assert.h>
/*
** SQL code to implement the tables needed by the stash.
*/
static const char zStashInit[] =
@ CREATE TABLE IF NOT EXISTS %s.stash(
@ stashid INTEGER PRIMARY KEY, -- Unique stash identifier
@ vid INTEGER, -- The baseline check-out for this stash
@ comment TEXT, -- Comment for this stash. Or NULL
@ ctime TIMESTAMP -- When the stash was created
@ );
@ CREATE TABLE IF NOT EXISTS %s.stashfile(
@ stashid INTEGER REFERENCES stash, -- Stash that contains this file
@ rid INTEGER, -- Baseline content in BLOB table or 0.
@ isAdded BOOLEAN, -- True if this is an added file
@ isRemoved BOOLEAN, -- True if this file is deleted
@ isExec BOOLEAN, -- True if file is executable
@ isLink BOOLEAN, -- True if file is a symlink
@ origname TEXT, -- Original filename
@ newname TEXT, -- New name for file at next check-in
@ delta BLOB, -- Delta from baseline. Content if rid=0
@ PRIMARY KEY(origname, stashid)
@ );
@ INSERT OR IGNORE INTO vvar(name, value) VALUES('stash-next', 1);
;
/*
** Add zFName to the stash given by stashid. zFName might be the name of a
** file or a directory. If a directory, add all changed files contained
** within that directory.
*/
static void stash_add_file_or_dir(int stashid, int vid, const char *zFName){
char *zFile; /* Normalized filename */
char *zTreename; /* Name of the file in the tree */
Blob fname; /* Filename relative to root */
Blob sql; /* Query statement text */
Stmt q; /* Query against the vfile table */
Stmt ins; /* Insert statement */
zFile = mprintf("%/", zFName);
file_tree_name(zFile, &fname, 1);
zTreename = blob_str(&fname);
blob_zero(&sql);
blob_appendf(&sql,
"SELECT deleted, isexe, islink, mrid, pathname, coalesce(origname,pathname)"
" FROM vfile"
" WHERE vid=%d AND (chnged OR deleted OR origname NOT NULL OR mrid==0)",
vid
);
if( fossil_strcmp(zTreename,".")!=0 ){
blob_appendf(&sql,
" AND (pathname GLOB '%q/*' OR origname GLOB '%q/*'"
" OR pathname=%Q OR origname=%Q)",
zTreename, zTreename, zTreename, zTreename
);
}
db_prepare(&q, blob_str(&sql));
blob_reset(&sql);
db_prepare(&ins,
"INSERT INTO stashfile(stashid, rid, isAdded, isRemoved, isExec, isLink,"
"origname, newname, delta)"
"VALUES(%d,:rid,:isadd,:isrm,:isexe,:islink,:orig,:new,:content)",
stashid
);
while( db_step(&q)==SQLITE_ROW ){
int deleted = db_column_int(&q, 0);
int rid = db_column_int(&q, 3);
const char *zName = db_column_text(&q, 4);
const char *zOrig = db_column_text(&q, 5);
char *zPath = mprintf("%s%s", g.zLocalRoot, zName);
Blob content;
int isNewLink = file_wd_islink(zPath);
db_bind_int(&ins, ":rid", rid);
db_bind_int(&ins, ":isadd", rid==0);
db_bind_int(&ins, ":isrm", deleted);
db_bind_int(&ins, ":isexe", db_column_int(&q, 1));
db_bind_int(&ins, ":islink", db_column_int(&q, 2));
db_bind_text(&ins, ":orig", zOrig);
db_bind_text(&ins, ":new", zName);
if( rid==0 ){
/* A new file */
if( isNewLink ){
blob_read_link(&content, zPath);
}else{
blob_read_from_file(&content, zPath);
}
db_bind_blob(&ins, ":content", &content);
}else if( deleted ){
blob_zero(&content);
db_bind_null(&ins, ":content");
}else{
/* A modified file */
Blob orig;
Blob disk;
if( isNewLink ){
blob_read_link(&disk, zPath);
}else{
blob_read_from_file(&disk, zPath);
}
content_get(rid, &orig);
blob_delta_create(&orig, &disk, &content);
blob_reset(&orig);
blob_reset(&disk);
db_bind_blob(&ins, ":content", &content);
}
db_bind_int(&ins, ":islink", isNewLink);
db_step(&ins);
db_reset(&ins);
fossil_free(zPath);
blob_reset(&content);
}
db_finalize(&ins);
db_finalize(&q);
fossil_free(zFile);
blob_reset(&fname);
}
/*
** Create a new stash based on the uncommitted changes currently in
** the working directory.
**
** If the "-m" or "--comment" command-line option is present, gather
** its argument as the stash comment.
**
** If files are named on the command-line, then only stash the named
** files.
*/
static int stash_create(void){
const char *zComment; /* Comment to add to the stash */
int stashid; /* ID of the new stash */
int vid; /* Current checkout */
zComment = find_option("comment", "m", 1);
verify_all_options();
stashid = db_lget_int("stash-next", 1);
db_lset_int("stash-next", stashid+1);
vid = db_lget_int("checkout", 0);
vfile_check_signature(vid, 0, 0);
db_multi_exec(
"INSERT INTO stash(stashid,vid,comment,ctime)"
"VALUES(%d,%d,%Q,julianday('now'))",
stashid, vid, zComment
);
if( g.argc>3 ){
int i;
for(i=3; i<g.argc; i++){
stash_add_file_or_dir(stashid, vid, g.argv[i]);
}
}else{
stash_add_file_or_dir(stashid, vid, g.zLocalRoot);
}
return stashid;
}
/*
** Apply a stash to the current check-out.
*/
static void stash_apply(int stashid, int nConflict){
Stmt q;
db_prepare(&q,
"SELECT rid, isRemoved, isExec, isLink, origname, newname, delta"
" FROM stashfile WHERE stashid=%d",
stashid
);
while( db_step(&q)==SQLITE_ROW ){
int rid = db_column_int(&q, 0);
int isRemoved = db_column_int(&q, 1);
int isExec = db_column_int(&q, 2);
int isLink = db_column_int(&q, 3);
const char *zOrig = db_column_text(&q, 4);
const char *zNew = db_column_text(&q, 5);
char *zOPath = mprintf("%s%s", g.zLocalRoot, zOrig);
char *zNPath = mprintf("%s%s", g.zLocalRoot, zNew);
Blob delta;
undo_save(zNew);
blob_zero(&delta);
if( rid==0 ){
db_ephemeral_blob(&q, 6, &delta);
blob_write_to_file(&delta, zNPath);
file_wd_setexe(zNPath, isExec);
fossil_print("ADD %s\n", zNew);
}else if( isRemoved ){
fossil_print("DELETE %s\n", zOrig);
file_delete(zOPath);
}else{
Blob a, b, out, disk;
int isNewLink = file_wd_islink(zOPath);
db_ephemeral_blob(&q, 6, &delta);
if( isNewLink ){
blob_read_link(&disk, zOPath);
}else{
blob_read_from_file(&disk, zOPath);
}
content_get(rid, &a);
blob_delta_apply(&a, &delta, &b);
if( isLink == isNewLink && blob_compare(&disk, &a)==0 ){
if( isLink || isNewLink ){
file_delete(zNPath);
}
if( isLink ){
symlink_create(blob_str(&b), zNPath);
}else{
blob_write_to_file(&b, zNPath);
}
file_wd_setexe(zNPath, isExec);
fossil_print("UPDATE %s\n", zNew);
}else{
int rc;
if( isLink || isNewLink ){
rc = -1;
blob_zero(&b); /* because we reset it later */
fossil_print("***** Cannot merge symlink %s\n", zNew);
}else{
rc = merge_3way(&a, zOPath, &b, &out);
blob_write_to_file(&out, zNPath);
blob_reset(&out);
file_wd_setexe(zNPath, isExec);
}
if( rc ){
fossil_print("CONFLICT %s\n", zNew);
nConflict++;
}else{
fossil_print("MERGE %s\n", zNew);
}
}
blob_reset(&a);
blob_reset(&b);
blob_reset(&disk);
}
blob_reset(&delta);
if( fossil_strcmp(zOrig,zNew)!=0 ){
undo_save(zOrig);
file_delete(zOPath);
}
}
db_finalize(&q);
if( nConflict ){
fossil_print(
"WARNING: %d merge conflicts - see messages above for details.\n",
nConflict);
}
}
/*
** Show the diffs associate with a single stash.
*/
static void stash_diff(
int stashid,
const char *zDiffCmd,
const char *zBinGlob,
int fIncludeBinary,
u64 diffFlags
){
Stmt q;
Blob empty;
blob_zero(&empty);
db_prepare(&q,
"SELECT rid, isRemoved, isExec, isLink, origname, newname, delta"
" FROM stashfile WHERE stashid=%d",
stashid
);
while( db_step(&q)==SQLITE_ROW ){
int rid = db_column_int(&q, 0);
int isRemoved = db_column_int(&q, 1);
int isLink = db_column_int(&q, 3);
int isBin1, isBin2;
const char *zOrig = db_column_text(&q, 4);
const char *zNew = db_column_text(&q, 5);
char *zOPath = mprintf("%s%s", g.zLocalRoot, zOrig);
Blob delta;
if( rid==0 ){
db_ephemeral_blob(&q, 6, &delta);
fossil_print("ADDED %s\n", zNew);
diff_print_index(zNew, diffFlags);
isBin1 = fIncludeBinary ? 0 : looks_like_binary(blob_str(&empty),
blob_size(&empty));
isBin2 = fIncludeBinary ? 0 : looks_like_binary(blob_str(&delta),
blob_size(&delta));
diff_file_mem(&empty, &delta, isBin1, isBin2, zNew, zDiffCmd,
zBinGlob, fIncludeBinary, diffFlags);
}else if( isRemoved ){
fossil_print("DELETE %s\n", zOrig);
if( file_wd_islink(zOPath) ){
blob_read_link(&delta, zOPath);
}else{
blob_read_from_file(&delta, zOPath);
}
diff_print_index(zNew, diffFlags);
isBin1 = fIncludeBinary ? 0 : looks_like_binary(blob_str(&delta),
blob_size(&delta));
isBin2 = fIncludeBinary ? 0 : looks_like_binary(blob_str(&empty),
blob_size(&empty));
diff_file_mem(&delta, &empty, isBin1, isBin2, zOrig, zDiffCmd,
zBinGlob, fIncludeBinary, diffFlags);
}else{
Blob a, b, disk;
int isOrigLink = file_wd_islink(zOPath);
db_ephemeral_blob(&q, 6, &delta);
if( isOrigLink ){
blob_read_link(&disk, zOPath);
}else{
blob_read_from_file(&disk, zOPath);
}
fossil_print("CHANGED %s\n", zNew);
if( !isOrigLink != !isLink ){
diff_print_index(zNew, diffFlags);
diff_print_filenames(zOrig, zNew, diffFlags);
printf(DIFF_CANNOT_COMPUTE_SYMLINK);
}else{
content_get(rid, &a);
blob_delta_apply(&a, &delta, &b);
isBin1 = fIncludeBinary ? 0 : looks_like_binary(blob_str(&disk),
blob_size(&disk));
isBin2 = fIncludeBinary ? 0 : looks_like_binary(blob_str(&b),
blob_size(&b));
diff_file_mem(&disk, &b, isBin1, isBin2, zNew, zDiffCmd,
zBinGlob, fIncludeBinary, diffFlags);
blob_reset(&a);
blob_reset(&b);
}
blob_reset(&disk);
}
blob_reset(&delta);
}
db_finalize(&q);
}
/*
** Drop the indicated stash
*/
static void stash_drop(int stashid){
db_multi_exec(
"DELETE FROM stash WHERE stashid=%d;"
"DELETE FROM stashfile WHERE stashid=%d;",
stashid, stashid
);
}
/*
** If zStashId is non-NULL then interpret is as a stash number and
** return that number. Or throw a fatal error if it is not a valid
** stash number. If it is NULL, return the most recent stash or
** throw an error if the stash is empty.
*/
static int stash_get_id(const char *zStashId){
int stashid = 0;
if( zStashId==0 ){
stashid = db_int(0, "SELECT max(stashid) FROM stash");
if( stashid==0 ) fossil_fatal("empty stash");
}else{
stashid = atoi(zStashId);
if( !db_exists("SELECT 1 FROM stash WHERE stashid=%d", stashid) ){
fossil_fatal("no such stash: %d\n", stashid);
}
}
return stashid;
}
/*
** COMMAND: stash
**
** Usage: %fossil stash SUBCOMMAND ARGS...
**
** fossil stash
** fossil stash save ?-m COMMENT? ?FILES...?
** fossil stash snapshot ?-m COMMENT? ?FILES...?
**
** Save the current changes in the working tree as a new stash.
** Then revert the changes back to the last check-in. If FILES
** are listed, then only stash and revert the named files. The
** "save" verb can be omitted if and only if there are no other
** arguments. The "snapshot" verb works the same as "save" but
** omits the revert, keeping the check-out unchanged.
**
** fossil stash list ?--detail?
** fossil stash ls ?-l?
**
** List all changes sets currently stashed. Show information about
** individual files in each changeset if --detail or -l is used.
**
** fossil stash pop
** fossil stash apply ?STASHID?
**
** Apply STASHID or the most recently create stash to the current
** working check-out. The "pop" command deletes that changeset from
** the stash after applying it but the "apply" command retains the
** changeset.
**
** fossil stash goto ?STASHID?
**
** Update to the baseline checkout for STASHID then apply the
** changes of STASHID. Keep STASHID so that it can be reused
** This command is undoable.
**
** fossil stash drop ?STASHID? ?--all?
** fossil stash rm ?STASHID? ?--all?
**
** Forget everything about STASHID. Forget the whole stash if the
** --all flag is used. Individual drops are undoable but --all is not.
**
** fossil stash diff ?STASHID?
** fossil stash gdiff ?STASHID?
**
** Show diffs of the current working directory and what that
** directory would be if STASHID were applied.
*/
void stash_cmd(void){
const char *zDb;
const char *zCmd;
int nCmd;
int stashid;
undo_capture_command_line();
db_must_be_within_tree();
db_open_config(0);
db_begin_transaction();
zDb = db_name("localdb");
db_multi_exec(zStashInit, zDb, zDb);
if( g.argc<=2 ){
zCmd = "save";
}else{
zCmd = g.argv[2];
}
nCmd = strlen(zCmd);
if( memcmp(zCmd, "save", nCmd)==0 ){
stashid = stash_create();
undo_disable();
if( g.argc>=2 ){
int nFile = db_int(0, "SELECT count(*) FROM stashfile WHERE stashid=%d",
stashid);
char **newArgv = fossil_malloc( sizeof(char*)*(nFile+2) );
int i = 2;
Stmt q;
db_prepare(&q,"SELECT origname FROM stashfile WHERE stashid=%d", stashid);
while( db_step(&q)==SQLITE_ROW ){
newArgv[i++] = mprintf("%s%s", g.zLocalRoot, db_column_text(&q, 0));
}
db_finalize(&q);
newArgv[0] = g.argv[0];
g.argv = newArgv;
g.argc = nFile+2;
if( nFile==0 ) return;
}
g.argv[1] = "revert";
revert_cmd();
}else
if( memcmp(zCmd, "snapshot", nCmd)==0 ){
stash_create();
}else
if( memcmp(zCmd, "list", nCmd)==0 || memcmp(zCmd, "ls", nCmd)==0 ){
Stmt q, q2;
int n = 0;
int fDetail = find_option("detail","l",0)!=0;
verify_all_options();
db_prepare(&q,
"SELECT stashid, (SELECT uuid FROM blob WHERE rid=vid),"
" comment, datetime(ctime) FROM stash"
" ORDER BY ctime DESC"
);
if( fDetail ){
db_prepare(&q2, "SELECT isAdded, isRemoved, origname, newname"
" FROM stashfile WHERE stashid=$id");
}
while( db_step(&q)==SQLITE_ROW ){
int stashid = db_column_int(&q, 0);
const char *zCom;
n++;
fossil_print("%5d: [%.14s] on %s\n",
stashid,
db_column_text(&q, 1),
db_column_text(&q, 3)
);
zCom = db_column_text(&q, 2);
if( zCom && zCom[0] ){
fossil_print(" ");
comment_print(zCom, 7, 79);
}
if( fDetail ){
db_bind_int(&q2, "$id", stashid);
while( db_step(&q2)==SQLITE_ROW ){
int isAdded = db_column_int(&q2, 0);
int isRemoved = db_column_int(&q2, 1);
const char *zOrig = db_column_text(&q2, 2);
const char *zNew = db_column_text(&q2, 3);
if( isAdded ){
fossil_print(" ADD %s\n", zNew);
}else if( isRemoved ){
fossil_print(" REMOVE %s\n", zOrig);
}else if( fossil_strcmp(zOrig,zNew)!=0 ){
fossil_print(" RENAME %s -> %s\n", zOrig, zNew);
}else{
fossil_print(" EDIT %s\n", zOrig);
}
}
db_reset(&q2);
}
}
db_finalize(&q);
if( fDetail ) db_finalize(&q2);
if( n==0 ) fossil_print("empty stash\n");
}else
if( memcmp(zCmd, "drop", nCmd)==0 || memcmp(zCmd, "rm", nCmd)==0 ){
int allFlag = find_option("all", 0, 0)!=0;
if( g.argc>4 ) usage("drop STASHID");
if( allFlag ){
Blob ans;
blob_zero(&ans);
prompt_user("This action is not undoable. Continue (y/N)? ", &ans);
if( blob_str(&ans)[0]=='y' ){
db_multi_exec("DELETE FROM stash; DELETE FROM stashfile;");
}
}else{
stashid = stash_get_id(g.argc==4 ? g.argv[3] : 0);
undo_begin();
undo_save_stash(stashid);
stash_drop(stashid);
undo_finish();
}
}else
if( memcmp(zCmd, "pop", nCmd)==0 ){
if( g.argc>3 ) usage("pop");
stashid = stash_get_id(0);
undo_begin();
stash_apply(stashid, 0);
undo_save_stash(stashid);
undo_finish();
stash_drop(stashid);
}else
if( memcmp(zCmd, "apply", nCmd)==0 ){
if( g.argc>4 ) usage("apply STASHID");
stashid = stash_get_id(g.argc==4 ? g.argv[3] : 0);
undo_begin();
stash_apply(stashid, 0);
undo_finish();
}else
if( memcmp(zCmd, "goto", nCmd)==0 ){
int nConflict;
int vid;
if( g.argc>4 ) usage("apply STASHID");
stashid = stash_get_id(g.argc==4 ? g.argv[3] : 0);
undo_begin();
vid = db_int(0, "SELECT vid FROM stash WHERE stashid=%d", stashid);
nConflict = update_to(vid);
stash_apply(stashid, nConflict);
db_multi_exec("UPDATE vfile SET mtime=0 WHERE pathname IN "
"(SELECT origname FROM stashfile WHERE stashid=%d)",
stashid);
undo_finish();
}else
if( memcmp(zCmd, "diff", nCmd)==0 ){
const char *zDiffCmd = diff_command_external(0);
const char *zBinGlob = 0;
int fIncludeBinary = 0;
u64 diffFlags = diff_options();
if( g.argc>4 ) usage("diff STASHID");
if( zDiffCmd ){
zBinGlob = diff_get_binary_glob();
fIncludeBinary = diff_include_binary_files();
}
stashid = stash_get_id(g.argc==4 ? g.argv[3] : 0);
stash_diff(stashid, zDiffCmd, zBinGlob, fIncludeBinary, diffFlags);
}else
if( memcmp(zCmd, "gdiff", nCmd)==0 ){
const char *zDiffCmd = diff_command_external(1);
const char *zBinGlob = 0;
int fIncludeBinary = 0;
u64 diffFlags = diff_options();
if( g.argc>4 ) usage("gdiff STASHID");
if( zDiffCmd ){
zBinGlob = diff_get_binary_glob();
fIncludeBinary = diff_include_binary_files();
}
stashid = stash_get_id(g.argc==4 ? g.argv[3] : 0);
stash_diff(stashid, zDiffCmd, zBinGlob, fIncludeBinary, diffFlags);
}else
if( memcmp(zCmd, "help", nCmd)==0 ){
g.argv[1] = "help";
g.argv[2] = "stash";
g.argc = 3;
help_cmd();
}else
{
usage("SUBCOMMAND ARGS...");
}
db_end_transaction(0);
}