summaryrefslogtreecommitdiff
path: root/cli.py
blob: f72602e08c0fea791baf13d4748b258289df2a67 (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
#!/usr/bin/python
'''
    Metadata anonymisation toolkit - CLI edition
'''

import sys
from lib import mat
import optparse
import hachoir_core

__version__ = '0.1'


def parse():
    '''
        Get, and parse options passed to the program
    '''
    parser = optparse.OptionParser(usage='%prog [options] filename')
    parser.add_option('--add2archive', '-a', action='store_true',
        default=False, help='Add to outputed archive non-supported filetypes')
    parser.add_option('--backup', '-b', action='store_true', default=False,
        help='Keep a backup copy')
    parser.add_option('--check', '-c',  action='store_true', default=False,
        help='Check if a file is free of harmfull metadatas')
    parser.add_option('--display', '-d', action='store_true', default=False,
        help='List all the meta of a file without removing them')
    parser.add_option('--ugly', '-u', action='store_true', default=False,
        help='Remove harmful meta, but loss can occure')
    parser.add_option('--version', '-v', action='callback',
        callback=display_version, help='Display version and exit')

    values, arguments = parser.parse_args()
    if not arguments:
        parser.print_help()
        sys.exit(0)
    return values, arguments


def display_version(*_):
    '''
        Display the program's version, and exit
    '''
    print('Metadata Anonymisation Toolkit version %s') % mat.__version__
    print('CLI version %s') % __version__
    print('Hachoir version %s') % hachoir_core.__version__
    sys.exit(0)


def list_meta(class_file, filename):
    '''
        Print all the meta of 'filename' on stdout
    '''
    print('[+] File %s :' % filename)
    if class_file.is_clean():
        print('No harmful meta found')
    else:
        for key, value in class_file.get_meta().iteritems():
            print(key + ' : ' + str(value))


def is_clean(class_file, filename):
    '''
        Say if 'filename' is clean or not
    '''
    if class_file.is_clean():
        print('[+] %s is clean' % filename)
    else:
        print('[+] %s is not clean' % filename)


def clean_meta(class_file, filename):
    '''
        Clean the file 'filename'
    '''
    print('[+] Cleaning %s' % filename)
    if class_file.is_clean():
        print('%s is already clean' % filename)
    else:
        class_file.remove_all()
        print('%s cleaned !' % filename)


def clean_meta_ugly(class_file, filename):
    '''
        Clean the file 'filename', ugly way
    '''
    print('[+] Cleaning %s' % filename)
    if class_file.is_clean():
        print('%s is already clean' % filename)
    else:
        class_file.remove_all_ugly()
        print('%s cleaned' % filename)


def main():
    '''
        main function : get args, and launch the appropriate function
    '''
    args, filenames = parse()

    #func receive the function correponding to the options given as parameters
    if args.display is True:  # only print metadatas
        func = list_meta
    elif args.check is True:  # only check if the file is clean
        func = is_clean
    elif args.ugly is True:  # destructive anonymisation method
        func = clean_meta_ugly
    else:  # clean the file
        func = clean_meta

    for filename in filenames:
        class_file = mat.create_class_file(filename, args.backup,
            args.add2archive)
        if class_file is not None:
            func(class_file, filename)

if __name__ == '__main__':
    main()