1

#!/usr/bin/env python

     2

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

     3

     4

# See COPYING file for copyrights details.

     5

     6

from __future__ import absolute_import

     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 = range(4)

    15

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

    16

    17

def _pskpath(project_path):

    18

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

    19

    20

def _mgtpath(project_path):

    21

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

    22

    23

def _ensurePSKdir(project_path):

    24

    pskpath = _pskpath(project_path)

    25

    if not os.path.exists(pskpath):

    26

        os.mkdir(pskpath)

    27

    return pskpath

    28

    29

def _default(ID):

    30

    return [ID,

    31

            '', # default description

    32

            None, # last known URI

    33

            None]  # last connection date

    34

    35

def _dataByID(data):

    36

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

    37

    38

def _LoadData(project_path):

    39

    """ load known keys metadata """

    40

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

    41

        _path = _mgtpath(project_path)

    42

        if os.path.exists(_path):

    43

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

    44

    return []

    45

    46

def _filterData(psk_files, data_input):

    47

    input_by_ID = _dataByID(data_input)

    48

    output = []

    49

    # go through all secret files available an build data

    50

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

    51

    # this implicitly filters IDs out of metadata who's

    52

    # secret is missing

    53

    for filename in psk_files:

    54

       if filename.endswith('.secret'):

    55

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

    56

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

    57

    return output

    58

    59

def GetData(project_path):

    60

    loaded_data = _LoadData(project_path)

    61

    if loaded_data:

    62

        psk_files = os.listdir(_pskpath(project_path))

    63

        return _filterData(psk_files, loaded_data)

    64

    return []

    65

    66

def DeleteID(project_path, ID):

    67

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

    68

    os.remove(secret_path)

    69

    70

def SaveData(project_path, data):

    71

    _ensurePSKdir(project_path)

    72

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

    73

        f.write(json.dumps(data))

    74

    75

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

    76

    pskpath = _ensurePSKdir(project_path)

    77

    if not os.path.exists(pskpath):

    78

        os.mkdir(pskpath)

    79

    80

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

    81

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

    82

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

    83

    84

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

    85

    data = _LoadData(project_path)

    86

    idata = _dataByID(data)

    87

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

    88

    89

    _is_new_ID = dataForID is None

    90

    if _is_new_ID:

    91

       dataForID = _default(ID)

    92

    93

    dataForID[COL_URI] = URI

    94

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

    95

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

    96

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

    97

    98

    if _is_new_ID:

    99

        data.append(dataForID)

   100

   101

    SaveData(project_path, data)

   102

   103

def ExportIDs(project_path, export_zip):

   104

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

   105

        path = _pskpath(project_path)

   106

        for nm in os.listdir(path):

   107

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

   108

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

   109

   110

def ImportIDs(project_path, import_zip, should_I_replace_callback):

   111

    zf = ZipFile(import_zip, 'r')

   112

    data = GetData(project_path)

   113

   114

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

   115

    name_list = zf.namelist()

   116

    zip_filtered_data = _filterData(name_list, zip_loaded_data)

   117

   118

    idata = _dataByID(data)

   119

   120

    keys_to_import = []

   121

    result = None

   122

   123

    for imported_row in zip_filtered_data:

   124

        ID = imported_row[COL_ID]

   125

        existing_row = idata.get(ID, None)

   126

        if existing_row is None:

   127

            data.append(imported_row)

   128

        else:

   129

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

   130

            if result not in [REPLACE_ALL, KEEP_ALL]:

   131

                result = should_I_replace_callback(existing_row, imported_row)

   132

   133

            if result == CANCEL:

   134

                return

   135

   136

            if result in [REPLACE_ALL, REPLACE]:

   137

                # replace with imported

   138

                existing_row[:] = imported_row

   139

                # copy the key of selected

   140

                keys_to_import.append(ID)

   141

   142

    for ID in keys_to_import:

   143

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

   144

   145

    SaveData(project_path, data)

   146

   147

    return data

   148

   149