MAINT: refactor set_location

Summary

Some refactoring to allow multiple samples to be borrowed.

Focus

• Where code is changed, we move away from the old naming scheme of boxes.
• Before, we had the state machine behavior distributed over lots of files. It is now defined in box_loan.py and tested in a new unit test.

Test Environment

unit and integration test: run manually

There is a test-profile with an appropriate dump that you can use to start linkahead

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

loan-custom/caosdb-server/caosdb-webui/src/ext/js/box_loan.js

@@ -29,7 +29,18 @@ function get_formatted_date(split) {
     return ((new Date(Date.now() - tzoffset)).toISOString()).split(split)[0];
 }
 
-
+/**
+ * This function retrieves an html form from the html subdirectory.
+ *
+ */
+var getHTMLForm = async function(pageName, variables) {
+    var site = await connection.get("webinterface/html/forms/" + pageName + ".html", "html");
+    var htmltext = site.getElementById("caosdb-form").innerHTML;
+    var req = /\{([0-9a-z-A-Z_]+)\}/g;
+    return htmltext.replace(req, (match, p1) => { 
+        return variables[p1] || ""; 
+    }); 
+}
 
 /**
  * AWI Box Loan, refactored code.