Implemented #26 (#27)

* Implemented #26 
* Improved HID worker shutdown code
* Refactoring

Author: akopachov

build.ps1

@@ -6,19 +6,27 @@ function Get-LatestDirectory {
     Get-ChildItem -Path $Path | Where-Object {$_.PSIsContainer} | Sort-Object LastWriteTime -Descending | Select-Object -First 1
 }
 
+Push-Location $PSScriptRoot
+
+$official_build_path = "flipperzero-firmware_official\build"
+$unleashed_build_path = "flipperzero-firmware_unleashed\build"
+
+Remove-Item "$official_build_path\*" -Recurse -Force
+Remove-Item "$unleashed_build_path\*" -Recurse -Force
+
 ./fbt u COMPACT=1 DEBUG=0 VERBOSE=0 fap_totp
 ./fbt o COMPACT=1 DEBUG=0 VERBOSE=0 fap_totp
 
-Push-Location $PSScriptRoot
-
 if (!(Test-Path -PathType Container "build")) {
     New-Item -ItemType Directory -Path "build"
+} else {
+    Remove-Item "build\*" -Recurse -Force
 }
 
-$official_latest_dir = Get-LatestDirectory -Path "flipperzero-firmware_official\build\"
-Copy-Item "flipperzero-firmware_official\build\$official_latest_dir\.extapps\totp.fap" -Destination "build\totp_official-fw.fap"
+$official_latest_dir = Get-LatestDirectory -Path $official_build_path
+Copy-Item "$official_build_path\$official_latest_dir\.extapps\totp.fap" -Destination "build\totp_official-fw.fap"
 
-$unleashed_latest_dir = Get-LatestDirectory -Path "flipperzero-firmware_unleashed\build\"
-Copy-Item "flipperzero-firmware_unleashed\build\$unleashed_latest_dir\.extapps\totp.fap" -Destination "build\totp_unleashed-fw.fap"
+$unleashed_latest_dir = Get-LatestDirectory -Path $unleashed_build_path
+Copy-Item "$unleashed_build_path\$unleashed_latest_dir\.extapps\totp.fap" -Destination "build\totp_unleashed-fw.fap"
 
 Pop-Location

docs/conf-file_description.md

@@ -46,7 +46,7 @@ File format is standard for Flipper Zero device. Each line has one setting ident
 
 **Default value:** 0.000000
 
-**Description:** Timezone offset **in hours**. Need to be modified manually. Because of Flipper Zero API doesn't provide an access to timezone offset it is necessary to set it manually for correct TOTP tokens generation. You may find you timezone offset (or another name is "UTC offset") [here](https://www.timeanddate.com/time/zone/timezone/utc) or on any other website found in google.
+**Description:** Timezone offset **in hours**. Need to be modified manually. Because of Flipper Zero API doesn't provide an access to timezone offset it is necessary to set it manually for correct TOTP tokens generation. You may find your timezone offset (or another name is "UTC offset") [here](https://www.timeanddate.com/time/zone/timezone/utc) or on any other website found in google.
 **Important note: if your timezone offset is negative, use negative sign, like this `-2.0`, however if your timezone offset is positive DO NOT use explicit positive sign, just put offset without any sign like this `2.0`**
 
 ### TokenName

flipperzero-firmware_official

@@ -101,7 +101,7 @@ bool totp_scene_app_settings_handle_event(
     }
 
     SceneState* scene_state = (SceneState*)plugin_state->current_scene_state;
