Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 1 | # coding=utf-8 |
Harald Welte | 90d3b97 | 2021-04-03 08:56:21 +0200 | [diff] [blame] | 2 | """Abstraction of card related data that can be queried from external source.""" |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 3 | |
Harald Welte | 90d3b97 | 2021-04-03 08:56:21 +0200 | [diff] [blame] | 4 | # (C) 2021 by Sysmocom s.f.m.c. GmbH |
| 5 | # All Rights Reserved |
| 6 | # |
| 7 | # Author: Philipp Maier |
| 8 | # |
| 9 | # This program is free software: you can redistribute it and/or modify |
| 10 | # it under the terms of the GNU General Public License as published by |
| 11 | # the Free Software Foundation, either version 2 of the License, or |
| 12 | # (at your option) any later version. |
| 13 | # |
| 14 | # This program is distributed in the hope that it will be useful, |
| 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 | # GNU General Public License for more details. |
| 18 | # |
| 19 | # You should have received a copy of the GNU General Public License |
| 20 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 21 | |
Harald Welte | 90d3b97 | 2021-04-03 08:56:21 +0200 | [diff] [blame] | 22 | from typing import List, Dict, Optional |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 23 | |
| 24 | import csv |
| 25 | |
Harald Welte | 4442b3d | 2021-04-03 09:00:16 +0200 | [diff] [blame^] | 26 | card_key_providers = [] # type: List[CardData] |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 27 | |
Harald Welte | 4442b3d | 2021-04-03 09:00:16 +0200 | [diff] [blame^] | 28 | class CardKeyProvider(object): |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 29 | |
Philipp Maier | 46f09af | 2021-03-25 20:24:27 +0100 | [diff] [blame] | 30 | VALID_FIELD_NAMES = ['ICCID', 'ADM1', 'IMSI', 'PIN1', 'PIN2', 'PUK1', 'PUK2'] |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 31 | |
| 32 | # check input parameters, but do nothing concrete yet |
Harald Welte | 90d3b97 | 2021-04-03 08:56:21 +0200 | [diff] [blame] | 33 | def get_data(self, fields:List[str]=[], key:str='ICCID', value:str="") -> Dict[str,str]: |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 34 | """abstract implementation of get_data that only verifies the function parameters""" |
| 35 | |
| 36 | for f in fields: |
| 37 | if (f not in self.VALID_FIELD_NAMES): |
| 38 | raise ValueError("Requested field name '%s' is not a valid field name, valid field names are: %s" % |
| 39 | (f, str(self.VALID_FIELD_NAMES))) |
| 40 | |
| 41 | if (key not in self.VALID_FIELD_NAMES): |
| 42 | raise ValueError("Key field name '%s' is not a valid field name, valid field names are: %s" % |
| 43 | (key, str(self.VALID_FIELD_NAMES))) |
| 44 | |
| 45 | return {} |
| 46 | |
Harald Welte | 90d3b97 | 2021-04-03 08:56:21 +0200 | [diff] [blame] | 47 | def get_field(self, field:str, key:str='ICCID', value:str="") -> Optional[str]: |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 48 | """get a single field from CSV file using a specified key/value pair""" |
| 49 | fields = [field] |
| 50 | result = self.get(fields, key, value) |
| 51 | return result.get(field) |
| 52 | |
Harald Welte | 90d3b97 | 2021-04-03 08:56:21 +0200 | [diff] [blame] | 53 | def get(self, fields:List[str], key:str, value:str) -> Dict[str,str]: |
| 54 | """get fields from CSV file using a specified key/value pair""" |
| 55 | pass |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 56 | |
Harald Welte | 4442b3d | 2021-04-03 09:00:16 +0200 | [diff] [blame^] | 57 | class CardKeyProviderCsv(CardKeyProvider): |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 58 | """card data class that allows the user to query against a specified CSV file""" |
| 59 | csv_file = None |
| 60 | filename = None |
| 61 | |
Harald Welte | 90d3b97 | 2021-04-03 08:56:21 +0200 | [diff] [blame] | 62 | def __init__(self, filename:str): |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 63 | self.csv_file = open(filename, 'r') |
| 64 | if not self.csv_file: |
| 65 | raise RuntimeError("Could not open CSV-File '%s'" % filename) |
| 66 | self.filename = filename |
| 67 | |
Harald Welte | 90d3b97 | 2021-04-03 08:56:21 +0200 | [diff] [blame] | 68 | def get(self, fields:List[str], key:str, value:str) -> Dict[str,str]: |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 69 | """get fields from CSV file using a specified key/value pair""" |
| 70 | super().get_data(fields, key, value) |
| 71 | |
| 72 | self.csv_file.seek(0) |
| 73 | cr = csv.DictReader(self.csv_file) |
| 74 | if not cr: |
| 75 | raise RuntimeError("Could not open DictReader for CSV-File '%s'" % self.filename) |
| 76 | cr.fieldnames = [ field.upper() for field in cr.fieldnames ] |
| 77 | |
| 78 | rc = {} |
| 79 | for row in cr: |
| 80 | if row[key] == value: |
| 81 | for f in fields: |
| 82 | if f in row: |
| 83 | rc.update({f : row[f]}) |
| 84 | else: |
| 85 | raise RuntimeError("CSV-File '%s' lacks column '%s'" % |
| 86 | (self.filename, f)) |
| 87 | return rc |
| 88 | |
| 89 | |
Harald Welte | 4442b3d | 2021-04-03 09:00:16 +0200 | [diff] [blame^] | 90 | def card_key_provider_register(provider:CardKeyProvider, provider_list=card_key_providers): |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 91 | """Register a new card data provider""" |
Harald Welte | 4442b3d | 2021-04-03 09:00:16 +0200 | [diff] [blame^] | 92 | if not isinstance(provider, CardKeyProvider): |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 93 | raise ValueError("provider is not a card data provier") |
| 94 | provider_list.append(provider) |
| 95 | |
| 96 | |
Harald Welte | 4442b3d | 2021-04-03 09:00:16 +0200 | [diff] [blame^] | 97 | def card_key_provider_get(fields, key:str, value:str, provider_list=card_key_providers) -> Dict[str,str]: |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 98 | """Query all registered card data providers""" |
| 99 | for p in provider_list: |
Harald Welte | 4442b3d | 2021-04-03 09:00:16 +0200 | [diff] [blame^] | 100 | if not isinstance(p, CardKeyProvider): |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 101 | raise ValueError("provider list contains provider, which is not a card data provier") |
| 102 | result = p.get(fields, key, value) |
| 103 | if result: |
| 104 | return result |
| 105 | return {} |
| 106 | |
| 107 | |
Harald Welte | 4442b3d | 2021-04-03 09:00:16 +0200 | [diff] [blame^] | 108 | def card_key_provider_get_field(field:str, key:str, value:str, provider_list=card_key_providers) -> Optional[str]: |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 109 | """Query all registered card data providers for a single field""" |
| 110 | for p in provider_list: |
Harald Welte | 4442b3d | 2021-04-03 09:00:16 +0200 | [diff] [blame^] | 111 | if not isinstance(p, CardKeyProvider): |
Philipp Maier | 2b11c32 | 2021-03-17 12:37:39 +0100 | [diff] [blame] | 112 | raise ValueError("provider list contains provider, which is not a card data provier") |
| 113 | result = p.get_field(field, key, value) |
| 114 | if result: |
| 115 | return result |
| 116 | return None |
| 117 | |