From fb63efe1b63573c2ee3535cb2f9e63502dd0e848 Mon Sep 17 00:00:00 2001
From: Moritz Bunkus <m.bunkus@linet-services.de>
Date: Tue, 31 Jan 2017 14:12:59 +0100
Subject: [PATCH] kivi.validate_form: generische Formvalidierung anhand von
 data-Attributen an Elementen

---
 js/kivi.js      | 56 +++++++++++++++++++++++++++++++++++++++++++++++++
 js/locale/de.js |  1 +
 locale/de/all   |  1 +
 3 files changed, 58 insertions(+)

diff --git a/js/kivi.js b/js/kivi.js
index daf360b23..e17294a12 100644
--- a/js/kivi.js
+++ b/js/kivi.js
@@ -474,6 +474,62 @@ namespace("kivi", function(ns) {
 
     return false;
   };
+
+  // Performs various validation steps on the descendants of
+  // 'selector'. Elements that should be validated must have an
+  // attribute named "data-validate" which is set to a space-separated
+  // list of tests to perform. Additionally, the attribute
+  // "data-title" must be set to a human-readable name of the field
+  // that can be shown as part of an error message.
+  //
+  // Supported validation tests are:
+  // - "required": the field must be set (its .val() must not be empty)
+  //
+  // The validation will abort and return "false" as soon as
+  // validation routine fails.
+  //
+  // The function returns "true" if all validations succeed for all
+  // elements.
+  ns.validate_form = function(selector) {
+    var validate_field = function(elt) {
+      var $elt  = $(elt);
+      var tests = $elt.data('validate').split(/ +/);
+      var info  = {
+        title: $elt.data('title'),
+        value: $elt.val(),
+      };
+
+      for (var test_idx in tests) {
+        var test = tests[test_idx];
+
+        if (test === "required") {
+          if ($elt.val() === '') {
+            alert(kivi.t8("The field '#{title}' must be set.", info));
+            return false;
+          }
+
+        } else {
+          var error = "kivi.validate_form: unknown test '" + test + "' for element ID '" + $elt.prop('id') + "'";
+          console.error(error);
+          alert(error);
+
+          return false;
+        }
+      }
+
+      return true;
+    };
+
+    selector = selector || '#form';
+    var ok   = true;
+    var to_check = $(selector + ' [data-validate]').toArray();
+
+    for (var to_check_idx in to_check)
+      if (!validate_field(to_check[to_check_idx]))
+        return false;
+
+    return true;
+  };
 });
 
 kivi = namespace('kivi');
diff --git a/js/locale/de.js b/js/locale/de.js
index fce873792..2f197b86d 100644
--- a/js/locale/de.js
+++ b/js/locale/de.js
@@ -86,6 +86,7 @@ namespace("kivi").setupLocale({
 "Text block picture actions":"Aktionen für Textblockbilder",
 "The IBAN is missing.":"Die IBAN fehlt.",
 "The description is missing.":"Die Beschreibung fehlt.",
+"The field '#{title}' must be set.":"Das Feld »#{title}« muss gesetzt sein.",
 "The name is missing.":"Der Name fehlt.",
 "The name must only consist of letters, numbers and underscores and start with a letter.":"Der Name darf nur aus Buchstaben (keine Umlaute), Ziffern und Unterstrichen bestehen und muss mit einem Buchstaben beginnen.",
 "The option field is empty.":"Das Optionsfeld ist leer.",
diff --git a/locale/de/all b/locale/de/all
index 817072db2..8ac98c2f9 100755
--- a/locale/de/all
+++ b/locale/de/all
@@ -2941,6 +2941,7 @@ $self->{texts} = {
   'The export failed because of malformed transactions. Please fix those before exporting.' => 'Es sind fehlerhafte Buchungen im Exportzeitraum vorhanden. Bitte korrigieren Sie diese vor dem Export.',
   'The factor is missing in row %d.' => 'Der Faktor fehlt in Zeile %d.',
   'The factor is missing.'      => 'Der Faktor fehlt.',
+  'The field \'#{title}\' must be set.' => 'Das Feld »#{title}« muss gesetzt sein.',
   'The file has been sent to the printer.' => 'Die Datei wurde an den Drucker geschickt.',
   'The file is available for download.' => 'Die Datei ist zum Herunterladen verfügbar.',
   'The file name is missing'    => 'Der Dateiname fehlt',
-- 
2.20.1