# -*- coding: utf-8 -*-
# This module uses some of meld source code :
#      Copyright (C) 2002-2003 Stephen Kennedy <stevek@gnome.org>
#      http://meld.sourceforge.net
#
# Copyright (c) 2004-2009 LOGILAB S.A. (Paris, FRANCE).
# http://www.logilab.fr/ -- mailto:contact@logilab.fr
#
# This program is free software; you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation; either version 2 of the License, or (at your option) any later
# version.
#
# 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. See the GNU General Public License for more details
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc.,
# 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
"""this module contains mercurial scm"""


__all__ = ['HGAgent', 'find_repository']

import sys
import os
import datetime
from os.path import abspath, isdir, join, dirname, basename
from cStringIO import StringIO

from logilab.common.compat import sorted, reversed

from logilab.devtools.vcslib import VCS_UPTODATE, VCS_MODIFIED, \
     VCS_MISSING, VCS_NEW, VCS_CONFLICT, VCS_NOVERSION, VCS_IGNORED, \
     VCS_REMOVED, VCS_NEEDSPATCH, IVCSAgent, CheckInInfo, localtime_to_gmtime

try:
    from mercurial.error import RepoError
    from mercurial.__version__ import version as hg_version
except ImportError:
    from mercurial.repo import RepoError
    from mercurial.version import get_version
    hg_version = get_version()
    
from mercurial.hg import repository as Repository
from mercurial.ui import ui as Ui
from mercurial.node import short
try:
    from mercurial.cmdutil import walkchangerevs
    from mercurial.util import cachefunc, _encoding
except ImportError:
    from mercurial.commands import walkchangerevs
    import locale
    def cachefunc(func):
        return func
    # stay compatible with mercurial 0.9.1 (etch debian release)
    # (borrowed from mercurial.util 1.1.2)
    try:
        _encoding = os.environ.get("HGENCODING")
        if sys.platform == 'darwin' and not _encoding:
            # On darwin, getpreferredencoding ignores the locale environment and
            # always returns mac-roman. We override this if the environment is
            # not C (has been customized by the user).
            locale.setlocale(locale.LC_CTYPE, '')
            _encoding = locale.getlocale()[1]
        if not _encoding:
            _encoding = locale.getpreferredencoding() or 'ascii'
    except locale.Error:
        _encoding = 'ascii'

try:
    # demandimport causes problems when activated, ensure it isn't
    # XXX put this in apycot where the pb has been noticed?
    from mercurial import demandimport
    demandimport.disable()
except:
    pass

Ui.warn = lambda *args, **kwargs: 0 # make it quiet

def find_repository(path):
    """returns <path>'s mercurial repository

    None if <path> is not under hg control
    """
    path = abspath(path)
    while not isdir(join(path, ".hg")):
        oldpath = path
        path = dirname(path)
        if path == oldpath:
            return None
    return path

def changeset_info(repo, rev=0, changenode=None):
    """returns matching (rev, date, user, sumarry)"""
    log = repo.changelog
    if changenode is None:
        changenode = log.node(rev)
    elif not rev:
        rev = log.rev(changenode)
    manifest, user, (time, timezone), files, desc, extra = log.read(changenode)
    checkin_date = datetime.datetime.fromtimestamp((float(time) + timezone))
    return rev, checkin_date, user, desc, files


