# shelve.py - save/restore working directory state

#

# Copyright 2013 Facebook, Inc.

#

# This software may be used and distributed according to the terms of the

# GNU General Public License version 2 or any later version.

"""save and restore changes to the working directory

The "hg shelve" command saves changes made to the working directory

and reverts those changes, resetting the working directory to a clean

state.

Later on, the "hg unshelve" command restores the changes saved by "hg

shelve". Changes can be restored even after updating to a different

parent, in which case Mercurial's merge machinery will resolve any

conflicts if necessary.

You can have more than one shelved change outstanding at a time; each

shelved change has a distinct name. For details, see the help for "hg

shelve".

"""

from __future__ import absolute_import

import collections

import errno

import itertools

from mercurial.i18n import _

from mercurial import (

    bundle2,

    bundlerepo,

    changegroup,

    cmdutil,

    commands,

    error,

    exchange,

    hg,

    lock as lockmod,

    mdiff,

    merge,

    node as nodemod,

    patch,

    phases,

    repair,

    scmutil,

    templatefilters,

    util,

)

from . import (

    rebase,

)

cmdtable = {}

command = cmdutil.command(cmdtable)

# Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for

# extensions which SHIP WITH MERCURIAL. Non-mainline extensions should

# be specifying the version(s) of Mercurial they are tested with, or

# leave the attribute unspecified.

testedwith = 'ships-with-hg-core'

backupdir = 'shelve-backup'

shelvedir = 'shelved'

shelvefileextensions = ['hg', 'patch']

# universal extension is present in all types of shelves

patchextension = 'patch'

# we never need the user, so we use a

# generic user for all shelve operations

shelveuser = 'shelve@localhost'

class shelvedfile(object):

    """Helper for the file storing a single shelve

    Handles common functions on shelve files (.hg/.patch) using

    the vfs layer"""

    def __init__(self, repo, name, filetype=None):

        self.repo = repo

        self.name = name

        self.vfs = scmutil.vfs(repo.join(shelvedir))

        self.backupvfs = scmutil.vfs(repo.join(backupdir))

        self.ui = self.repo.ui

        if filetype:

            self.fname = name + '.' + filetype

        else:

            self.fname = name

    def exists(self):

        return self.vfs.exists(self.fname)

    def filename(self):

        return self.vfs.join(self.fname)

    def backupfilename(self):

        def gennames(base):

            yield base

            base, ext = base.rsplit('.', 1)

            for i in itertools.count(1):

                yield '%s-%d.%s' % (base, i, ext)

        name = self.backupvfs.join(self.fname)

        for n in gennames(name):

            if not self.backupvfs.exists(n):

                return n

    def movetobackup(self):

        if not self.backupvfs.isdir():

            self.backupvfs.makedir()

        util.rename(self.filename(), self.backupfilename())

    def stat(self):

        return self.vfs.stat(self.fname)

    def opener(self, mode='rb'):

        try:

            return self.vfs(self.fname, mode)

        except IOError as err:

            if err.errno != errno.ENOENT:

                raise

            raise error.Abort(_("shelved change '%s' not found") % self.name)

    def applybundle(self):

        fp = self.opener()

        try:

            gen = exchange.readbundle(self.repo.ui, fp, self.fname, self.vfs)

            if not isinstance(gen, bundle2.unbundle20):

                gen.apply(self.repo, 'unshelve',

                          'bundle:' + self.vfs.join(self.fname),

                          targetphase=phases.secret)

            if isinstance(gen, bundle2.unbundle20):

                bundle2.applybundle(self.repo, gen,

                                    self.repo.currenttransaction(),

                                    source='unshelve',

                                    url='bundle:' + self.vfs.join(self.fname))

        finally:

            fp.close()

    def bundlerepo(self):

        return bundlerepo.bundlerepository(self.repo.baseui, self.repo.root,

                                           self.vfs.join(self.fname))

    def writebundle(self, bases, node):

        cgversion = changegroup.safeversion(self.repo)

        if cgversion == '01':

            btype = 'HG10BZ'

            compression = None

        else:

            btype = 'HG20'

            compression = 'BZ'

        cg = changegroup.changegroupsubset(self.repo, bases, [node], 'shelve',

                                           version=cgversion)

        bundle2.writebundle(self.ui, cg, self.fname, btype, self.vfs,

                                compression=compression)

class shelvedstate(object):

    """Handle persistence during unshelving operations.

    Handles saving and restoring a shelved state. Ensures that different

    versions of a shelved state are possible and handles them appropriately.

    """

    _version = 1

    _filename = 'shelvedstate'

    _keep = 'keep'

    _nokeep = 'nokeep'

    @classmethod

    def load(cls, repo):

        fp = repo.vfs(cls._filename)

        try:

            version = int(fp.readline().strip())

            if version != cls._version:

                raise error.Abort(_('this version of shelve is incompatible '

                                   'with the version used in this repo'))

            name = fp.readline().strip()

            wctx = nodemod.bin(fp.readline().strip())

            pendingctx = nodemod.bin(fp.readline().strip())

            parents = [nodemod.bin(h) for h in fp.readline().split()]

            stripnodes = [nodemod.bin(h) for h in fp.readline().split()]

            branchtorestore = fp.readline().strip()

            keep = fp.readline().strip() == cls._keep

        except (ValueError, TypeError) as err:

            raise error.CorruptedState(str(err))

        finally:

            fp.close()

        try:

            obj = cls()

            obj.name = name

            obj.wctx = repo[wctx]

            obj.pendingctx = repo[pendingctx]

            obj.parents = parents

            obj.stripnodes = stripnodes

            obj.branchtorestore = branchtorestore

            obj.keep = keep

        except error.RepoLookupError as err:

            raise error.CorruptedState(str(err))

        return obj

    @classmethod

    def save(cls, repo, name, originalwctx, pendingctx, stripnodes,

             branchtorestore, keep=False):

        fp = repo.vfs(cls._filename, 'wb')

        fp.write('%i\n' % cls._version)

        fp.write('%s\n' % name)

        fp.write('%s\n' % nodemod.hex(originalwctx.node()))

        fp.write('%s\n' % nodemod.hex(pendingctx.node()))

        fp.write('%s\n' %

                 ' '.join([nodemod.hex(p) for p in repo.dirstate.parents()]))

        fp.write('%s\n' %

                 ' '.join([nodemod.hex(n) for n in stripnodes]))

        fp.write('%s\n' % branchtorestore)

        fp.write('%s\n' % (cls._keep if keep else cls._nokeep))

        fp.close()

    @classmethod

    def clear(cls, repo):

        util.unlinkpath(repo.join(cls._filename), ignoremissing=True)

