Statistics
| Branch: | Tag: | Revision:

root / kamaki / cli / history.py @ b8220825

History | View | Annotate | Download (4.6 kB)

1
# Copyright 2012-2014 GRNET S.A. All rights reserved.
2
#
3
# Redistribution and use in source and binary forms, with or
4
# without modification, are permitted provided that the following
5
# conditions are met:
6
#
7
#   1. Redistributions of source code must retain the above
8
#      copyright notice, this list of conditions and the following
9
#      disclaimer.
10
#
11
#   2. Redistributions in binary form must reproduce the above
12
#      copyright notice, this list of conditions and the following
13
#      disclaimer in the documentation and/or other materials
14
#      provided with the distribution.
15
#
16
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
17
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
20
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27
# POSSIBILITY OF SUCH DAMAGE.
28
#
29
# The views and conclusions contained in the software and
30
# documentation are those of the authors and should not be
31
# interpreted as representing official policies, either expressed
32
# or implied, of GRNET S.A.
33

    
34
import codecs
35
from logging import getLogger
36

    
37

    
38
log = getLogger(__name__)
39

    
40

    
41
class History(object):
42
    ignore_commands = ['config set', ]
43

    
44
    def __init__(self, filepath, token=None):
45
        self.filepath = filepath
46
        self.token = token
47
        self._limit = 0
48
        self.counter = 0
49

    
50
    def __getitem__(self, cmd_ids):
51
        with codecs.open(self.filepath, mode='r', encoding='utf-8') as f:
52
            try:
53
                lines = f.readlines()
54
                self.counter, cmd_list = int(lines[0]), lines[1:]
55
                return cmd_list[cmd_ids]
56
            except IndexError:
57
                return None
58

    
59
    @property
60
    def limit(self):
61
        return self._limit
62

    
63
    @limit.setter
64
    def limit(self, new_limit):
65
        new_limit = int(new_limit)
66
        if new_limit < 0:
67
            raise ValueError('Invalid history limit (%s)' % new_limit)
68
        old_limit, self._limit = self._limit, new_limit
69
        if self._limit and ((not old_limit) or (self._limit <= old_limit)):
70
            with codecs.open(self.filepath, mode='r', encoding='utf-8') as f:
71
                lines = f.readlines()
72
                self.counter = int(lines[0])
73
                old_len = len(lines[1:])
74
            if old_len > new_limit:
75
                self.counter += old_len - new_limit
76
                with codecs.open(
77
                        self.filepath, mode='w', encoding='utf-8') as f:
78
                    f.write('%s\n' % self.counter)
79
                    f.write(''.join(lines[old_len - new_limit + 1:]))
80
                    f.flush()
81

    
82
    @classmethod
83
    def _match(self, line, match_terms):
84
        if match_terms:
85
            return all(term in line for term in match_terms.split())
86
        return True
87

    
88
    def get(self, match_terms=None, limit=0):
89
        """DEPRECATED since 0.14"""
90
        limit = int(limit or 0)
91
        r = ['%s.\t%s' % (i + 1, line) for i, line in enumerate(self[:]) if (
92
                self._match(line, match_terms))]
93
        return r[- limit:]
94

    
95
    def add(self, line):
96
        line = '%s' % line or ''
97
        bline = [w.lower() for w in line.split() if not w.startswith('-')]
98
        for cmd in self.ignore_commands:
99
            cmds = [w.lower() for w in cmd.split()]
100
            if cmds == bline[1:len(cmds) + 1]:
101
                log.debug('History ignored a command of type "%s"' % cmd)
102
                return
103
        line = line.replace(self.token, '...') if self.token else line
104
        try:
105
            with codecs.open(self.filepath, mode='a+', encoding='utf-8') as f:
106
                f.write(line + '\n')
107
                f.flush()
108
            self.limit = self.limit
109
        except Exception as e:
110
            log.debug('Add history failed for "%s" (%s)' % (line, e))
111

    
112
    def empty(self):
113
        with open(self.filepath, 'w') as f:
114
            f.write('0\n')
115
            f.flush()
116
        self.counter = 0
117

    
118
    def clean(self):
119
        """DEPRECATED since version 0.14"""
120
        return self.empty()
121

    
122
    def retrieve(self, cmd_id):
123
        if not cmd_id:
124
            return None
125
        cmd_id = int(cmd_id)
126
        return self[cmd_id - (1 if cmd_id > 0 else 0)]