~bialix/qbzr/post-commit

# -*- coding: utf-8 -*-

#

# QBzr - Qt frontend to Bazaar commands

# Copyright (C) 2010 Alexander Belchenko

#

# 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

"""Commit History manager: store/retrieve last N messages

of successfull commits to be able reuse them in GUI commit dialog(s).

The history saved in the ~/.bazaar/commit-history file.

Format of this file is simple config-based (ConfigObj ftw):

limit = N

order = a b c d e f

mXX = ...

mYY = ...

Parameters used here as following:

* limit - determine how many entries will be stored.

  0 means don't store anything. When new message overflow this limit

  it will overwrite the oldest one.

* order - determine the order of messages from newest to oldest,

  as list of message variables `mXX`.

* mXX - message variable which holds the actual saved message.

"""

_FILENAME = 'commit-history'

_SKELETON = """\

limit = 10

order = ""

"""

class NullCommitHistory(object):

    def __init__(self, cfg=None):

        pass

    def add(self, revision):

        pass

    def get_summary_list(self, depth=None):

        return []

    def get_message(self, index=None):

        return ''

class CommitHistory(object):

    def __init__(self, cfg):

        self._cfg = cfg

        self.items = {}

    def add(self, revision):

        # get slot name

        order_list = self.get_order_as_list()

        limit = _get_limit(self._cfg)

        if len(order_list)+1 > limit:

            slot_name = order_list[-1]

        else:

            n = len(order_list) + 1

            if limit < 100:

                template = 'm%02d'

            else:

                template = 'm%06d'

            while True:

                slot_name = template % n

                if slot_name not in self._cfg.keys():

                    break

                n += 1

        # insert message

        self._cfg[slot_name] = revision.message

        if slot_name in order_list:

            order_list.remove(slot_name)

        order_list.insert(0, slot_name)

        self._cfg['order'] = ' '.join(order_list)

        # write new file

        self._cfg.write()

    def get_order_as_list(self):

        order_str = self._cfg.get('order', '')

        order_list = order_str.split()

        return order_list

    def get_summary_list(self, depth=10):

        order_list = self.get_order_as_list()

        summary_list = []

        ix = 0

        for o in order_list[:depth]:

            message = self._cfg.get(o, '')

            if message:

                self.items[ix] = message

                ix += 1

                summary = message.replace('\n',' ')

                if len(summary) > 80:

                    summary = summary[:77]+'...'

                summary_list.append(summary)

        return summary_list

    def get_message(self, index):

        return self.items.get(index, '')

def _get_limit(cfg):

    try:

        limit = int(cfg['limit'])

    except (ValueError, KeyError):

        limit = 0

    return limit

def open_commit_history():

    """Factory."""

    # open config and check the limit

    from bzrlib import config, osutils, trace

    path = osutils.pathjoin(config.config_dir(), _FILENAME)

    if not osutils.isfile(path):

        config.ensure_config_dir_exists()

        try:

            f = open(path, 'wb')

            try:

                f.write(_SKELETON)

            finally:

                f.close()

        except (IOError, OSError), e:

            trace.mutter("can't create commit-history file: %r" % e)

            return NullCommitHistory()

    cfg = config.ConfigObj(path, encoding='utf-8')

    klass = CommitHistory

    if _get_limit(cfg) == 0:

        klass = NullCommitHistory

    return klass(cfg)