AAMVA_Drivers_License_Decoder/aamva_2020.py at main · raleighlittles/AAMVA_Drivers_License_Decoder · GitHub

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
import typing

import pdb
import re

# locals
import constants
import aamva_fields


class AAMVA_Header_Exception(Exception):
    pass


def parse_pdf417_data(pdf_417_raw_data: typing.List[str]):

    parsed_data = list()

    data_elements = set([aamva_fields.JurisdictionSpecificVehicleClass(), aamva_fields.JurisdictionSpecificRestrictionCodes(), aamva_fields.JurisdictionSpecificEndorsementCodes(), aamva_fields.DocumentExpirationDate(), aamva_fields.CustomerFamilyName(), aamva_fields.CustomerFirstName(), aamva_fields.CustomerMiddleName(), aamva_fields.DocumentIssueDate(), aamva_fields.DateOfBirth(), aamva_fields.PhysicalDescriptionSex(), aamva_fields.PhysicalDescriptionEyeColor(), aamva_fields.PhysicalDescriptionHeight(), aamva_fields.AddressStreet1(), aamva_fields.AddressCity(), aamva_fields.AddressJurisdictionCode(), aamva_fields.AddressPostalCode(), aamva_fields.CustomerIDNumber(), aamva_fields.DocumentDiscriminator(), aamva_fields.CountryIdentification(), aamva_fields.FamilyNameTruncation(), aamva_fields.FirstNameTruncation(), aamva_fields.MiddleNameTruncation(), aamva_fields.AddressStreet2(), aamva_fields.HairColor(), aamva_fields.PlaceOfBirth(
    ), aamva_fields.AuditInformation(), aamva_fields.InventoryControlNumber(), aamva_fields.AliasFamilyName(), aamva_fields.AliasGivenName(), aamva_fields.AliasSuffixName(), aamva_fields.NameSuffix(), aamva_fields.PhysicalDescriptionWeightRange(), aamva_fields.RaceEthnicity(), aamva_fields.StandardVehicleClassification(), aamva_fields.StandardEndorsementCode(), aamva_fields.StandardRestrictionCode(), aamva_fields.JurisdictionSpecificVehicleClassificationDescription(), aamva_fields.JurisdictionSpecificEndorsementCodeDescription(), aamva_fields.JurisdictionSpecificRestrictionCodeDescription(), aamva_fields.ComplianceType(), aamva_fields.CardRevisionDate(), aamva_fields.HAZMAT_Endorsement_Expiration_Date(), aamva_fields.LimitedDurationDocumentIndicator(), aamva_fields.WeightPounds(), aamva_fields.WeightKilograms(), aamva_fields.Under18Until(), aamva_fields.Under21Until(), aamva_fields.OrganDonorIndicator(), aamva_fields.VeteranIndicator()])

    for idx, data_element in enumerate(data_elements):

        field_data = dict()

        for line in pdf_417_raw_data:
            regex_matches = re.findall(data_element.get_regex(), line.strip())
            if len(regex_matches) > 1:
                raise ValueError(
                    "Incorrect regex result, found too many values")

            elif len(regex_matches) == 1:
                data_element.value = regex_matches[0]
                print(f"Parsing field: '{data_element.key_name}'")
                parsed_value = data_element.parse()

                field_data["idx"] = idx
                field_data["key"] = data_element.code
                field_data["description"] = data_element.key_name
                field_data["value"] = data_element.value

                # Avoid adding the 'parsed' value field if its meaning is the same as the regular value
                if parsed_value != data_element.value:
                    field_data["parsed_value"] = parsed_value

                parsed_data.append(field_data)
                break

    print(f"Extracted {len(parsed_data)} elements from PDF 417 data")
    return parsed_data


def parse_header(pdf_417_raw_data: typing.List[str]) -> dict:

    if not pdf_417_raw_data[0].startswith(constants.COMPLIANCE_INDICATOR):
        raise AAMVA_Header_Exception("Compliance indicator missing")

    if not pdf_417_raw_data[1].startswith(constants.FILE_TYPE):
        raise AAMVA_Header_Exception("File type missing")

    header_dict = parse_ansi_field(pdf_417_raw_data[1].split(" ")[1])

    return header_dict


def parse_ansi_field(ansi_field_txt: str) -> dict:
    """
    Example ANSI field:
    "636000100002DL00410278ZV03190008DLDAQT64235789"

    The AAMVA specification defines a minimum number of aamva_fields that must be present in this string,
    but other states can add their own aamva_fields on top of that
    """

    issuer_id_num = ansi_field_txt[0: constants.ISSUER_ID_NUM_LEN]
    aamva_version_number = ansi_field_txt[constants.AAMVA_VERSION_NUMBER_START_OFFSET:
                                          constants.AAMVA_VERSION_NUMBER_END_OFFSET]
    jurisdiction_version_number = ansi_field_txt[constants.JURISDICTION_VERSION_NUMBER_START_OFFSET:
                                                 constants.JURISDICTION_VERSION_NUMBER_END_OFFSET]
    number_of_entries = ansi_field_txt[constants.NUMBER_OF_ENTRIES_START_OFFSET:
                                       constants.NUMBER_OF_ENTRIES_END_OFFSET]
    subfile_1_type = ansi_field_txt[constants.SUBFILE_1_TYPE_START_OFFSET: constants.SUBFILE_1_TYPE_END_OFFSET]
    offset_1_field = ansi_field_txt[constants.OFFSET_1_FIELD_START_OFFSET: constants.OFFSET_1_FIELD_END_OFFSET]
    length_1_field = ansi_field_txt[constants.LENGTH_1_FIELD_START_OFFSET: constants.LENGTH_1_FIELD_END_OFFSET]
    subfile_2_type = ansi_field_txt[constants.SUBFILE_2_TYPE_START_OFFSET: constants.SUBFILE_2_TYPE_END_OFFSET]
    offset_2_field = ansi_field_txt[constants.OFFSET_2_FIELD_START_OFFSET: constants.OFFSET_2_FIELD_END_OFFSET]
    length_2_field = ansi_field_txt[constants.LENGTH_2_FIELD_START_OFFSET: constants.LENGTH_2_FIELD_END_OFFSET]

    return dict({"issuer_id_num": issuer_id_num, "aamva_version_num": aamva_version_number, "jurisdiction_version_number": jurisdiction_version_number, "number_of_entries": number_of_entries, "subfile_1_type": subfile_1_type, "offset_1_field": offset_1_field, "length_1": length_1_field, "subfile_2_type": subfile_2_type, "offset_2_field": offset_2_field, "length_2": length_2_field})