aboutsummaryrefslogtreecommitdiff
path: root/gn3/file_utils.py
blob: cda4f2b4c0b4e3fbbed355abe22ac8faf5a89566 (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
"""Procedures that operate on files/ directories"""
import hashlib
import json
import os
import shutil
import random
import string
import tarfile

from functools import partial
from typing import Dict
from werkzeug.utils import secure_filename
from gn3.settings import APP_DEFAULTS


def get_dir_hash(directory: str) -> str:
    """Return the hash of a DIRECTORY"""
    md5hash = hashlib.md5()
    if not os.path.exists(directory):
        raise FileNotFoundError
    for root, _, files in os.walk(directory):
        for names in sorted(files):
            file_path = os.path.join(root, names)
            with open(file_path, "rb") as file_:
                for buf in iter(partial(file_.read, 4096), b''):
                    md5hash.update(bytearray(hashlib.md5(buf).hexdigest(),
                                             "utf-8"))
    return md5hash.hexdigest()


def lookup_file(environ_var: str,
                root_dir: str,
                file_name: str) -> str:
    """Look up FILE_NAME in the path defined by ENVIRON_VAR/ROOT_DIR/; If
ENVIRON_VAR/ROOT_DIR/FILE_NAME does not exist, raise an exception.
Otherwise return ENVIRON_VAR/ROOT_DIR/FILE_NAME.

    """
    _dir = APP_DEFAULTS.get(environ_var,
                            os.environ.get(environ_var))
    if _dir:
        _file = os.path.join(_dir, root_dir, file_name)
        if os.path.isfile(_file):
            return _file
    raise FileNotFoundError


def jsonfile_to_dict(json_file: str) -> Dict:
    """Give a JSON_FILE, return a python dict"""
    with open(json_file) as _file:
        data = json.load(_file)
        return data
    raise FileNotFoundError


def generate_random_n_string(n_length: int) -> str:
    """Generate a random string that is N chars long"""
    return ''.join(random.choice(string.ascii_uppercase + string.digits)
                   for _ in range(n_length))


def extract_uploaded_file(gzipped_file, target_dir: str) -> Dict:
    """Get the (directory) hash of extracted contents of GZIPPED_FILE; and move
contents to TARGET_DIR/<dir-hash>.

    """
    tar_target_loc = os.path.join(target_dir,
                                  secure_filename(gzipped_file.filename))
    gzipped_file.save(tar_target_loc)
    try:
        # Extract to "tar_target_loc/tempdir"
        tar = tarfile.open(tar_target_loc)
        tar.extractall(
            path=os.path.join(target_dir, "tempdir"))
        tar.close()
    # pylint: disable=W0703
    except Exception:
        return {"status": 128, "error": "gzip failed to unpack file"}
    dir_hash = get_dir_hash(tar_target_loc)
    if os.path.exists(os.path.join(target_dir, dir_hash)):
        shutil.rmtree(os.path.join(target_dir, 'tempdir'))
    else:
        os.rename(os.path.join(target_dir, "tempdir"),
                  os.path.join(target_dir, dir_hash))
    return {"status": 0, "token": dir_hash}