Add File Naming setting for more detailed naming (#3002)

* added filename mode setting
* added furi_flag checks for when filename_mode is set
* changed naming for ibutton, lfrfid and subghz
* requested changes from PR
* Lib: gather all naming bits and pieces under name generator module. Properly bump api version. FuriHal: fix RTC flag enum.
* PR requested changes
* bug fix for arg type
* added functionality for other application scenes
* Lib: cleanup name generator API, simplify usage. Sync API symbols.
* Lib: proper size type in name_generator. Cleanup.
* FuriHal: cleanup rtc api usage across firmware

Co-authored-by: あく <alleteam@gmail.com>

lib/nfc/nfc_device.c

@@ -1360,7 +1360,7 @@ void nfc_device_set_name(NfcDevice* dev, const char* name) {
 static void nfc_device_get_path_without_ext(FuriString* orig_path, FuriString* shadow_path) {
     // TODO: this won't work if there is ".nfc" anywhere in the path other than
     // at the end
-    size_t ext_start = furi_string_search(orig_path, NFC_APP_EXTENSION);
+    size_t ext_start = furi_string_search(orig_path, NFC_APP_FILENAME_EXTENSION);
     furi_string_set_n(shadow_path, orig_path, 0, ext_start);
 }
 
@@ -1587,7 +1587,7 @@ bool nfc_file_select(NfcDevice* dev) {
     // Input events and views are managed by file_browser
 
     const DialogsFileBrowserOptions browser_options = {
-        .extension = NFC_APP_EXTENSION,
+        .extension = NFC_APP_FILENAME_EXTENSION,
         .skip_assets = true,
         .hide_dot_files = true,
         .icon = &I_Nfc_10px,
@@ -1659,7 +1659,7 @@ bool nfc_device_delete(NfcDevice* dev, bool use_load_path) {
                 "%s/%s%s",
                 furi_string_get_cstr(dev->folder),
                 dev->dev_name,
-                NFC_APP_EXTENSION);
+                NFC_APP_FILENAME_EXTENSION);
         }
         if(!storage_simply_remove(dev->storage, furi_string_get_cstr(file_path))) break;
         // Delete shadow file if it exists
@@ -1717,7 +1717,7 @@ bool nfc_device_restore(NfcDevice* dev, bool use_load_path) {
                 "%s/%s%s",
                 furi_string_get_cstr(dev->folder),
                 dev->dev_name,
-                NFC_APP_EXTENSION);
+                NFC_APP_FILENAME_EXTENSION);
         }
         if(!nfc_device_load_data(dev, path, true)) break;
         restored = true;

lib/nfc/nfc_device.h

