1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# See COPYING file for copyrights details.

     5

     6

     7

import os

     8

import time

     9

import json

    10

from zipfile import ZipFile

    11

    12

# PSK Management Data model :

    13

# [[ID,Desc, LastKnownURI, LastConnect]]

    14

COL_ID, COL_URI, COL_DESC, COL_LAST = list(range(4))

    15

REPLACE, REPLACE_ALL, KEEP, KEEP_ALL, CANCEL = list(range(5))

    16

    17

    18

def _pskpath(project_path):

    19

    return os.path.join(project_path, 'psk')

    20

    21

    22

def _mgtpath(project_path):

    23

    return os.path.join(_pskpath(project_path), 'management.json')

    24

    25

    26

def _ensurePSKdir(project_path):

    27

    pskpath = _pskpath(project_path)

    28

    if not os.path.exists(pskpath):

    29

        os.mkdir(pskpath)

    30

    return pskpath

    31

    32

    33

def _default(ID):

    34

    return [ID,

    35

            '',  # default description

    36

            None,  # last known URI

    37

            None]  # last connection date

    38

    39

    40

def _dataByID(data):

    41

    return {row[COL_ID]: row for row in data}

    42

    43

    44

def _LoadData(project_path):

    45

    """ load known keys metadata """

    46

    if os.path.isdir(_pskpath(project_path)):

    47

        _path = _mgtpath(project_path)

    48

        if os.path.exists(_path):

    49

            return json.loads(open(_path).read())

    50

    return []

    51

    52

    53

def _filterData(psk_files, data_input):

    54

    input_by_ID = _dataByID(data_input)

    55

    output = []

    56

    # go through all secret files available an build data

    57

    # out of data recoverd from json and list of secret.

    58

    # this implicitly filters IDs out of metadata who's

    59

    # secret is missing

    60

    for filename in psk_files:

    61

        if filename.endswith('.secret'):

    62

            ID = filename[:-7]  # strip filename extension

    63

            output.append(input_by_ID.get(ID, _default(ID)))

    64

    return output

    65

    66

    67

def GetData(project_path):

    68

    loaded_data = _LoadData(project_path)

    69

    if loaded_data:

    70

        psk_files = os.listdir(_pskpath(project_path))

    71

        return _filterData(psk_files, loaded_data)

    72

    return []

    73

    74

    75

def DeleteID(project_path, ID):

    76

    secret_path = os.path.join(_pskpath(project_path), ID+'.secret')

    77

    os.remove(secret_path)

    78

    79

    80

def SaveData(project_path, data):

    81

    _ensurePSKdir(project_path)

    82

    with open(_mgtpath(project_path), 'w') as f:

    83

        f.write(json.dumps(data))

    84

    85

    86

def UpdateID(project_path, ID, secret, URI):

    87

    pskpath = _ensurePSKdir(project_path)

    88

    if not os.path.exists(pskpath):

    89

        os.mkdir(pskpath)

    90

    91

    secpath = os.path.join(pskpath, ID+'.secret')

    92

    with open(secpath, 'w') as f:

    93

        f.write(ID+":"+secret)

    94

    95

    # here we directly use _LoadData, avoiding filtering that could be long

    96

    data = _LoadData(project_path)

    97

    idata = _dataByID(data)

    98

    dataForID = idata.get(ID, None) if data else None

    99

   100

    _is_new_ID = dataForID is None

   101

    if _is_new_ID:

   102

        dataForID = _default(ID)

   103

   104

    dataForID[COL_URI] = URI

   105

    # FIXME : could store time instead os a string and use DVC model's cmp

   106

    # then date display could be smarter, etc - sortable sting hack for now

   107

    dataForID[COL_LAST] = time.strftime('%y/%M/%d-%H:%M:%S')

   108

   109

    if _is_new_ID:

   110

        data.append(dataForID)

   111

   112

    SaveData(project_path, data)

   113

   114

   115

def ExportIDs(project_path, export_zip):

   116

    with ZipFile(export_zip, 'w') as zf:

   117

        path = _pskpath(project_path)

   118

        for nm in os.listdir(path):

   119

            if nm.endswith('.secret') or nm == 'management.json':

   120

                zf.write(os.path.join(path, nm), nm)

   121

   122

   123

def ImportIDs(project_path, import_zip, should_I_replace_callback):

   124

    zf = ZipFile(import_zip, 'r')

   125

    data = GetData(project_path)

   126

   127

    zip_loaded_data = json.loads(zf.open('management.json').read())

   128

    name_list = zf.namelist()

   129

    zip_filtered_data = _filterData(name_list, zip_loaded_data)

   130

   131

    idata = _dataByID(data)

   132

   133

    keys_to_import = []

   134

    result = None

   135

   136

    for imported_row in zip_filtered_data:

   137

        ID = imported_row[COL_ID]

   138

        existing_row = idata.get(ID, None)

   139

        if existing_row is None:

   140

            data.append(imported_row)

   141

        else:

   142

            # callback returns the selected list for merge or none if canceled

   143

            if result not in [REPLACE_ALL, KEEP_ALL]:

   144

                result = should_I_replace_callback(existing_row, imported_row)

   145

   146

            if result == CANCEL:

   147

                return

   148

   149

            if result in [REPLACE_ALL, REPLACE]:

   150

                # replace with imported

   151

                existing_row[:] = imported_row

   152

                # copy the key of selected

   153

                keys_to_import.append(ID)

   154

   155

    for ID in keys_to_import:

   156

        zf.extract(ID+".secret", _pskpath(project_path))

   157

   158

    SaveData(project_path, data)

   159

   160

    return data