OTRS API Reference JavaScript

Source: Core.Agent.CustomerUserAddressBook.js

  1. // --
  2. // Copyright (C) 2001-2020 OTRS AG, https://otrs.com/
  3. // --
  4. // This software comes with ABSOLUTELY NO WARRANTY. For details, see
  5. // the enclosed file COPYING for license information (GPL). If you
  6. // did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.
  7. // --
  9. "use strict";
  11. var Core = Core || {};
  12. Core.Agent = Core.Agent || {};
  14. /**
  15.  * @namespace Core.Agent.CustomerUserAddressBook
  16.  * @memberof Core.Agent
  17.  * @author OTRS AG
  18.  * @description
  19.  *      This namespace contains the special module functions for the search.
  20.  */
  21. Core.Agent.CustomerUserAddressBook = (function (TargetNS) {
  23.     /**
  24.      * @private
  25.      * @name RecipientUserLoginElementSelector
  26.      * @memberof Core.Agent.CustomerUserAddressBook
  27.      * @member {String}
  28.      * @description
  29.      *      The recipient user login element selector for the checkbox.
  30.      */
  31.     var RecipientUserLoginElementSelector = 'div.Overview table td input[type="checkbox"][name=RecipientUserLogin]';
  33.     /**
  34.      * @private
  35.      * @name CheckForSearchedValues
  36.      * @memberof Core.Agent.CustomerUserAddressBook
  37.      * @function
  38.      * @returns {Boolean} False if no values were found, true if values where there.
  39.      * @description
  40.      *      Checks if any values were entered in the search.
  41.      *      If nothing at all exists, it alerts with translated:
  42.      *      "Please enter at least one search value or * to find anything"
  43.      */
  44.     function CheckForSearchedValues() {
  45.         var SearchValueFlag = false;
  47.         $('#SearchForm label').each(function () {
  48.             var ElementName,
  49.                 $Element;
  51.             // Those with ID's are used for searching.
  52.             if ($(this).attr('id')) {
  53.                     // substring "Label" (e.g. first five characters) from the
  54.                     // label id, use the remaining name as name string for accessing
  55.                     // the form input's value
  56.                     ElementName = $(this).attr('id').substring(5);
  57.                     $Element = $('#SearchForm input[name=' + ElementName + ']');
  58.                     // If there's no input element with the selected name
  59.                     // find the next "select" element and use that one for checking
  60.                     if (!$Element.length) {
  61.                         $Element = $(this).next().find('select');
  62.                     }
  63.                     if ($Element.length) {
  64.                         if ($Element.val() && $Element.val() !== '') {
  65.                             SearchValueFlag = true;
  66.                         }
  67.                     }
  68.             }
  69.         });
  70.         if (!SearchValueFlag) {
  71.            alert(Core.Language.Translate('Please enter at least one search value or * to find anything.'));
  72.         }
  73.         return SearchValueFlag;
  74.     }
  76.     /**
  77.      * @private
  78.      * @name CheckForSearchedValues
  79.      * @memberof Core.Agent.CustomerUserAddressBook
  80.      * @function
  81.      * @description
  82.      *      Adds the given recipients to the ticket for the selected recipient field and close the dialog.
  83.      */
  84.     function AddRecipientsToTicket() {
  85.         var RecipientField = $('#RecipientField').val(),
  86.         Recipients = Core.JSON.Parse($('#RecipientSelectedJSON').val());
  88.         $.each(Recipients, function(UserLogin, CustomerTicketText) {
  90.             if (!CustomerTicketText) {
  91.                 return true;
  92.             }
  94.             parent.Core.App.Publish('Event.CustomerUserAddressBook.AddTicketCustomer.Callback.' + RecipientField, [UserLogin, CustomerTicketText]);
  95.         });
  97.         parent.Core.UI.Dialog.CloseDialog($('.Dialog', parent.document));
  98.     }
  100.     /**
  101.      * @private
  102.      * @name ShowWaitingLoader
  103.      * @memberof Core.Agent.CustomerUserAddressBook
  104.      * @function
  105.      * @param {String} Selector - The selector to add the loader icon to the html.
  106.      * @description
  107.      *      Shows waiting loader until search screen is ready.
  108.      */
  109.     function ShowWaitingLoader(Selector) {
  110.         $('.Dialog .Footer', parent.document).html('');
  111.         $(Selector).after('<div class="Spacing Center"><span class="AJAXLoader" title="' + Core.Config.Get('LoadingMsg') + '"></span></div>');
  112.         $(Selector).remove();
  113.     }
  115.     /**
  116.      * @name InitSearchDialog
  117.      * @memberof Core.Agent.CustomerUserAddressBook
  118.      * @function
  119.      * @description
  120.      *      This function init the search dialog.
  121.      */
  122.     TargetNS.InitSearchDialog = function () {
  124.         // move search button to dialog footer
  125.         $('.Dialog .Footer', parent.document).html($('.SearchFormButton').html());
  126.         $('.Dialog .Footer', parent.document).addClass('Center');
  127.         $('.SearchFormButton').remove();
  129.         // hide add template block
  130.         $('#SearchProfileAddBlock').hide();
  132.         // hide save changes in template block
  133.         $('#SaveProfile').parent().hide().prev().hide().prev().hide();
  135.         // search profile is selected
  136.         if ($('#SearchProfile').val() && $('#SearchProfile').val() !== 'last-search') {
  138.             // show delete button
  139.             $('#SearchProfileDelete').show();
  141.             // show save changes in template block
  142.             $('#SaveProfile').parent().show().prev().show().prev().show();
  144.             // set SaveProfile to 0
  145.             $('#SaveProfile').prop('checked', false);
  146.         }
  148.         Core.Agent.Search.AddSearchAttributes();
  149.         Core.Agent.Search.AdditionalAttributeSelectionRebuild();
  151.         Core.UI.InputFields.Activate($('.Dialog:visible'));
  153.         // register add of attribute
  154.         $('#Attribute').on('change', function () {
  155.             var Attribute = $('#Attribute').val();
  156.             Core.Agent.Search.SearchAttributeAdd(Attribute);
  157.             Core.Agent.Search.AdditionalAttributeSelectionRebuild();
  158.             return false;
  159.         });
  161.         // register return key
  162.         $('#SearchForm').off('keypress.FilterInput').on('keypress.FilterInput', function (Event) {
  163.             if ((Event.charCode || Event.keyCode) === 13) {
  164.                 if (!CheckForSearchedValues()) {
  165.                     return false;
  166.                 }
  167.                 else {
  168.                     $('#SearchFormSubmit', parent.document).trigger('click');
  169.                 }
  170.                 return false;
  171.             }
  172.         });
  174.         // add new profile
  175.         $('#SearchProfileAddAction').on('click', function () {
  176.             var ProfileName, $Element1;
  178.             // get name
  179.             ProfileName = $('#SearchProfileAddName').val();
  181.             // check name
  182.             if (!ProfileName.length || ProfileName.length < 2) {
  183.                 return;
  184.             }
  186.             // add name to profile selection
  187.             $Element1 = $('#SearchProfile').children().first().clone();
  188.             $Element1.text(ProfileName);
  189.             $Element1.attr('value', ProfileName);
  190.             $Element1.prop('selected', true);
  191.             $('#SearchProfile').append($Element1).trigger('redraw.InputField');
  193.             // set input box to empty
  194.             $('#SearchProfileAddName').val('');
  196.             // hide add template block
  197.             $('#SearchProfileAddBlock').hide();
  199.             // hide save changes in template block
  200.             $('#SaveProfile').parent().hide().prev().hide().prev().hide();
  202.             // set SaveProfile to 1
  203.             $('#SaveProfile').prop('checked', true);
  205.             // show delete button
  206.             $('#SearchProfileDelete').show();
  207.         });
  209.         // Close the dialog.
  210.         $('#FormCancel', parent.document).on('click', function() {
  211.             parent.Core.UI.Dialog.CloseDialog($('.Dialog', parent.document));
  212.         });
  215.         // Register submit for search.
  216.         $('#SearchFormSubmit', parent.document).on('click', function () {
  217.             var ShownAttributes = '',
  218.             ExcludeUserLogins = [];
  220.             // Remember shown attributes.
  221.             $('#SearchInsert label').each(function () {
  222.                 if ($(this).attr('id')) {
  223.                     ShownAttributes = ShownAttributes + ';' + $(this).attr('id');
  224.                 }
  225.             });
  226.             $('#SearchForm #ShownAttributes').val(ShownAttributes);
  228.             // Check for already added customer users entries.
  229.             $('.CustomerKey', parent.document).each(function() {
  230.                 if($(this).val()) {
  231.                     ExcludeUserLogins.push($(this).val());
  232.                 }
  233.             });
  235.             if (ExcludeUserLogins) {
  236.                 $('#SearchForm #ExcludeUserLogins').val(Core.JSON.Stringify(ExcludeUserLogins));
  237.             }
  238.             if (!CheckForSearchedValues()) {
  239.                 return false;
  240.             }
  241.             else {
  242.                $('#SearchForm').submit();
  243.                ShowWaitingLoader('.ContentColumn');
  244.             }
  245.         });
  247.         // load profile
  248.         $('#SearchProfile').on('change', function () {
  249.             var SearchProfile = $('#SearchProfile').val(),
  250.                 SearchProfileEmptySearch = $('#EmptySearch').val(),
  251.                 SearchProfileAction = $('#SearchAction').val(),
  252.                 RecipientType = $('#RecipientType').val(),
  253.                 RecipientField = $('#RecipientField').val(),
  254.                 RecipientFieldLabel = $('#RecipientFieldLabel').val();
  256.             window.location.href = Core.Config.Get('Baselink') + 'Action=' + SearchProfileAction + ';RecipientType=' + RecipientType + ';RecipientField=' + RecipientField + ';RecipientFieldLabel=' + RecipientFieldLabel + ';Subaction=LoadProfile;EmptySearch=' +
  257.             encodeURIComponent(SearchProfileEmptySearch) + ';Profile=' + encodeURIComponent(SearchProfile);
  258.             return false;
  259.         });
  261.         // show add profile block or not
  262.         $('#SearchProfileNew').on('click', function (Event) {
  263.             $('#SearchProfileAddBlock').toggle();
  264.             $('#SearchProfileAddName').focus();
  265.             Event.preventDefault();
  266.             return false;
  267.         });
  269.         // delete profile
  270.         $('#SearchProfileDelete').on('click', function (Event) {
  271.             var SearchProfileAction = $('#SearchAction').val(),
  272.                 RecipientType = $('#RecipientType').val(),
  273.                 RecipientField = $('#RecipientField').val(),
  274.                 RecipientFieldLabel = $('#RecipientFieldLabel').val();
  276.             Event.preventDefault();
  278.             // strip all already used attributes
  279.             $('#SearchProfile').find('option:selected').each(function () {
  280.                 if ($(this).attr('value') !== 'last-search') {
  281.                     window.location.href = Core.Config.Get('Baselink') + 'Action=' + SearchProfileAction + ';RecipientType=' + RecipientType + ';RecipientField=' + RecipientField + ';RecipientFieldLabel=' + RecipientFieldLabel + ';Subaction=DeleteProfile;Profile=' +
  282.                     encodeURIComponent($(this).val());
  283.                     return false;
  284.                 }
  285.             });
  286.         });
  287.     };
  289.     /**
  290.      * @name InitRecipientSelection
  291.      * @memberof Core.Agent.CustomerUserAddressBook
  292.      * @function
  293.      * @description
  294.      *      This function init the recipient selection.
  295.      */
  296.     TargetNS.InitRecipientSelection = function () {
  297.         var InitialRecipients = Core.JSON.Parse($('#RecipientSelectedJSON').val());
  299.         // Add the current field label and move recipient selection button in the dialog footer
  300.         //  for the result view, to have the same view in all dialog widgets.
  301.         $('#RecipientSelect span').append(' ' +  $('#RecipientFieldLabel').val() + ' (' + Object.keys(InitialRecipients).length + ')');
  302.         $('.Dialog .Footer', parent.document).html($('.RecipientButton').html());
  303.         $('.RecipientButton').remove();
  305.         if (!Object.keys(InitialRecipients).length) {
  306.             $('#RecipientSelect', parent.document).prop('disabled', true);
  307.             $('#RecipientSelect', parent.document).addClass('Disabled');
  308.         }
  310.         $('#SelectAllCustomerUser').on('click', function () {
  311.             var Status = $(this).prop('checked'),
  312.             Recipients = Core.JSON.Parse($('#RecipientSelectedJSON').val()),
  313.             AddRecipientsButtonHTML = $('#RecipientSelect span', parent.document).html();
  315.             $(RecipientUserLoginElementSelector).prop('checked', Status).triggerHandler('click');
  317.             $(RecipientUserLoginElementSelector).each(function() {
  318.                 var UserLogin = $(this).val();
  320.                 if (Status) {
  321.                     Recipients[UserLogin] = $(this).data('customer-ticket-text');
  322.                 }
  323.                 else {
  324.                     delete Recipients[UserLogin];
  325.                 }
  326.             });
  328.             // Disable the recipient select button, if no recipient is selected.
  329.             if (!Object.keys(Recipients).length) {
  330.                 $('#RecipientSelect', parent.document).prop('disabled', true);
  331.                 $('#RecipientSelect', parent.document).addClass('Disabled');
  332.             }
  333.             else {
  334.                 $('#RecipientSelect', parent.document).prop('disabled', false);
  335.                 $('#RecipientSelect', parent.document).removeClass('Disabled');
  336.             }
  338.             $('#RecipientSelect span', parent.document).html(AddRecipientsButtonHTML.replace(/[ ]?\(?\d*\)?$/, ' (' + Object.keys(Recipients).length + ')'));
  339.             $('#RecipientSelectedJSON').val(Core.JSON.Stringify(Recipients));
  340.         });
  342.         $(RecipientUserLoginElementSelector).on('click', function (Event) {
  343.             var Status = $(this).prop('checked'),
  344.             UserLogin = $(this).val(),
  345.             Recipients = Core.JSON.Parse($('#RecipientSelectedJSON').val()),
  346.             AddRecipientsButtonHTML = $('#RecipientSelect span', parent.document).html();
  348.             Event.stopPropagation();
  349.             Core.Form.SelectAllCheckboxes($(this), $('#SelectAllCustomerUser'));
  351.             if (Status) {
  352.                 Recipients[UserLogin] = $(this).data('customer-ticket-text');
  353.             }
  354.             else {
  355.                 delete Recipients[UserLogin];
  356.             }
  358.             $('#RecipientSelect span', parent.document).html(AddRecipientsButtonHTML.replace(/[ ]?\(?\d*\)?$/, ' (' + Object.keys(Recipients).length + ')'));
  360.             // Disable the recipient select button, if no recipient is selected.
  361.             if (!Object.keys(Recipients).length) {
  362.                 $('#RecipientSelect', parent.document).prop('disabled', true);
  363.                 $('#RecipientSelect', parent.document).addClass('Disabled');
  364.             }
  365.             else {
  366.                 $('#RecipientSelect', parent.document).prop('disabled', false);
  367.                 $('#RecipientSelect', parent.document).removeClass('Disabled');
  368.             }
  370.             $('#RecipientSelectedJSON').val(Core.JSON.Stringify(Recipients));
  371.         });
  373.         $('.MasterAction').off('click').on('click', function () {
  374.             $(this).find('td input[type="checkbox"][name=RecipientUserLogin]').trigger('click');
  375.         });
  377.         // Execute the pagination as a post action instead of get.
  378.         $('span.Pagination a').off('click').on('click', function (Event) {
  379.             var Href = $(this).attr('href'),
  380.             Parts = Href.split('?'),
  381.             URL = Parts[0],
  382.             Params = Parts[1].split(';'),
  383.             Key,
  384.             InputParams,
  385.             InputFields = '';
  387.             Event.stopPropagation();
  388.             Event.preventDefault();
  390.             for (Key in Params) {
  391.                 InputParams = Params[Key].split('=');
  392.                 InputFields += "<input type='hidden' name='" + InputParams[0] + "' value='" + InputParams[1] + "' />";
  393.             }
  395.             // Get the selected recipients json string from the current page to not lose the selections.
  396.             InputFields += "<input type='hidden' name='" + $('#RecipientSelectedJSON').attr('name') + "' value='" + $('#RecipientSelectedJSON').val() + "' />";
  398.             $("body").append('<form action="' + URL + '" method="post" id="SearchResultPagination">' + InputFields + '</form>');
  399.             $("#SearchResultPagination").submit();
  400.         });
  402.         // Close the dialog.
  403.         $('#FormCancel', parent.document).on('click', function() {
  404.             parent.Core.UI.Dialog.CloseDialog($('.Dialog', parent.document));
  405.         });
  407.         // Register Apply button event.
  408.         $('#RecipientSelect', parent.document).on('click', function () {
  409.             AddRecipientsToTicket();
  410.         });
  411.     };
  413.     /**
  414.      * @name Init
  415.      * @memberof Core.Agent.CustomerUserAddressBook
  416.      * @function
  417.      * @description
  418.      *      This function init the customer user adress book search dialog or the result screen.
  419.      */
  420.     TargetNS.Init = function () {
  421.         var ShowSearchDialog = Core.Config.Get('ShowSearchDialog');
  423.         if (typeof ShowSearchDialog !== 'undefined' && parseInt(ShowSearchDialog, 10) === 1) {
  424.             Core.Agent.CustomerUserAddressBook.InitSearchDialog();
  425.         }
  426.         else {
  427.             Core.Agent.CustomerUserAddressBook.InitRecipientSelection();
  428.         }
  429.     };
  431.     Core.Init.RegisterNamespace(TargetNS, 'APP_MODULE');
  433.     return TargetNS;
  434. }(Core.Agent.CustomerUserAddressBook || {}));

^ Use Elevator