@@ -21,7 +21,8 @@ extern "C" {
 #define NFC_READER_DATA_MAX_SIZE 64
 #define NFC_DICT_KEY_BATCH_SIZE 10
 
-#define NFC_APP_EXTENSION ".nfc"
+#define NFC_APP_FILENAME_PREFIX "NFC"
+#define NFC_APP_FILENAME_EXTENSION ".nfc"
 #define NFC_APP_SHADOW_EXTENSION ".shd"
 
 typedef void (*NfcLoadingCallback)(void* context, bool state);

lib/subghz/protocols/raw.c

@@ -108,7 +108,8 @@ bool subghz_protocol_raw_save_to_file_init(
 
         furi_string_set(instance->file_name, dev_name);
         // First remove subghz device file if it was saved
-        furi_string_printf(temp_str, "%s/%s%s", SUBGHZ_RAW_FOLDER, dev_name, SUBGHZ_APP_EXTENSION);
+        furi_string_printf(
+            temp_str, "%s/%s%s", SUBGHZ_RAW_FOLDER, dev_name, SUBGHZ_APP_FILENAME_EXTENSION);
 
         if(!storage_simply_remove(instance->storage, furi_string_get_cstr(temp_str))) {
             break;

lib/subghz/types.h

@@ -13,7 +13,8 @@
 
 #define SUBGHZ_APP_FOLDER ANY_PATH("subghz")
 #define SUBGHZ_RAW_FOLDER EXT_PATH("subghz")
-#define SUBGHZ_APP_EXTENSION ".sub"
+#define SUBGHZ_APP_FILENAME_PREFIX "SubGHz"
+#define SUBGHZ_APP_FILENAME_EXTENSION ".sub"
 
 #define SUBGHZ_KEY_FILE_VERSION 1
 #define SUBGHZ_KEY_FILE_TYPE "Flipper SubGhz Key File"

lib/toolbox/SConscript

@@ -13,7 +13,7 @@ env.Append(
         File("manchester_decoder.h"),
         File("manchester_encoder.h"),
         File("path.h"),
-        File("random_name.h"),
+        File("name_generator.h"),
         File("sha256.h"),
         File("crc32_calc.h"),
         File("dir_walk.h"),

lib/toolbox/name_generator.c

@@ -0,0 +1,75 @@
+#include "name_generator.h"
+
+#include <stdio.h>
+#include <stdint.h>
+#include <furi_hal_rtc.h>
+#include <stdlib.h>
+#include <stdbool.h>
+#include <furi.h>
+
+const char* const name_generator_left[] = {
+    "ancient",  "hollow", "strange",   "disappeared", "unknown",    "unthinkable", "unnameable",
+    "nameless", "my",     "concealed", "forgotten",   "hidden",     "mysterious",  "obscure",
+    "random",   "remote", "uncharted", "undefined",   "untraveled", "untold",
+};
+
+const char* const name_generator_right[] = {
+    "door",
+    "entrance",
+    "doorway",
+    "entry",
+    "portal",
+    "entree",
+    "opening",
+    "crack",
+    "access",
+    "corridor",
+    "passage",
+    "port",
+};
+
+void name_generator_make_auto(char* name, size_t max_name_size, const char* prefix) {
+    if(furi_hal_rtc_is_flag_set(FuriHalRtcFlagDetailedFilename)) {
+        name_generator_make_detailed(name, max_name_size, prefix);
+    } else {
+        name_generator_make_random(name, max_name_size);
+    }
+}
+
+void name_generator_make_random(char* name, size_t max_name_size) {
+    furi_assert(name);
+    furi_assert(max_name_size);
+
+    uint8_t name_generator_left_i = rand() % COUNT_OF(name_generator_left);
+    uint8_t name_generator_right_i = rand() % COUNT_OF(name_generator_right);
+
+    snprintf(
+        name,
+        max_name_size,
+        "%s_%s",
+        name_generator_left[name_generator_left_i],
+        name_generator_right[name_generator_right_i]);
+
+    // Set first symbol to upper case
+    name[0] = name[0] - 0x20;
+}
+
+void name_generator_make_detailed(char* name, size_t max_name_size, const char* prefix) {
+    furi_assert(name);
+    furi_assert(max_name_size);
+    furi_assert(prefix);
+
+    FuriHalRtcDateTime dateTime;
+    furi_hal_rtc_get_datetime(&dateTime);
+
+    snprintf(
+        name,
+        max_name_size,
+        "%s-%.4d_%.2d_%.2d-%.2d_%.2d",
+        prefix,
+        dateTime.year,
+        dateTime.month,
+        dateTime.day,
+        dateTime.hour,
+        dateTime.minute);
+}

lib/toolbox/name_generator.h

@@ -0,0 +1,35 @@
+#pragma once
+
+#include <stdint.h>
+#include <stddef.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** Generates detailed/random name based on furi_hal flags
+ *
+ * @param      name           buffer to write random name
+ * @param      max_name_size  length of given buffer
+ * @param[in]  prefix         The prefix of the name
+ */
+void name_generator_make_auto(char* name, size_t max_name_size, const char* prefix);
+
+/** Generates random name
+ *
+ * @param      name           buffer to write random name
+ * @param      max_name_size  length of given buffer
+ */
+void name_generator_make_random(char* name, size_t max_name_size);
+
+/** Generates detailed name
+ *
+ * @param      name           buffer to write random name
+ * @param      max_name_size  length of given buffer
+ * @param[in]  prefix         The prefix of the name
+ */
+void name_generator_make_detailed(char* name, size_t max_name_size, const char* prefix);
+
+#ifdef __cplusplus
+}
+#endif

lib/toolbox/random_name.c

@@ -1,35 +0,0 @@
-#include "random_name.h"
-#include <stdio.h>
-#include <stdlib.h>
-#include <stdbool.h>
-#include <furi.h>
-
-void set_random_name(char* name, uint8_t max_name_size) {
-    const char* prefix[] = {
-        "ancient",     "hollow",    "strange",    "disappeared", "unknown",
-        "unthinkable", "unnamable", "nameless",   "my",          "concealed",
-        "forgotten",   "hidden",    "mysterious", "obscure",     "random",
-        "remote",      "uncharted", "undefined",  "untravelled", "untold",
-    };
-
-    const char* suffix[] = {
-        "door",
-        "entrance",
-        "doorway",
-        "entry",
-        "portal",
-        "entree",
-        "opening",
-        "crack",
-        "access",
-        "corridor",
-        "passage",
-        "port",
-    };
-    uint8_t prefix_i = rand() % COUNT_OF(prefix);
-    uint8_t suffix_i = rand() % COUNT_OF(suffix);
-
-    snprintf(name, max_name_size, "%s_%s", prefix[prefix_i], suffix[suffix_i]);
-    // Set first symbol to upper case
-    name[0] = name[0] - 0x20;
-}

lib/toolbox/random_name.h

@@ -1,17 +0,0 @@
-#pragma once
-
-#include <stdint.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/** Generates random name
- * @param name buffer to write random name
- * @param max_name_size length of given buffer
- */
-void set_random_name(char* name, uint8_t max_name_size);
-
-#ifdef __cplusplus
-}
-#endif