def cleanupoldbackups(repo):

    vfs = scmutil.vfs(repo.join(backupdir))

    maxbackups = repo.ui.configint('shelve', 'maxbackups', 10)

    hgfiles = [f for f in vfs.listdir()

               if f.endswith('.' + patchextension)]

    hgfiles = sorted([(vfs.stat(f).st_mtime, f) for f in hgfiles])

    if 0 < maxbackups and maxbackups < len(hgfiles):

        bordermtime = hgfiles[-maxbackups][0]

    else:

        bordermtime = None

    for mtime, f in hgfiles[:len(hgfiles) - maxbackups]:

        if mtime == bordermtime:

            # keep it, because timestamp can't decide exact order of backups

            continue

        base = f[:-(1 + len(patchextension))]

        for ext in shelvefileextensions:

            try:

                vfs.unlink(base + '.' + ext)

            except OSError as err:

                if err.errno != errno.ENOENT:

                    raise

def _aborttransaction(repo):

    '''Abort current transaction for shelve/unshelve, but keep dirstate

    '''

    tr = repo.currenttransaction()

    repo.dirstate.savebackup(tr, suffix='.shelve')

    tr.abort()

    repo.dirstate.restorebackup(None, suffix='.shelve')

def createcmd(ui, repo, pats, opts):

    """subcommand that creates a new shelve"""

    with repo.wlock():

        cmdutil.checkunfinished(repo)

        return _docreatecmd(ui, repo, pats, opts)

def getshelvename(repo, parent, opts):

    """Decide on the name this shelve is going to have"""

    def gennames():

        yield label

        for i in xrange(1, 100):

            yield '%s-%02d' % (label, i)

    name = opts.get('name')

    label = repo._activebookmark or parent.branch() or 'default'

    # slashes aren't allowed in filenames, therefore we rename it

    label = label.replace('/', '_')

    if name:

        if shelvedfile(repo, name, patchextension).exists():

            e = _("a shelved change named '%s' already exists") % name

            raise error.Abort(e)

    else:

        for n in gennames():

            if not shelvedfile(repo, n, patchextension).exists():

                name = n

                break

        else:

            raise error.Abort(_("too many shelved changes named '%s'") % label)

    return name

def mutableancestors(ctx):

    """return all mutable ancestors for ctx (included)

    Much faster than the revset ancestors(ctx) & draft()"""

    seen = set([nodemod.nullrev])

    visit = collections.deque()

    visit.append(ctx)

    while visit:

        ctx = visit.popleft()

        yield ctx.node()

        for parent in ctx.parents():

            rev = parent.rev()

            if rev not in seen:

                seen.add(rev)

                if parent.mutable():

                    visit.append(parent)

def getcommitfunc(extra, interactive, editor=False):

    def commitfunc(ui, repo, message, match, opts):

        hasmq = util.safehasattr(repo, 'mq')

        if hasmq:

            saved, repo.mq.checkapplied = repo.mq.checkapplied, False

        backup = repo.ui.backupconfig('phases', 'new-commit')

        try:

            repo.ui.setconfig('phases', 'new-commit', phases.secret)

            editor_ = False

            if editor:

                editor_ = cmdutil.getcommiteditor(editform='shelve.shelve',

                                                  **opts)

            return repo.commit(message, shelveuser, opts.get('date'), match,

                               editor=editor_, extra=extra)

        finally:

            repo.ui.restoreconfig(backup)

            if hasmq:

                repo.mq.checkapplied = saved

    def interactivecommitfunc(ui, repo, *pats, **opts):

        match = scmutil.match(repo['.'], pats, {})

        message = opts['message']

        return commitfunc(ui, repo, message, match, opts)

    return interactivecommitfunc if interactive else commitfunc

def _nothingtoshelvemessaging(ui, repo, pats, opts):

    stat = repo.status(match=scmutil.match(repo[None], pats, opts))

    if stat.deleted:

        ui.status(_("nothing changed (%d missing files, see "

                    "'hg status')\n") % len(stat.deleted))

    else:

        ui.status(_("nothing changed\n"))

def _shelvecreatedcommit(repo, node, name):

    bases = list(mutableancestors(repo[node]))

    shelvedfile(repo, name, 'hg').writebundle(bases, node)

    cmdutil.export(repo, [node],

                   fp=shelvedfile(repo, name, patchextension).opener('wb'),

                   opts=mdiff.diffopts(git=True))

def _includeunknownfiles(repo, pats, opts, extra):

    s = repo.status(match=scmutil.match(repo[None], pats, opts),

                    unknown=True)

    if s.unknown:

        extra['shelve_unknown'] = '\0'.join(s.unknown)

        repo[None].add(s.unknown)

def _finishshelve(repo):

    _aborttransaction(repo)

def _docreatecmd(ui, repo, pats, opts):

    wctx = repo[None]

    parents = wctx.parents()