summaryrefslogtreecommitdiff
path: root/summain
blob: 73aa645e3506850f5e323da9ea608684523c19a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
#!/usr/bin/python
# Copyright (C) 2010, 2011  Lars Wirzenius
#
# 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 3 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, see <http://www.gnu.org/licenses/>.


import cliapp
import os
import sys

import summainlib


class OutputFormat(object):

    def __init__(self, output):
        self.output = output
        
    def close(self):
        pass
        
    def write_object(self, name, o, checksums):
        raise NotImplemented()


class Rfc822(OutputFormat):

    def write_object(self, name, o, checksums):
        keys = (['Mtime', 'Mode', 'Ino', 'Dev', 'Nlink', 'Size',
                 'Uid', 'Username', 'Gid', 'Group', 'Target'] +
                checksums)
        values = [('Name', name)]
        values += [(k, o[k]) for k in keys if o[k] != '']
        record = ''.join('%s: %s\n' % (k, v) for k, v in values if v != '')
        self.output.write('%s\n' % record)


class Summain(cliapp.Application):

    def add_settings(self):
        self.settings.boolean(['relative-paths', 'r'],
                              'print paths relative to arguments')
        self.settings.boolean(['mangle-paths', 'm'],
                              'mangle (obfuscate) paths')
        self.settings.string(['secret'], 
                             'use SECRET to make mangled paths unguessable')
        self.settings.string_list(['exclude'],
                              'do not output or compute FIELD',
                              metavar='FIELD')
        self.settings.string_list(['checksum', 'c'],
                                  'which checksums to compute: '
                                  'MD5, SHA1, SHA224, SHA256, SHA384, SHA512; '
                                  'use once per checksum type '
                                  '(default is SHA1)')
        self.settings.choice(['output-format', 'f'],
                             ['rfc822', 'csv', 'json'],
                             'choose output format (rfc822, csv, json)')

    def files(self, root):
        if os.path.isdir(root):
            for dirname, dirnames, filenames in os.walk(root):
                yield dirname
                dirnames.sort()
                for filename in sorted(filenames):
                    yield os.path.join(dirname, filename)
        else:
            yield root

    def process_args(self, args):
        relative = self.settings['relative-paths']
        exclude = self.settings['exclude']
        nn = summainlib.NumberNormalizer()
        if self.settings['mangle-paths']:
            pn = summainlib.PathNormalizer(self.settings['secret'])
        else:
            pn = summainlib.SamePath()
        checksums = [x.upper() 
                     for x in self.settings['checksum'] or ['SHA1']]
        o = summainlib.FilesystemObject('.', nn, pn, exclude)
        for checksum in checksums:
            try:
                o[checksum]
            except KeyError:
                raise cliapp.AppException('Unknown checksum %s' % checksum)

        fmt = Rfc822(self.output)
        for root in args:
            for filename in self.files(root):
                o = summainlib.FilesystemObject(filename, nn, pn, exclude)
                if relative:
                    name = self.relative_path(root, o)
                else:
                    name = o['Name']
                fmt.write_object(name, o, checksums)
        fmt.close()

    def relative_path(self, root, o):
        '''Return a path that is relative to root, if possible.
        
        If pathname does not start with root, then return it
        unmodified.
        
        '''
        
        if root.endswith(os.sep):
            root2 = root
        else:
            root2 = root + os.sep
        pathname = o['Name']
        if pathname.startswith(root2):
            return pathname[len(root2):]
        elif pathname == root and o.isdir():
            return '.'
        else:
            return pathname


Summain(version=summainlib.__version__).run()