├── LICENSE ├── README.md └── auditor.py /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # auditor.py 2 | Script for tracking file system changes 3 | 4 | ### Synopsis 5 | auditor.py snap PATH [--filename NAME] 6 | auditor.py diff SNAP SNAP 7 | 8 | ### Description 9 | `autidor.py` when called with `snap` argument, saves the state of the file system PATH as a json SNAP file which contains a list of named entries with a metadata for each file entry. 10 | `autidor.py` when called with `diff` argument, compares two SNAP files and reports the changes. 11 | 12 | #### snap mode example 13 | 14 | ``` 15 | $ auditor.py snap D:\\simple_http_server --filename initial.json 16 | Snapshot was saved to "initial.json" 17 | ``` 18 | 19 | #### diff mode example 20 | 21 | ``` 22 | $ auditor.py diff initial.json changed.json 23 | Element D:\simple_http_server\src was changed 24 | Element D:\simple_http_server\src\AdvancedHttpServer.java was added 25 | Element D:\simple_http_server\src\EventListener.java was added 26 | Element D:\simple_http_server\src\SimpleHttpServer.java was removed 27 | Element D:\simple_http_server\src\test.html was changed 28 | ``` 29 | 30 | ### Compatibility 31 | 32 | Python 2 / Python 3 -------------------------------------------------------------------------------- /auditor.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from __future__ import print_function 4 | import os 5 | import argparse 6 | import json 7 | import datetime 8 | 9 | import sys 10 | 11 | VERSION = 1.0 12 | 13 | 14 | def error(*args, **kwargs): 15 | print("Error:", *args, file=sys.stderr, **kwargs) 16 | sys.exit(1) 17 | 18 | 19 | def snap(args): 20 | 21 | if not os.path.exists(args.path): 22 | error('"{}" does not exists'.format(args.path)) 23 | 24 | if not os.path.isdir(args.path): 25 | error('"{}" is not a directory'.format(args.path)) 26 | 27 | abs_path = os.path.abspath(args.path) 28 | today = datetime.datetime.now() 29 | 30 | if args.filename: 31 | filename = args.filename 32 | else: 33 | filename = today.strftime("%Y%m%dT%H%M%S") + ".json" 34 | 35 | dir_dic = { 36 | "path": abs_path, 37 | "datetime": today.isoformat(), 38 | "scheme-version": 1, 39 | "entries": {} 40 | } 41 | 42 | entry_path = abs_path 43 | 44 | try: 45 | for root, dirs, files in os.walk(abs_path): 46 | for name in files: 47 | entry_path = os.path.join(root, name) 48 | dir_dic["entries"][entry_path] = {'mtime': os.stat(entry_path).st_mtime, 'type': 'file'} 49 | 50 | for name in dirs: 51 | entry_path = os.path.join(root, name) 52 | dir_dic["entries"][entry_path] = {'mtime': os.stat(entry_path).st_mtime, 'type': 'directory'} 53 | 54 | except PermissionError: 55 | print('"{}" - permission denied'.format(entry_path)) 56 | except FileNotFoundError: 57 | print('"{}" - not found (broken link?)'.format(entry_path)) 58 | 59 | with open(filename, 'w') as outfile: 60 | json.dump(dir_dic, outfile, indent=4) 61 | 62 | print("Snapshot was saved to \"{}\"".format(filename)) 63 | 64 | 65 | def diff(args): 66 | if not os.path.exists(args.snap1): 67 | error('"{}" does not exist'.format(args.snap1)) 68 | 69 | if not os.path.exists(args.snap2): 70 | error('"{}" does not exist'.format(args.snap2)) 71 | 72 | try: 73 | with open(args.snap1, "r") as snap1_file: 74 | snap1_json = json.load(snap1_file) 75 | except ValueError: 76 | error("\"{}\" is not a valid json".format(args.snap1)) 77 | except: 78 | error("Failed to read snapshot file \"{}\"", args.snap1) 79 | 80 | try: 81 | with open(args.snap2, "r") as snap2_file: 82 | snap2_json = json.load(snap2_file) 83 | except ValueError: 84 | error("\"{}\" is not a valid json".format(args.snap2)) 85 | except: 86 | error("Failed to read snapshot file \"{}\"", args.snap2) 87 | 88 | if snap1_json['path'] != snap2_json['path']: 89 | error("Files paths do not match: \"{}\" and \"{}\"".format(snap1_json['path'], snap2_json['path'])) 90 | 91 | if snap1_json['scheme-version'] != snap2_json['scheme-version']: 92 | error("Scheme versions do not match: \"{}\" and \"{}\"".format(snap1_json['scheme-version'], 93 | snap2_json['scheme-version'])) 94 | 95 | results = [] 96 | for entry in snap1_json['entries']: 97 | if entry not in snap2_json['entries']: 98 | results.append('Element {} was removed'.format(entry)) 99 | 100 | elif snap1_json['entries'][entry] != snap2_json['entries'][entry]: 101 | results.append('Element {} was changed'.format(entry)) 102 | 103 | for entry in snap2_json['entries']: 104 | if entry not in snap1_json['entries']: 105 | results.append('Element {} was added'.format(entry)) 106 | 107 | results.sort() 108 | 109 | if not results: 110 | print("No changes") 111 | else: 112 | for line in results: 113 | print(line) 114 | 115 | 116 | def main(): 117 | parser = argparse.ArgumentParser(description='When called with snap argument, saves the state of the file system ' 118 | 'PATH as a json SNAP file which contains a list of named entries ' 119 | 'with a metadata for each file entry') 120 | parser.add_argument('-v', '--version', action='version', version=str(VERSION)) 121 | subparsers = parser.add_subparsers(dest='action') 122 | subparsers.required = True 123 | 124 | parser_snap = subparsers.add_parser('snap', help='saves the state of the file system PATH as a json SNAP file') 125 | parser_snap.add_argument('path', help='positional argument for snap. Path to directory which should be analyzed') 126 | parser_snap.add_argument('-f', '--filename', help="optional snapshot file name") 127 | parser_snap.set_defaults(func=snap) 128 | 129 | parser_diff = subparsers.add_parser('diff', help='compares two SNAP files and reports the changes') 130 | parser_diff.add_argument('snap1', help='positional argument for diff. Path to the first snapshot ' 131 | 'which was created using the snap command') 132 | parser_diff.add_argument('snap2', help='positional argument for diff. Path to the second snapshot ' 133 | 'which was created using the snap command') 134 | parser_diff.set_defaults(func=diff) 135 | 136 | args = parser.parse_args() 137 | args.func(args) 138 | 139 | 140 | if __name__ == '__main__': 141 | try: 142 | main() 143 | except KeyboardInterrupt: 144 | sys.exit(0) 145 | --------------------------------------------------------------------------------