WebshopApi: Syntax in Tests
[kivitendo-erp.git] / js / kivi.js
index 58a631a..210020a 100644 (file)
@@ -1,4 +1,6 @@
 namespace("kivi", function(ns) {
+  "use strict";
+
   ns._locale = {};
   ns._date_format   = {
     sep: '.',
@@ -31,7 +33,7 @@ namespace("kivi", function(ns) {
   ns.parse_date = function(date) {
     var parts = date.replace(/\s+/g, "").split(ns._date_format.sep);
     date     = new Date(
-      ((parts[ ns._date_format.y ] || 0) * 1) || (new Date).getFullYear(),
+      ((parts[ ns._date_format.y ] || 0) * 1) || (new Date()).getFullYear(),
        (parts[ ns._date_format.m ] || 0) * 1 - 1, // Months are 0-based.
        (parts[ ns._date_format.d ] || 0) * 1
     );
@@ -51,7 +53,7 @@ namespace("kivi", function(ns) {
   };
 
   ns.parse_amount = function(amount) {
-    if ((amount == undefined) || (amount == ''))
+    if ((amount === undefined) || (amount === ''))
       return 0;
 
     if (ns._number_format.decimalSep == ',')
@@ -59,7 +61,16 @@ namespace("kivi", function(ns) {
 
     amount = amount.replace(/[\',]/g, "")
 
-    return eval(amount);
+    // Make sure no code wich is not a math expression ends up in eval().
+    if (!amount.match(/^[0-9 ()\-+*/.]*$/))
+      return 0;
+
+    /* jshint -W061 */
+    try {
+      return eval(amount);
+    } catch (err) {
+      return 0;
+    }
   };
 
   ns.round_amount = function(amount, places) {
@@ -77,7 +88,7 @@ namespace("kivi", function(ns) {
   ns.format_amount = function(amount, places) {
     amount = amount || 0;
 
-    if ((places != undefined) && (places >= 0))
+    if ((places !== undefined) && (places >= 0))
       amount = ns.round_amount(amount, Math.abs(places));
 
     var parts = ("" + Math.abs(amount)).split(/\./);
@@ -85,7 +96,7 @@ namespace("kivi", function(ns) {
     var dec   = parts.length > 1 ? parts[1] : "";
     var sign  = amount  < 0      ? "-"      : "";
 
-    if (places != undefined) {
+    if (places !== undefined) {
       while (dec.length < Math.abs(places))
         dec += "0";
 
@@ -93,7 +104,7 @@ namespace("kivi", function(ns) {
         dec = d.substr(0, places);
     }
 
-    if ((ns._number_format.thousandSep != "") && (intg.length > 3)) {
+    if ((ns._number_format.thousandSep !== "") && (intg.length > 3)) {
       var len   = ((intg.length + 2) % 3) + 1,
           start = len,
           res   = intg.substr(0, len);
@@ -105,7 +116,7 @@ namespace("kivi", function(ns) {
       intg = res;
     }
 
-    var sep = (places != 0) && (dec != "") ? ns._number_format.decimalSep : "";
+    var sep = (places !== 0) && (dec !== "") ? ns._number_format.decimalSep : "";
 
     return sign + intg + sep + dec;
   };
@@ -146,41 +157,39 @@ namespace("kivi", function(ns) {
   };
 
   ns.focus_ckeditor_when_ready = function(element) {
-    $(element).ckeditor(function() { ns.focus_ckeditor(element); });
+    $(element).data('ckeditorInstance').on('instanceReady', function() { ns.focus_ckeditor(element); });
   };
 
   ns.focus_ckeditor = function(element) {
-    var editor   = $(element).ckeditorGet();
-               var editable = editor.editable();
-
-               if (editable.is('textarea')) {
-                       var textarea = editable.$;
-
-                       if (CKEDITOR.env.ie)
-                               textarea.createTextRange().execCommand('SelectAll');
-                       else {
-                               textarea.selectionStart = 0;
-                               textarea.selectionEnd   = textarea.value.length;
-                       }
-
-                       textarea.focus();
-
-               } else {
-                       if (editable.is('body'))
-                               editor.document.$.execCommand('SelectAll', false, null);
+    $(element).data('ckeditorInstance').focus();
+  };
 
-                       else {
-                               var range = editor.createRange();
-                               range.selectNodeContents(editable);
-                               range.select();
-                       }
+  ns.selectall_ckeditor = function(element) {
+    var editor   = $(element).ckeditorGet();
+    var editable = editor.editable();
+    if (editable.is('textarea')) {
+      var textarea = editable.$;
+
+      if (CKEDITOR.env.ie)
+        textarea.createTextRange().execCommand('SelectAll');
+      else {
+        textarea.selectionStart = 0;
+        textarea.selectionEnd   = textarea.value.length;
+      }
+    } else {
+      if (editable.is('body'))
+        editor.document.$.execCommand('SelectAll', false, null);
 
-                       editor.forceNextSelectionCheck();
-                       editor.selectionChange();
+      else {
+        var range = editor.createRange();
+        range.selectNodeContents(editable);
+        range.select();
+      }
 
-      editor.focus();
-               }
-  };
+      editor.forceNextSelectionCheck();
+      editor.selectionChange();
+    }
+  }
 
   ns.init_tabwidget = function(element) {
     var $element   = $(element);
@@ -211,20 +220,20 @@ namespace("kivi", function(ns) {
       entities:      false,
       language:      'de',
       removePlugins: 'resize',
-      toolbar:       buttons
-    }
+      extraPlugins:  'inline_resize',
+      toolbar:       buttons,
+      disableAutoInline: true,
+      title:         false
+    };
 
-    var style = $e.prop('style');
-    $(['width', 'height']).each(function(idx, prop) {
-      var matches = (style[prop] || '').match(/(\d+)px/);
-      if (matches && (matches.length > 1))
-        config[prop] = matches[1];
-    });
+    config.height = $e.height();
+    config.width  = $e.width();
 
-    $e.ckeditor(config);
+    var editor = CKEDITOR.inline($e.get(0), config);
+    $e.data('ckeditorInstance', editor);
 
     if ($e.hasClass('texteditor-autofocus'))
-      $e.ckeditor(function() { ns.focus_ckeditor($e); });
+      editor.on('instanceReady', function() { ns.focus_ckeditor($e); });
   };
 
   ns.reinit_widgets = function() {
@@ -232,21 +241,14 @@ namespace("kivi", function(ns) {
       $(elt).datepicker();
     });
 
-    if (ns.PartPicker)
-      ns.run_once_for('input.part_autocomplete', 'part_picker', function(elt) {
-        kivi.PartPicker($(elt));
-      });
+    if (ns.Part) ns.Part.reinit_widgets();
+    if (ns.CustomerVendor) ns.CustomerVendor.reinit_widgets();
 
     if (ns.ProjectPicker)
       ns.run_once_for('input.project_autocomplete', 'project_picker', function(elt) {
         kivi.ProjectPicker($(elt));
       });
 
-    if (ns.CustomerVendorPicker)
-      ns.run_once_for('input.customer_vendor_autocomplete', 'customer_vendor_picker', function(elt) {
-        kivi.CustomerVendorPicker($(elt));
-      });
-
     if (ns.ChartPicker)
       ns.run_once_for('input.chart_autocomplete', 'chart_picker', function(elt) {
         kivi.ChartPicker($(elt));
@@ -285,6 +287,31 @@ namespace("kivi", function(ns) {
     return true;
   };
 
+  // This function submits an existing form given by "form_selector"
+  // and sets the "action" input to "action_to_call" before submitting
+  // it. Any existing input named "action" will be removed prior to
+  // submitting.
+  ns.submit_form_with_action = function(form_selector, action_to_call) {
+    $('[name=action]').remove();
+
+    var $form   = $(form_selector);
+    var $hidden = $('<input type=hidden>');
+
+    $hidden.attr('name',  'action');
+    $hidden.attr('value', action_to_call);
+    $form.append($hidden);
+
+    $form.submit();
+  };
+
+  // This function exists solely so that it can be found with
+  // kivi.get_functions_by_name() and called later on. Using something
+  // like "var func = history["back"]" works, but calling it later
+  // with "func.apply()" doesn't.
+  ns.history_back = function() {
+    history.back();
+  };
+
   // Return a function object by its name (a string). Works both with
   // global functions (e.g. "check_right_date_format") and those in
   // namespaces (e.g. "kivi.t8").
@@ -307,11 +334,13 @@ namespace("kivi", function(ns) {
   // - id: dialog DIV ID (optional; defaults to 'jqueryui_popup_dialog')
   // - url, data, type: passed as the first three arguments to the $.ajax() call if an AJAX call is made, otherwise ignored.
   // - dialog: an optional object of options passed to the $.dialog() call
+  // - load: an optional function that is called after the content has been loaded successfully (only if an AJAX call is made)
   ns.popup_dialog = function(params) {
     var dialog;
 
     params            = params        || { };
     var id            = params.id     || 'jqueryui_popup_dialog';
+    var custom_close  = params.dialog ? params.dialog.close : undefined;
     var dialog_params = $.extend(
       { // kivitendo default parameters:
           width:  800
@@ -321,7 +350,15 @@ namespace("kivi", function(ns) {
         // User supplied options:
       params.dialog || { },
       { // Options that must not be changed:
-        close: function(event, ui) { if (params.url || params.html) dialog.remove(); else dialog.dialog('close'); }
+        close: function(event, ui) {
+          dialog.dialog('close');
+
+          if (custom_close)
+            custom_close();
+
+          if (params.url || params.html)
+            dialog.remove();
+        }
       });
 
     if (!params.url && !params.html) {
@@ -351,6 +388,8 @@ namespace("kivi", function(ns) {
         success: function(new_html) {
           dialog.html(new_html);
           dialog.removeClass('loading');
+          if (params.load)
+            params.load();
         }
       });
     }
@@ -379,7 +418,7 @@ namespace("kivi", function(ns) {
       return;
     }
 
-    $(selector).filter(function() { return $(this).data(attr_name) != true; }).each(function(idx, elt) {
+    $(selector).filter(function() { return $(this).data(attr_name) !== true; }).each(function(idx, elt) {
       var $elt = $(elt);
       $elt.data(attr_name, true);
       fn($elt);
@@ -398,11 +437,115 @@ namespace("kivi", function(ns) {
   ns.run = function(function_name, args) {
     var fn = ns.get_function_by_name(function_name);
     if (fn)
-      return fn.apply({}, args);
+      return fn.apply({}, args || []);
 
     console.error('kivi.run("' + function_name + '"): No function by that name found');
     return undefined;
   };
+
+  ns.detect_duplicate_ids_in_dom = function() {
+    var ids   = {},
+        found = false;
+
+    $('[id]').each(function() {
+      if (this.id && ids[this.id]) {
+        found = true;
+        console.warn('Duplicate ID #' + this.id);
+      }
+      ids[this.id] = 1;
+    });
+
+    if (!found)
+      console.log('No duplicate IDs found :)');
+  };
+
+  // Verifies that at least one checkbox matching the
+  // "checkbox_selector" is actually checked. If not, an error message
+  // is shown, and false is returned. Otherwise (at least one of them
+  // is checked) nothing is shown and true returned.
+  //
+  // Can be used in checks when clicking buttons.
+  ns.check_if_entries_selected = function(checkbox_selector) {
+    if ($(checkbox_selector + ':checked').length > 0)
+      return true;
+
+    alert(kivi.t8('No entries have been selected.'));
+
+    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;
+  };
+
+  ns.switch_areainput_to_textarea = function(id) {
+    var $input = $('#' + id);
+    if (!$input.length)
+      return;
+
+    var $area = $('<textarea></textarea>');
+
+    $area.prop('rows', 3);
+    $area.prop('cols', $input.prop('size') || 40);
+    $area.prop('name', $input.prop('name'));
+    $area.prop('id',   $input.prop('id'));
+    $area.val($input.val());
+
+    $input.parent().replaceWith($area);
+    $area.focus();
+  };
 });
 
 kivi = namespace('kivi');