Refactor note creation to use NewNote struct

Replaces positional arguments in note creation with a NewNote struct for improved clarity and maintainability. Updates all usages of store_new_note to use the new struct, adjusts related logic, and modernizes variable declarations and type usage throughout affected files. Also updates unit tests and related code to match the new interface.
#1046

Author: teusbenschop

database/notes.cpp

@@ -523,41 +523,38 @@ std::string Database_Notes::assemble_contents (int identifier, std::string conte
 
 
 // Store a new consultation note into the database and in JSON.
-// bible: The notes's Bible.
-// book, chapter, verse: The note's passage.
-// summary: The note's summary.
-// contents: The note's contents.
-// raw: Import contents as it is.
 // It returns the identifier of this new note.
-int Database_Notes::store_new_note (const std::string& bible, int book, int chapter, int verse, std::string summary, std::string contents, bool raw)
+int Database_Notes::store_new_note (const NewNote& new_note)
 {
   // Create a new identifier.
-  int identifier = get_new_unique_identifier ();
+  const int identifier = get_new_unique_identifier ();
 
   // Passage.
-  std::string passage = encode_passage (book, chapter, verse);
+  const std::string passage = encode_passage (new_note.book, new_note.chapter, new_note.verse);
 
-  std::string status = "New";
-  int severity = 2;
+  const std::string status = "New";
+  constexpr int severity = static_cast<int>(SeveritySelector::normal);
 
   // If the summary is not given, take the first line of the contents as the summary.
-  if (summary == "") {
-    // The notes editor does not put new lines at each line, but instead <div>s. Handle these also.
-    summary = filter::strings::replace ("<", "\n", contents);
-    std::vector <std::string> bits = filter::strings::explode (summary, '\n');
-    if (!bits.empty ()) summary = bits [0];
+  std::string summary {new_note.summary};
+  if (summary.empty()) {
+    // The notes editor does not put new lines at each line, but instead puts <div> elements. Handle these also.
+    summary = filter::strings::replace ("<", "\n", new_note.contents);
+    const std::vector<std::string> bits = filter::strings::explode (summary, '\n');
+    if (!bits.empty ()) summary = bits.at(0);
   }
 
   // Assemble contents.
-  if (!raw) contents = assemble_contents (identifier, contents);
+  std::string contents {new_note.contents};
+  if (!new_note.raw) contents = assemble_contents (identifier, contents);
   if ((contents.empty()) && (summary.empty())) return 0;
 
   // Store the JSON representation of the note in the file system.
   std::string path = note_file (identifier);
   std::string folder = filter_url_dirname (path);
   filter_url_mkdir (folder);
   jsonxx::Object note;
-  note << bible_key () << bible;
+  note << bible_key () << new_note.bible;
   note << passage_key () << passage;
   note << status_key () << status;
   note << severity_key () << std::to_string (severity);
@@ -572,7 +569,7 @@ int Database_Notes::store_new_note (const std::string& bible, int book, int chap
     sql.add ("INSERT INTO notes (identifier, modified, assigned, subscriptions, bible, passage, status, severity, summary, contents) VALUES (");
     sql.add (identifier);
     sql.add (", 0, '', '',");
-    sql.add (bible);
+    sql.add (new_note.bible);
     sql.add (",");
     sql.add (passage);
     sql.add (",");
@@ -765,7 +762,7 @@ std::vector<int> Database_Notes::select_notes(const Selector& selector)
   query.append (";");
 
   SqliteDatabase sql (database_notes);
-  sql.set_sql (query); // Todo can this be used to build the string?
+  sql.set_sql (query);
   const std::vector <std::string> result = sql.query () ["identifier"];
   for (const auto& id : result) {
     identifiers.push_back (filter::strings::convert_to_int (id));

database/notes.h

@@ -65,7 +65,21 @@ class Database_Notes
 
 public:
   std::vector <int> get_identifiers ();
-  int store_new_note (const std::string& bible, int book, int chapter, int verse, std::string summary, std::string contents, bool raw);
+  struct NewNote {
+    // The notes's Bible.
+    const std::string bible{};
+    // The note's passage.
+    const int book{0};
+    const int chapter{0};
+    const int verse{0};
+    // The note's summary.
+    const std::string summary{};
+    // The note's contents.
+    const std::string contents{};
+    // Import contents as it is.
+    const bool raw {false};
+  };
+  int store_new_note (const NewNote& new_note);
 private:
   int get_new_unique_identifier ();
 

demo/logic.cpp

@@ -342,7 +342,15 @@ void demo_create_sample_notes (Webserver_Request& webserver_request)
   std::vector <int> identifiers = database_notes.get_identifiers ();
   if (identifiers.size () < 10) {
     for (int i = 1; i <= 10; i++) {
-      database_notes.store_new_note (demo_sample_bible_name (), i, i, i, "Sample Note " + std::to_string (i), "Sample Contents for note " + std::to_string (i), false);
+      Database_Notes::NewNote new_note {
+        .bible = demo_sample_bible_name (),
+        .book = i,
+        .chapter = i,
+        .verse = i,
+        .summary = "Sample Note " + std::to_string (i),
+        .contents = "Sample Contents for note " + std::to_string (i),
+      };
+      database_notes.store_new_note (new_note);
     }
   }
 }

notes/index.cpp

@@ -59,36 +59,36 @@ std::string notes_index (Webserver_Request& webserver_request)
   // Presets for notes selectors.
   // This is for the daily statistics and the workspace.
   if (webserver_request.query.count ("presetselection")) {
-    webserver_request.database_config_user()->set_consultation_notes_passage_selector (3);
-    webserver_request.database_config_user()->set_consultation_notes_edit_selector (0);
-    webserver_request.database_config_user()->set_consultation_notes_non_edit_selector (0);
+    webserver_request.database_config_user()->set_consultation_notes_passage_selector (static_cast<int>(Database_Notes::PassageSelector::any_passage));
+    webserver_request.database_config_user()->set_consultation_notes_edit_selector (static_cast<int>(Database_Notes::EditSelector::at_any_time));
+    webserver_request.database_config_user()->set_consultation_notes_non_edit_selector (static_cast<int>(Database_Notes::NonEditSelector::any_time));
     webserver_request.database_config_user()->set_consultation_notes_status_selectors ({});
-    webserver_request.database_config_user()->set_consultation_notes_bible_selector ("");
-    webserver_request.database_config_user()->set_consultation_notes_assignment_selector ("");
-    webserver_request.database_config_user()->set_consultation_notes_subscription_selector (0);
-    webserver_request.database_config_user()->set_consultation_notes_severity_selector (-1);
-    webserver_request.database_config_user()->set_consultation_notes_text_selector (0);
+    webserver_request.database_config_user()->set_consultation_notes_bible_selector (std::string());
+    webserver_request.database_config_user()->set_consultation_notes_assignment_selector (std::string());
+    webserver_request.database_config_user()->set_consultation_notes_subscription_selector (false);
+    webserver_request.database_config_user()->set_consultation_notes_severity_selector (static_cast<int>(Database_Notes::SeveritySelector::any));
+    webserver_request.database_config_user()->set_consultation_notes_text_selector (false);
     std::string preset_selector = webserver_request.query ["presetselection"];
     if (preset_selector == "assigned") {
       webserver_request.database_config_user()->set_consultation_notes_assignment_selector (webserver_request.session_logic ()->get_username ());
     }
     if (preset_selector == "subscribed") {
-      webserver_request.database_config_user()->set_consultation_notes_subscription_selector (1);
+      webserver_request.database_config_user()->set_consultation_notes_subscription_selector (true);
     }
     if (preset_selector == "subscribeddayidle") {
-      webserver_request.database_config_user()->set_consultation_notes_subscription_selector (1);
-      webserver_request.database_config_user()->set_consultation_notes_non_edit_selector (1);
+      webserver_request.database_config_user()->set_consultation_notes_subscription_selector (true);
+      webserver_request.database_config_user()->set_consultation_notes_non_edit_selector (static_cast<int>(Database_Notes::NonEditSelector::a_day));
     }
     if (preset_selector == "subscribedweekidle") {
-      webserver_request.database_config_user()->set_consultation_notes_subscription_selector (1);
-      webserver_request.database_config_user()->set_consultation_notes_non_edit_selector (3);
+      webserver_request.database_config_user()->set_consultation_notes_subscription_selector (true);
+      webserver_request.database_config_user()->set_consultation_notes_non_edit_selector (static_cast<int>(Database_Notes::NonEditSelector::a_week));
     }
     if (preset_selector == "forverse") {
-      webserver_request.database_config_user()->set_consultation_notes_passage_selector (0);
+      webserver_request.database_config_user()->set_consultation_notes_passage_selector (static_cast<int>(Database_Notes::PassageSelector::current_verse));
     }
   }
 
-  int level = webserver_request.session_logic ()->get_level ();
+  const int level = webserver_request.session_logic ()->get_level ();
   // Manager roles and higher can do mass updates on the notes.
   if (level >= roles::manager) {
     // No mass updates in basic mode.

notes/logic.cpp

@@ -54,7 +54,16 @@ int Notes_Logic::createNote (std::string bible, int book, int chapter, int verse
 {
   summary = filter::strings::replace ("\n", "", summary);
   Database_Notes database_notes (m_webserver_request);
-  int note_id = database_notes.store_new_note (bible, book, chapter, verse, summary, contents, raw);
+  Database_Notes::NewNote new_note {
+    .bible = bible,
+    .book = book,
+    .chapter = chapter,
+    .verse = verse,
+    .summary = summary,
+    .contents = contents,
+    .raw = raw
+  };
+  const int note_id = database_notes.store_new_note (new_note);
   if (client_logic_client_enabled ()) {
     // Client: record the action in the database.
     Database_NoteActions database_noteactions;
@@ -656,7 +665,15 @@ bool Notes_Logic::handleEmailNew (std::string from, std::string subject, std::st
   m_webserver_request.session_logic()->set_username (username);
   Database_Notes database_notes (m_webserver_request);
   std::string bible = m_webserver_request.database_config_user()->get_bible ();
-  int identifier = database_notes.store_new_note (bible, static_cast<int>(book), chapter, verse, summary, body, false);
+  Database_Notes::NewNote new_note {
+    .bible = bible,
+    .book = static_cast<int>(book),
+    .chapter = chapter,
+    .verse = verse,
+    .summary = summary,
+    .contents = body,
+  };
+  const int identifier = database_notes.store_new_note (new_note);
   handlerNewNote (identifier);
   m_webserver_request.session_logic()->set_username (sessionuser);
   // Mail confirmation to the username.

notes/notes.cpp

@@ -50,30 +50,32 @@ std::string notes_notes (Webserver_Request& webserver_request)
   Database_Notes database_notes (webserver_request);
 
 
-  std::string bible = access_bible::clamp (webserver_request, webserver_request.database_config_user()->get_bible());
-  int book = Ipc_Focus::getBook (webserver_request);
-  int chapter = Ipc_Focus::getChapter (webserver_request);
-  int verse = Ipc_Focus::getVerse (webserver_request);
+  const std::string bible = access_bible::clamp (webserver_request, webserver_request.database_config_user()->get_bible());
+  const int book = Ipc_Focus::getBook (webserver_request);
+  const int chapter = Ipc_Focus::getChapter (webserver_request);
+  const int verse = Ipc_Focus::getVerse (webserver_request);
 
 
-  Database_Notes::PassageSelector passage_selector = static_cast<Database_Notes::PassageSelector>(webserver_request.database_config_user()->get_consultation_notes_passage_selector());
-  int edit_selector = webserver_request.database_config_user()->get_consultation_notes_edit_selector();
-  auto non_edit_selector = static_cast<Database_Notes::NonEditSelector>(webserver_request.database_config_user()->get_consultation_notes_non_edit_selector());
+  const auto passage_selector = static_cast<Database_Notes::PassageSelector>(webserver_request.database_config_user()->get_consultation_notes_passage_selector());
+  const int edit_selector = webserver_request.database_config_user()->get_consultation_notes_edit_selector();
+  const auto non_edit_selector = static_cast<Database_Notes::NonEditSelector>(webserver_request.database_config_user()->get_consultation_notes_non_edit_selector());
   const std::vector<std::string> status_selectors = webserver_request.database_config_user()->get_consultation_notes_status_selectors();
-  std::string assignment_selector = webserver_request.database_config_user()->get_consultation_notes_assignment_selector();
-  bool subscription_selector = webserver_request.database_config_user()->get_consultation_notes_subscription_selector();
-  auto severity_selector = static_cast<Database_Notes::SeveritySelector>(webserver_request.database_config_user()->get_consultation_notes_severity_selector());
-  const int text_selector = webserver_request.database_config_user()->get_consultation_notes_text_selector();
+  const std::string bible_selector = webserver_request.database_config_user()->get_consultation_notes_bible_selector();
+  const std::string assignment_selector = webserver_request.database_config_user()->get_consultation_notes_assignment_selector();
+  const bool subscription_selector = webserver_request.database_config_user()->get_consultation_notes_subscription_selector();
+  const auto severity_selector = static_cast<Database_Notes::SeveritySelector>(webserver_request.database_config_user()->get_consultation_notes_severity_selector());
+  const bool text_selector = webserver_request.database_config_user()->get_consultation_notes_text_selector();
   const std::string search_text = text_selector ? webserver_request.database_config_user()->get_consultation_notes_search_text() : "";
-  int passage_inclusion_selector = webserver_request.database_config_user()->get_consultation_notes_passage_inclusion_selector();
-  int text_inclusion_selector = webserver_request.database_config_user()->get_consultation_notes_text_inclusion_selector();
+  const bool passage_inclusion_selector = webserver_request.database_config_user()->get_consultation_notes_passage_inclusion_selector();
+  const bool text_inclusion_selector = webserver_request.database_config_user()->get_consultation_notes_text_inclusion_selector();
 
 
   // The Bibles the current user has access to or else the Bible selector.
-  std::vector <std::string> bibles = {webserver_request.database_config_user()->get_consultation_notes_bible_selector()};
-  if (bibles.empty())
+  std::vector<std::string> bibles{};
+  if (bible_selector.empty())
     bibles = access_bible::bibles (webserver_request, webserver_request.session_logic ()->get_username ());
-  
+  else
+    bibles = {webserver_request.database_config_user()->get_consultation_notes_bible_selector()};
 
 
   // The admin disables notes selection on Bibles,

sync/notes.cpp

@@ -181,7 +181,15 @@ std::string sync_notes (Webserver_Request& webserver_request)
     case Sync_Logic::notes_put_create_initiate:
     {
       // Create the note on the server.
-      int server_id = database_notes.store_new_note ("", 1, 1, 1, "<empty>", "<empty>", false);
+      Database_Notes::NewNote new_note {
+        .bible = "",
+        .book = 1,
+        .chapter = 1,
+        .verse = 1,
+        .summary = "<empty>",
+        .contents = "<empty>",
+      };
+      int server_id = database_notes.store_new_note (new_note);
       // Update the note identifier on the server to be same as on the client.
       database_notes.set_identifier (server_id, identifier);
       // Update search field.

unittests/memory.cpp

@@ -90,7 +90,16 @@ TEST (DISABLED_memory, basic)
     Database_Notes database_notes (webserver_request);
     database_notes.create ();
     for (int i = 0; i < 100; i++) {
-      database_notes.store_new_note ("bible", i, i, i, "summary", "contents", true);
+      Database_Notes::NewNote new_note {
+        .bible = "bible",
+        .book = i,
+        .chapter = i,
+        .verse = i,
+        .summary = "summary",
+        .contents = "contents",
+        .raw = true
+      };
+      database_notes.store_new_note(new_note);
     }
     std::thread * recorder = nullptr;
     uint64_t basic_usage = filter_memory_total_usage ();