-    if(event->input.type != InputTypePress) {
+    if(event->input.type != InputTypePress && event->input.type != InputTypeRepeat) {
         return true;
     }
 

flipperzero-firmware_unleashed

@@ -293,7 +293,7 @@ bool totp_scene_generate_token_handle_event(
         return true;
     }
 
-    if(event->input.type != InputTypePress) {
+    if(event->input.type != InputTypePress && event->input.type != InputTypeRepeat) {
         return true;
     }
 

totp/scenes/app_settings/totp_app_settings.c

@@ -5,12 +5,46 @@
 #include "../types/plugin_event.h"
 #include "totp_scenes_enum.h"
 
+/**
+ * @brief Activates scene
+ * @param plugin_state application state
+ * @param scene scene to be activated
+ * @param context scene context to be passed to the scene activation method
+ */
 void totp_scene_director_activate_scene(
     PluginState* const plugin_state,
     Scene scene,
     const void* context);
+
+/**
+ * @brief Deactivate current scene
+ * @param plugin_state application state
+ */
 void totp_scene_director_deactivate_active_scene(PluginState* const plugin_state);
+
+/**
+ * @brief Initializes all the available scenes
+ * @param plugin_state application state
+ */
 void totp_scene_director_init_scenes(PluginState* const plugin_state);
+
+/**
+ * @brief Renders current scene
+ * @param canvas canvas to render at
+ * @param plugin_state application state
+ */
 void totp_scene_director_render(Canvas* const canvas, PluginState* const plugin_state);
+
+/**
+ * @brief Disposes all the available scenes
+ * @param plugin_state application state
+ */
 void totp_scene_director_dispose(const PluginState* const plugin_state);
+
+/**
+ * @brief Handles application event for the current scene
+ * @param event event to be handled
+ * @param plugin_state application state
+ * @return \c true if event handled and applilcation should continue; \c false if application should be closed
+ */
 bool totp_scene_director_handle_event(PluginEvent* const event, PluginState* const plugin_state);

totp/scenes/generate_token/totp_scene_generate_token.c

@@ -147,13 +147,14 @@ bool totp_scene_token_menu_handle_event(const PluginEvent* const event, PluginSt
             dialog_message_free(message);
             if(dialog_result == DialogMessageButtonRight &&
                !scene_state->current_token_index.is_null) {
-                ListNode* list_node = list_element_at(
-                    plugin_state->tokens_list, scene_state->current_token_index.value);
-
-                TokenInfo* tokenInfo = list_node->data;
-                token_info_free(tokenInfo);
-                plugin_state->tokens_list = list_remove(plugin_state->tokens_list, list_node);
+                TokenInfo* tokenInfo = NULL;
+                plugin_state->tokens_list = list_remove_at(
+                    plugin_state->tokens_list,
+                    scene_state->current_token_index.value,
+                    (void**)&tokenInfo);
                 plugin_state->tokens_count--;
+                furi_check(tokenInfo != NULL);
+                token_info_free(tokenInfo);
 
                 totp_full_save_config_file(plugin_state);
                 totp_scene_director_activate_scene(plugin_state, TotpSceneGenerateToken, NULL);

totp/scenes/scene_director.h

@@ -1,10 +1,36 @@
 #pragma once
 
+/**
+ * @brief TOTP application scenes
+ */
 typedef enum {
+    /**
+     * @brief Empty scene which does nothing 
+     */
     TotpSceneNone,
+
+    /**
+     * @brief Scene where user have to enter PIN to authenticate 
+     */
     TotpSceneAuthentication,
+
+    /**
+     * @brief Scene where actual TOTP token is getting generated and displayed to the user 
+     */
     TotpSceneGenerateToken,
+
+    /**
+     * @brief Scene where user can add new token 
+     */
     TotpSceneAddNewToken,
+
+    /**
+     * @brief Scene with a menu for given token, allowing user to do multiple actions
+     */
     TotpSceneTokenMenu,
+
+    /**
+     * @brief Scene where user can change application settings 
+     */
     TotpSceneAppSettings
 } Scene;

totp/scenes/token_menu/totp_scene_token_menu.c

@@ -15,8 +15,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#include <string.h>
-
 #include "base32.h"
 
 int base32_decode(const uint8_t* encoded, uint8_t* result, int bufSize) {

totp/scenes/totp_scenes_enum.h

@@ -29,5 +29,11 @@
 
 #include <stdint.h>
 
-int base32_decode(const uint8_t* encoded, uint8_t* result, int bufSize)
-    __attribute__((visibility("hidden")));
+/**
+ * @brief Decodes Base-32 encoded bytes into plain bytes.
+ * @param encoded Base-32 encoded bytes
+ * @param[out] result result output buffer
+ * @param bufSize result output buffer size
+ * @return Decoded result length in bytes if successfully decoded; \c -1 otherwise
+ */
+int base32_decode(const uint8_t* encoded, uint8_t* result, int bufSize);

totp/services/base32/base32.c

@@ -8,6 +8,7 @@
 #include "commands/delete/delete.h"
 #include "commands/timezone/timezone.h"
 #include "commands/help/help.h"
+#include "commands/move/move.h"
 
 static void totp_cli_print_unknown_command(const FuriString* unknown_command) {
     TOTP_CLI_PRINTF(
@@ -44,6 +45,10 @@ static void totp_cli_handler(Cli* cli, FuriString* args, void* context) {
         furi_string_cmp_str(cmd, TOTP_CLI_COMMAND_TIMEZONE) == 0 ||
         furi_string_cmp_str(cmd, TOTP_CLI_COMMAND_TIMEZONE_ALT) == 0) {
         totp_cli_command_timezone_handle(plugin_state, args, cli);
+    } else if(
+        furi_string_cmp_str(cmd, TOTP_CLI_COMMAND_MOVE) == 0 ||
+        furi_string_cmp_str(cmd, TOTP_CLI_COMMAND_MOVE_ALT) == 0) {
+        totp_cli_command_move_handle(plugin_state, args, cli);
     } else {
         totp_cli_print_unknown_command(cmd);
     }

totp/services/base32/base32.h

@@ -175,6 +175,8 @@ void totp_cli_command_add_handle(PluginState* plugin_state, FuriString* args, Cl
         } else if(furi_string_cmpi_str(temp_str, TOTP_CLI_COMMAND_ADD_ARG_UNSECURE_PREFIX) == 0) {
             mask_user_input = false;
             parsed = true;
+        } else {
+            TOTP_CLI_PRINTF("Unknown argument \"%s\"\r\n", furi_string_get_cstr(temp_str));
         }
 
         if(!parsed) {

totp/services/cli/cli.c

@@ -4,6 +4,7 @@
 #include "../delete/delete.h"
 #include "../list/list.h"
 #include "../timezone/timezone.h"
+#include "../move/move.h"
 
 void totp_cli_command_help_docopt_commands() {
     TOTP_CLI_PRINTF("  " TOTP_CLI_COMMAND_HELP ", " TOTP_CLI_COMMAND_HELP_ALT
@@ -23,13 +24,15 @@ void totp_cli_command_help_handle() {
     totp_cli_command_add_docopt_usage();
     totp_cli_command_delete_docopt_usage();
     totp_cli_command_timezone_docopt_usage();
+    totp_cli_command_move_docopt_usage();
     cli_nl();
     TOTP_CLI_PRINTF("Commands:\r\n");
     totp_cli_command_help_docopt_commands();
     totp_cli_command_list_docopt_commands();
     totp_cli_command_add_docopt_commands();
     totp_cli_command_delete_docopt_commands();
     totp_cli_command_timezone_docopt_commands();
+    totp_cli_command_move_docopt_commands();
     cli_nl();
     TOTP_CLI_PRINTF("Arguments:\r\n");
     totp_cli_command_add_docopt_arguments();
@@ -39,4 +42,5 @@ void totp_cli_command_help_handle() {
     TOTP_CLI_PRINTF("Options:\r\n");
     totp_cli_command_add_docopt_options();
     totp_cli_command_delete_docopt_options();
+    totp_cli_command_move_docopt_options();
 }