[FL-1307] iButton key files: ASCII encoding and .ibtn extension (#493)

* GUI module submenu: fix documentation * GUI module submenu: add submenu_set_selected_item fn * App iButton: use submenu_set_selected_item to store and set selected item in submenu * App iButton: swap write and emulate in "saved key menu" scene * App iButton: file select can now switch to the previous selected file * App iButton: swap write and emulate indexes in "saved key menu" scene * Gui module file_select: work with separate extension * iButton app: separate file managment, file error handling * SD card api: custom error message * iButton app: better file error handling Co-authored-by: あく <alleteam@gmail.com>
2021-05-27 02:50:16 +10:00
parent 63e9207c44
commit 7e6a97c3a3
11 changed files with 297 additions and 101 deletions
--- a/applications/ibutton/ibutton-app.cpp
+++ b/applications/ibutton/ibutton-app.cpp
@@ -3,6 +3,9 @@
 #include <callback-connector.h>
 #include <m-string.h>

+const char* iButtonApp::app_folder = "ibutton";
+const char* iButtonApp::app_extension = ".ibtn";
+
 void iButtonApp::run(void) {
    iButtonEvent event;
    bool consumed;
@@ -381,4 +384,205 @@ void iButtonApp::generate_random_name(char* name, uint8_t max_name_size) {
        name, max_name_size, "%s_%s", prefix[rand() % prefix_size], suffix[rand() % suffix_size]);
    // to upper
    name[0] = name[0] - 0x20;
+}
+
+// file managment
+void iButtonApp::show_file_error_message(const char* error_text) {
+    set_text_store(error_text);
+    get_sd_ex_api()->show_error(get_sd_ex_api()->context, get_text_store());
+}
+
+bool iButtonApp::save_key(const char* key_name) {
+    File key_file;
+    string_t key_file_name;
+    bool result = false;
+    FS_Error fs_result;
+    uint16_t write_count;
+
+    // Create ibutton directory if necessary
+    fs_result = get_fs_api()->common.mkdir(app_folder);
+    if(fs_result != FSE_OK && fs_result != FSE_EXIST) {
+        show_file_error_message("Cannot create\napplication folder");
+        return false;
+    };
+
+    // First remove key if it was saved
+    string_init_set_str(key_file_name, app_folder);
+    string_cat_str(key_file_name, "/");
+    string_cat_str(key_file_name, get_key()->get_name());
+    string_cat_str(key_file_name, app_extension);
+    fs_result = get_fs_api()->common.remove(string_get_cstr(key_file_name));
+    if(fs_result != FSE_OK && fs_result != FSE_NOT_EXIST) {
+        string_clear(key_file_name);
+        show_file_error_message("Cannot remove\nold key file");
+        return false;
+    };
+
+    // Save the key
+    get_key()->set_name(key_name);
+    string_set_str(key_file_name, app_folder);
+    string_cat_str(key_file_name, "/");
+    string_cat_str(key_file_name, get_key()->get_name());
+    string_cat_str(key_file_name, app_extension);
+
+    bool res = get_fs_api()->file.open(
+        &key_file, string_get_cstr(key_file_name), FSAM_WRITE, FSOM_CREATE_ALWAYS);
+    string_clear(key_file_name);
+
+    if(res) {
+        // type header
+        const char* key_type = "E";
+
+        switch(get_key()->get_key_type()) {
+        case iButtonKeyType::KeyCyfral:
+            key_type = "C";
+            break;
+        case iButtonKeyType::KeyDallas:
+            key_type = "D";
+            break;
+        case iButtonKeyType::KeyMetakom:
+            key_type = "M";
+            break;
+        }
+
+        write_count = get_fs_api()->file.write(&key_file, key_type, 1);
+        if(key_file.error_id != FSE_OK || write_count != 1) {
+            show_file_error_message("Cannot write\nto key file");
+            get_fs_api()->file.close(&key_file);
+            return false;
+        }
+
+        const uint8_t byte_text_size = 4;
+        char byte_text[byte_text_size];
+
+        for(uint8_t i = 0; i < get_key()->get_type_data_size(); i++) {
+            sniprintf(byte_text, byte_text_size, " %02X", get_key()->get_data()[i]);
+            write_count = get_fs_api()->file.write(&key_file, byte_text, 3);
+            if(key_file.error_id != FSE_OK || write_count != 3) {
+                show_file_error_message("Cannot write\nto key file");
+                get_fs_api()->file.close(&key_file);
+                return false;
+            }
+        }
+        result = true;
+    } else {
+        show_file_error_message("Cannot create\nnew key file");
+    }
+
+    get_fs_api()->file.close(&key_file);
+    get_sd_ex_api()->check_error(get_sd_ex_api()->context);
+
+    return result;
+}
+
+bool iButtonApp::load_key() {
+    bool result = false;
+
+    // Input events and views are managed by file_select
+    bool res = get_sd_ex_api()->file_select(
+        get_sd_ex_api()->context,
+        app_folder,
+        app_extension,
+        get_file_name(),
+        get_file_name_size(),
+        get_key()->get_name());
+
+    if(res) {
+        string_t key_str;
+        File key_file;
+        uint16_t read_count;
+
+        // Get key file path
+        string_init_set_str(key_str, app_folder);
+        string_cat_str(key_str, "/");
+        string_cat_str(key_str, get_file_name());
+        string_cat_str(key_str, app_extension);
+
+        // Open key file
+        get_fs_api()->file.open(
+            &key_file, string_get_cstr(key_str), FSAM_READ, FSOM_OPEN_EXISTING);
+        string_clear(key_str);
+
+        if(key_file.error_id != FSE_OK) {
+            show_file_error_message("Cannot open\nkey file");
+            get_fs_api()->file.close(&key_file);
+            return false;
+        }
+
+        const uint8_t byte_text_size = 4;
+        char byte_text[byte_text_size] = {0, 0, 0, 0};
+
+        // load type header
+        read_count = get_fs_api()->file.read(&key_file, byte_text, 1);
+        if(key_file.error_id != FSE_OK || read_count != 1) {
+            show_file_error_message("Cannot read\nkey file");
+            get_fs_api()->file.close(&key_file);
+            return false;
+        }
+
+        iButtonKeyType key_type = iButtonKeyType::KeyCyfral;
+        if(strcmp(byte_text, "C") == 0) {
+            key_type = iButtonKeyType::KeyCyfral;
+        } else if(strcmp(byte_text, "M") == 0) {
+            key_type = iButtonKeyType::KeyMetakom;
+        } else if(strcmp(byte_text, "D") == 0) {
+            key_type = iButtonKeyType::KeyDallas;
+        } else {
+            show_file_error_message("Cannot parse\nkey file");
+            get_fs_api()->file.close(&key_file);
+            return false;
+        }
+
+        get_key()->set_type(key_type);
+
+        // load data
+        uint8_t key_data[IBUTTON_KEY_DATA_SIZE] = {0, 0, 0, 0, 0, 0, 0, 0};
+        for(uint8_t i = 0; i < get_key()->get_type_data_size(); i++) {
+            // space
+            read_count = get_fs_api()->file.read(&key_file, byte_text, 1);
+            if(key_file.error_id != FSE_OK || read_count != 1) {
+                show_file_error_message("Cannot read\nkey file");
+                get_fs_api()->file.close(&key_file);
+                return false;
+            }
+
+            // value
+            read_count = get_fs_api()->file.read(&key_file, byte_text, 2);
+            if(key_file.error_id != FSE_OK || read_count != 2) {
+                show_file_error_message("Cannot read\nkey file");
+                get_fs_api()->file.close(&key_file);
+                return false;
+            }
+
+            // convert hex value to byte
+            key_data[i] = strtol(byte_text, NULL, 16);
+        }
+
+        get_fs_api()->file.close(&key_file);
+
+        get_key()->set_name(get_file_name());
+        get_key()->set_type(key_type);
+        get_key()->set_data(key_data, IBUTTON_KEY_DATA_SIZE);
+
+        result = true;
+    }
+
+    get_sd_ex_api()->check_error(get_sd_ex_api()->context);
+
+    return result;
+}
+
+bool iButtonApp::delete_key() {
+    iButtonKey* key = get_key();
+    string_t key_file_name;
+    bool result = false;
+
+    string_init_set_str(key_file_name, app_folder);
+    string_cat_str(key_file_name, "/");
+    string_cat_str(key_file_name, key->get_name());
+    string_cat_str(key_file_name, app_extension);
+    result = (get_fs_api()->common.remove(string_get_cstr(key_file_name)) == FSE_OK);
+    string_clear(key_file_name);
+
+    return result;
 }
--- a/applications/ibutton/ibutton-app.h
+++ b/applications/ibutton/ibutton-app.h
@@ -115,6 +115,10 @@ public:

    void generate_random_name(char* name, uint8_t max_name_size);

+    bool save_key(const char* key_name);
+    bool load_key();
+    bool delete_key();
+
 private:
    std::list<Scene> previous_scenes_list = {Scene::SceneExit};
    Scene current_scene = Scene::SceneStart;
@@ -162,4 +166,9 @@ private:

    bool read_hex_byte(string_t arg, uint8_t* byte);
    void print_key_data(void);
+
+    static const char* app_folder;
+    static const char* app_extension;
+
+    void show_file_error_message(const char* error_text);
 };
