verify_eol.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
MakeHuman source tree end-of-line (EOL) verification

**Project Name:**      MakeHuman

**Product Home Page:** http://www.makehumancommunity.org/

**Github Code Home Page:**    https://github.com/makehumancommunity/

**Authors:**           Jonas Hauquier

**Copyright(c):**      MakeHuman Team 2001-2019

**Licensing:**         AGPL3

    This file is part of MakeHuman (www.makehumancommunity.org).

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero 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 Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.


Abstract
--------

Validate the MH source code and detect and report any files containing windows
line endings.
"""

import sys
import os
import mimetypes

EXCLUDE_FOLDERS = ['.hg']

mimetypes.add_type('text/mhfile', '.mhclo')
mimetypes.add_type('text/mhfile', '.proxy')
mimetypes.add_type('text/mhfile', '.mhmat')
mimetypes.add_type('text/mhfile', '.obj')
mimetypes.add_type('text/mhfile', '.json')
mimetypes.add_type('text/mhfile', '.mhm')
mimetypes.add_type('text/mhfile', '.bvh')
mimetypes.add_type('text/mhfile', '.rig')
mimetypes.add_type('text/mhfile', '.target')

def check_dos_eol(path):
    global _recurse_files
    result = []
    for f in _recurse_get_ascii_files(path):
        if "\r\n" in open(f, 'r').read():
            result.append( f )
    return result

def fix_dos_eol(filepaths):
    for f in filepaths:
        fh = open(f, 'r')
        contents = fh.read()
        fh.close()
        contents = contents.replace('\r\n', '\n')
        contents = contents.replace('\r', '\n')
        fh = open(f, 'wb')
        fh.write(contents)
        fh.close()

def _isASCII(filepath):
    mtype = mimetypes.guess_type(filepath)[0]
    if mtype:
        return mtype.split("/")[0] == "text"
    else:
        return None

def _recurse_get_ascii_files(path, result = None):
    """
    Recurse specified path, return list of all files.
    """
    global _isASCII
    if result is None:
        result = []
    if os.path.isdir(path):
        if os.path.basename(path) not in EXCLUDE_FOLDERS:
            files = os.listdir(path)
            for f in files:
                _recurse_get_ascii_files(os.path.join(path, f), result)
    elif os.path.isfile(path):
        if _isASCII(path):
            result.append(path)
    return result


def _parse_args():
    if len(sys.argv) < 2:
        return dict()

    import argparse    # requires python >= 2.7
    parser = argparse.ArgumentParser()

    # optional arguments
    parser.add_argument("--fix", action="store_true", help="Fix line endings of encountered files")

    # positional arguments
    parser.add_argument("path", default=None, nargs='?', help="Path to folder or file to check")

    argOptions = vars(parser.parse_args())
    return argOptions


if __name__ == '__main__':
    args = _parse_args()

    if args.get('path', None) is None:
        raise RuntimeError("path argument not specified")

    path = args['path']
    fix = args.get('fix', False)
    detected = check_dos_eol(path)
    if len(detected) > 0:
        print("Files containing DOS line endings:")
        print("\n".join( detected ))

    if fix:
        print("\nFixing files...")
        fix_dos_eol(detected)
        print("All done")
    else:
        if len(detected) > 0:
            sys.exit(1)
        else:
            sys.exit(0)