class HGAgent(object):
    """A hg specific agent"""
    __implements__ = IVCSAgent,

    def __call__(self):
        return self

    def not_up_to_date(self, filepath):
        """get a list describing files which are not up to date under the
        given path

        :type filepath: str
        :param filepath: starting path
        
        :rtype: list(tuple(str, str))
        :return:
          a list of tuple (file, status) describing files which are not up to date
        """
        # we don't want mercurial's stdout to interfere with ours
        sys.stdout = StringIO()
        try:
            parentui = Ui()
            wdrepo = Repository(parentui, path=find_repository(filepath))
            changes = []
            masterrepo = Repository(parentui, wdrepo.ui.expandpath('default'))
            for nid in wdrepo.findincoming(masterrepo):
                # httprepository doesn't have changelog attribute
                if hasattr(masterrepo, 'changelog'):
                    manifest, user, timeinfo, files, desc, extra = masterrepo.changelog.read(nid)
                else:
                    files = [nid]
                for filename in files:
                    # .ljust(15)
                    changes.append(('incoming', filename))
            for nid in wdrepo.findoutgoing(masterrepo):
                manifest, user, timeinfo, files, desc, extra = wdrepo.changelog.read(nid)
                for filename in files:
                    # .ljust(15)
                    changes.append(('outgoing', filename))
            # XXX check uncommited for local changes
            statuslist = ('modified', 'added', 'removed', 'deleted', 'unknown')
            return changes + [(status, filename)
                              for status, files in zip(statuslist, wdrepo.status())
                              for filename in files]
        finally:
            sys.stdout = sys.__stdout__

    def edited(self, filepath):
        """get a list describing files which are currentlyedited under
        the given path

        :type filepath: str
        :param filepath: starting path

        :rtype: list(tuple(str, str))
        :return:
          a list of tuple (file, locked by) describing files which are in edition
        """
        raise NotImplementedError()

    def update(self, filepath):
        """
        :type filepath: str
        :param filepath: the file or directory to update

        :rtype: str
        :return:
          a shell command string to update the given file from the vc
          repository
        """
        return 'hg pull -u %s' % filepath

    def commit(self, filepath, message):
        """
        :type filepath: str
        :param filepath: the file or directory to commit

        :type message: str
        :param message: the message used to commit
        
        :rtype: str
        :return:
          a shell command string to commit the given file to the vc
          repository
        """
        print "warning: this is only a commit in the local repository"
        return 'hg ci -m "%s" %s' % (message, filepath)

    def add(self, filepath):
        """
        :type filepath: str
        :param filepath: the file or directory to add
        
        :rtype: str
        :return:
          a shell command string to add the given file to the vc
          repository
        """
        return 'hg add %s' % filepath

    def remove(self, filepath):
        """
        :type filepath: str
        :param filepath: the file or directory to remove
        
        :rtype: str
        :return:
          a shell command string to remove the given file from the vc
          repository
        """
        return 'hg rm -f %s' % filepath

    def tag(self, filepath, tagname):
        """
        :type filepath: str
        :param filepath: the file or directory to commit

        :type tagname: str
        :param tagname: the name of the tag to add to the file
        
        :rtype: str
        :return:
          a shell command string to tag the given file in the vc
          repository using the given tag name
        """
        if not isinstance(filepath, basestring):
            filepath = filepath[0] #' '.join(filepath)
        #print os.getcwd()
        #print '**'
        #print abspath(filepath)
        assert abspath(filepath).startswith(os.getcwd()), \
               "I don't know how to deal with filepath and <hg tag>"
        return "hg tag -f %s" % tagname

    def checkout(self, repository, path, tag=None, quiet=True):
        """
        :type repository: str
        :param repository: the CVS repository address

        :type filepath: str
        :param filepath:
          the path of the file or directory to check out *in the
          repository*

        :rtype: str
        :return:
          a shell command string to check out the given file or
          directory from the vc repository
        """
        if quiet:
            quiet = '-q '
        else:
            quiet = ''
        if tag is None:
            tag = 'tip'
        #if path:
        #    print "warning: <%s> argument not needed and ignored" % path

        # TODO stay compatible with mercurial 0.9 (still present in etch)
        # Note that the following command is only available since 1.0.1
        #return 'hg clone -r "%s" %s %s' % (tag, quiet, repository)
        # please, continue to use this old-good-(and-slower) command
        cmd = 'hg clone %s %s' % (quiet, repository)
        if tag:
            cmd += '; hg up -R %s %s' % (basename(repository.rstrip('/')), tag)
        return cmd

    def log_info(self, path, from_date, to_date, repository=None, tag=None):
        """get log messages between <from_date> and <to_date> (inclusive)
        
        Both date should be local time (ie 9-sequence)
        
        return an iterator on `CheckInInfo` instances, sorted by date
        (descending)
        """
        if tag and tag != 'HEAD':
            raise NotImplementedError("dunno how to get logs for a given tag")
        # we check version 1.X cos it's doesn't work for previous versions
        assert int(hg_version.split('.')[0]) >= 1, 'unsupported hg version %s' % hg_version
        repopath = find_repository(path)
        assert repopath is not None, 'no repository found in %s' % path
        ui = Ui()
        repo = Repository(ui, path=repopath)
        opts = dict(rev=['tip:0'], branches=None, include=(), exclude=())
        get = cachefunc(lambda r: repo.changectx(r).changeset())
        changeiter, matchfn = walkchangerevs(ui, repo, (), get, opts)
        # changeset_info return GMT time, convert from_date and to_date
        # as well so we can compare
        from_date = datetime.datetime(*localtime_to_gmtime(from_date)[:6])
        to_date = datetime.datetime(*localtime_to_gmtime(to_date)[:6])
        infos = []
        for st, rev, fns in changeiter:
            if st == 'add':
                changenode = repo.changelog.node(rev)
                rev, date, user, message, files = changeset_info(repo, rev, changenode)
                if from_date <= date <= to_date:
                    # FIXME: added/removed lines information
                    cii = CheckInInfo(date, user, unicode(message, _encoding),
                                      rev, files=files, branch=tag)
                    infos.append((date, cii))
        for _, info in reversed(sorted(infos)):
            yield info
            
    def current_short_changeset(self, path):
        """return the short id of the current changeset"""
        # we check version 1.X cos it's doesn't work for previous versions
        assert int(hg_version.split('.')[0]) >= 1, 'unsupported hg version %s' % hg_version
        repopath = find_repository(path)
        if repopath is None:
            raise RuntimeError('no repository found in %s' % path)
        repo = Repository(Ui(), path=repopath)
        try:
            ctx = repo.workingctx()
        except AttributeError:
            ctx = repo[None]
        parents = ctx.parents()
        #assert len(parents) == 0 ?
        return short(parents[0].node())

                  
# HGAgent is a stateless object, transparent singleton thanks to its __call__
# method
HGAgent = HGAgent()