--- a/applications/ibutton/scene/ibutton-scene-delete-confirm.cpp
+++ b/applications/ibutton/scene/ibutton-scene-delete-confirm.cpp
@@ -55,18 +55,8 @@ bool iButtonSceneDeleteConfirm::on_event(iButtonApp* app, iButtonEvent* event) {

    if(event->type == iButtonEvent::Type::EventTypeDialogResult) {
        if(event->payload.dialog_result == DialogExResultRight) {
-            iButtonKey* key = app->get_key();
-            string_t key_file_name;
-            string_init_set_str(key_file_name, "ibutton/");
-            string_cat_str(key_file_name, key->get_name());
-            bool res =
-                (app->get_fs_api()->common.remove(string_get_cstr(key_file_name)) == FSE_OK);
-            string_clear(key_file_name);
-            if(res) {
+            if(app->delete_key()) {
                app->switch_to_next_scene(iButtonApp::Scene::SceneDeleteSuccess);
-            } else {
-                // TODO error file path
-                // app->switch_to_next_scene(iButtonApp::Scene::SceneDeleteFail);
            }
        } else {
            app->switch_to_previous_scene();
--- a/applications/ibutton/scene/ibutton-scene-save-name.cpp
+++ b/applications/ibutton/scene/ibutton-scene-save-name.cpp
@@ -31,40 +31,14 @@ bool iButtonSceneSaveName::on_event(iButtonApp* app, iButtonEvent* event) {
    bool consumed = false;

    if(event->type == iButtonEvent::Type::EventTypeTextEditResult) {
-        iButtonKey* key = app->get_key();
-        File key_file;
-        string_t key_file_name;
-
-        // Create ibutton directory if necessary
-        app->get_fs_api()->common.mkdir("ibutton");
-
-        // First remove key if it was saved
-        string_init_set_str(key_file_name, "ibutton/");
-        string_cat_str(key_file_name, key->get_name());
-        app->get_fs_api()->common.remove(string_get_cstr(key_file_name));
-
-        // Save the key
-        key->set_name(app->get_text_store());
-        string_set_str(key_file_name, "ibutton/");
-        string_cat_str(key_file_name, app->get_text_store());
-        uint8_t key_data[IBUTTON_KEY_DATA_SIZE + 1];
-        key_data[0] = static_cast<uint8_t>(key->get_key_type());
-        memcpy(key_data + 1, key->get_data(), IBUTTON_KEY_DATA_SIZE);
-        bool res = app->get_fs_api()->file.open(
-            &key_file, string_get_cstr(key_file_name), FSAM_WRITE, FSOM_CREATE_ALWAYS);
-        // TODO process file system errors from file system service
-        if(res) {
-            res = app->get_fs_api()->file.write(&key_file, key_data, IBUTTON_KEY_DATA_SIZE + 1);
-            res = app->get_fs_api()->file.close(&key_file);
+        if(app->save_key(app->get_text_store())) {
            app->switch_to_next_scene(iButtonApp::Scene::SceneSaveSuccess);
        } else {
-            app->get_sd_ex_api()->check_error(app->get_sd_ex_api()->context);
            app->search_and_switch_to_previous_scene(
                {iButtonApp::Scene::SceneReadedKeyMenu,
                 iButtonApp::Scene::SceneSavedKeyMenu,
                 iButtonApp::Scene::SceneAddType});
        }
-        string_clear(key_file_name);
        consumed = true;
    }

--- a/applications/ibutton/scene/ibutton-scene-select-key.cpp
+++ b/applications/ibutton/scene/ibutton-scene-select-key.cpp
@@ -4,40 +4,8 @@
 #include "../ibutton-key.h"

 void iButtonSceneSelectKey::on_enter(iButtonApp* app) {
-    // Input events and views are managed by file_select
-    bool res = app->get_sd_ex_api()->file_select(
-        app->get_sd_ex_api()->context,
-        "ibutton",
-        "*",
-        app->get_file_name(),
-        app->get_file_name_size(),
-        app->get_key()->get_name());
-
    // Process file_select return
-    if(res) {
-        // Get key file path
-        string_t key_str;
-        string_init_set_str(key_str, "ibutton/");
-        string_cat_str(key_str, app->get_file_name());
-
-        // Read data from file
-        File key_file;
-        uint8_t key_data[IBUTTON_KEY_DATA_SIZE + 1] = {};
-        // TODO process false result from file system service
-        app->get_fs_api()->file.open(
-            &key_file, string_get_cstr(key_str), FSAM_READ, FSOM_OPEN_EXISTING);
-        app->get_fs_api()->file.read(&key_file, key_data, IBUTTON_KEY_DATA_SIZE + 1);
-        app->get_fs_api()->file.close(&key_file);
-        string_clear(key_str);
-
-        // Set key data
-        iButtonKeyType key_type = static_cast<iButtonKeyType>(key_data[0]);
-        if(key_type > iButtonKeyType::KeyMetakom) {
-            app->switch_to_next_scene(iButtonApp::Scene::SceneStart);
-        }
-        app->get_key()->set_name(app->get_file_name());
-        app->get_key()->set_type(key_type);
-        app->get_key()->set_data(key_data + 1, IBUTTON_KEY_DATA_SIZE);
+    if(app->load_key()) {
        app->switch_to_next_scene(iButtonApp::Scene::SceneSavedKeyMenu);
    } else {
        app->switch_to_previous_scene();