Statistics
| Branch: | Tag: | Revision:

root / kamaki / cli / history.py @ 4a25486d

History | View | Annotate | Download (2.9 kB)

1 73e0914d Stavros Sachtouris
#!/usr/bin/env python
2 73e0914d Stavros Sachtouris
3 34e4cf61 Stavros Sachtouris
# Copyright 2012-2013 GRNET S.A. All rights reserved.
4 73e0914d Stavros Sachtouris
#
5 73e0914d Stavros Sachtouris
# Redistribution and use in source and binary forms, with or
6 73e0914d Stavros Sachtouris
# without modification, are permitted provided that the following
7 73e0914d Stavros Sachtouris
# conditions are met:
8 73e0914d Stavros Sachtouris
#
9 73e0914d Stavros Sachtouris
#   1. Redistributions of source code must retain the above
10 73e0914d Stavros Sachtouris
#      copyright notice, this list of conditions and the following
11 73e0914d Stavros Sachtouris
#      disclaimer.
12 73e0914d Stavros Sachtouris
#
13 73e0914d Stavros Sachtouris
#   2. Redistributions in binary form must reproduce the above
14 73e0914d Stavros Sachtouris
#      copyright notice, this list of conditions and the following
15 73e0914d Stavros Sachtouris
#      disclaimer in the documentation and/or other materials
16 73e0914d Stavros Sachtouris
#      provided with the distribution.
17 73e0914d Stavros Sachtouris
#
18 73e0914d Stavros Sachtouris
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
19 73e0914d Stavros Sachtouris
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 73e0914d Stavros Sachtouris
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 73e0914d Stavros Sachtouris
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
22 73e0914d Stavros Sachtouris
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 73e0914d Stavros Sachtouris
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 73e0914d Stavros Sachtouris
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
25 73e0914d Stavros Sachtouris
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 73e0914d Stavros Sachtouris
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 73e0914d Stavros Sachtouris
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28 73e0914d Stavros Sachtouris
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 73e0914d Stavros Sachtouris
# POSSIBILITY OF SUCH DAMAGE.
30 73e0914d Stavros Sachtouris
#
31 73e0914d Stavros Sachtouris
# The views and conclusions contained in the software and
32 73e0914d Stavros Sachtouris
# documentation are those of the authors and should not be
33 73e0914d Stavros Sachtouris
# interpreted as representing official policies, either expressed
34 73e0914d Stavros Sachtouris
# or implied, of GRNET S.A.
35 73e0914d Stavros Sachtouris
36 fd5db045 Stavros Sachtouris
37 73e0914d Stavros Sachtouris
class History(object):
38 fd5db045 Stavros Sachtouris
    def __init__(self, filepath):
39 fd5db045 Stavros Sachtouris
        self.filepath = filepath
40 73e0914d Stavros Sachtouris
41 fd5db045 Stavros Sachtouris
    @classmethod
42 fd5db045 Stavros Sachtouris
    def _match(self, line, match_terms):
43 fd5db045 Stavros Sachtouris
        if match_terms is None:
44 fd5db045 Stavros Sachtouris
            return True
45 fd5db045 Stavros Sachtouris
        for term in match_terms.split():
46 fd5db045 Stavros Sachtouris
            if term not in line:
47 fd5db045 Stavros Sachtouris
                return False
48 fd5db045 Stavros Sachtouris
        return True
49 73e0914d Stavros Sachtouris
50 fd5db045 Stavros Sachtouris
    def get(self, match_terms=None, limit=0):
51 98093aac Stavros Sachtouris
        limit = int(limit) or 0
52 99085b30 Stavros Sachtouris
        with open(self.filepath, 'r') as f:
53 99085b30 Stavros Sachtouris
            result = ['%s.  \t%s' % (
54 99085b30 Stavros Sachtouris
                i + 1, line) for i, line in enumerate(f.readlines())
55 99085b30 Stavros Sachtouris
                if self._match(line, match_terms)]
56 98093aac Stavros Sachtouris
            return result[- limit:]
57 73e0914d Stavros Sachtouris
58 fd5db045 Stavros Sachtouris
    def add(self, line):
59 98093aac Stavros Sachtouris
        with open(self.filepath, 'a+') as f:
60 98093aac Stavros Sachtouris
            f.write(line + '\n')
61 73e0914d Stavros Sachtouris
62 fd5db045 Stavros Sachtouris
    def clean(self):
63 98093aac Stavros Sachtouris
        with open(self.filepath, 'w'):
64 98093aac Stavros Sachtouris
            pass
65 75a0ea7d Stavros Sachtouris
66 75a0ea7d Stavros Sachtouris
    def retrieve(self, cmd_id):
67 75a0ea7d Stavros Sachtouris
        """
68 519d8639 Stavros Sachtouris
        :param cmd_id: (int) the id of the command to retrieve can be positive
69 519d8639 Stavros Sachtouris
            or negative, zero values are ignored
70 75a0ea7d Stavros Sachtouris

71 75a0ea7d Stavros Sachtouris
        :returns: (str) the stored command record without the id
72 75a0ea7d Stavros Sachtouris
        """
73 304c90b5 Stavros Sachtouris
        cmd_id = int(cmd_id)
74 519d8639 Stavros Sachtouris
        if not cmd_id:
75 519d8639 Stavros Sachtouris
            return None
76 75a0ea7d Stavros Sachtouris
        with open(self.filepath) as f:
77 304c90b5 Stavros Sachtouris
            try:
78 34e4cf61 Stavros Sachtouris
                cmd_list = f.readlines()[:-1]  # exclude current command
79 34e4cf61 Stavros Sachtouris
                return cmd_list[cmd_id - (1 if cmd_id > 0 else 0)]
80 304c90b5 Stavros Sachtouris
            except IndexError:
81 304c90b5 Stavros Sachtouris
                return None