openproject/frontend/legacy/app/components/remote/remote-field-updater.directive.ts

// -- copyright
// OpenProject is a project management system.
// Copyright (C) 2012-2015 the OpenProject Foundation (OPF)
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License version 3.
//
// OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
// Copyright (C) 2006-2013 Jean-Philippe Lang
// Copyright (C) 2010-2013 the ChiliProject Team
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//
// See doc/COPYRIGHT.rdoc for more details.
// ++

import {keyCodes} from "core-components/keyCodes.enum";
import {openprojectLegacyModule} from "core-app/openproject-legacy-app";

function remoteFieldUpdater($http:ng.IHttpService) {
  return {
    restrict: 'E',
    scope: {
      url: '@',
      mode: '@',
      method: '@'
    },
    link: (scope:any, element:ng.IAugmentedJQuery) => {
      const input = element.find('.remote-field--input');
      const target = element.find('.remote-field--target');
      const method = (scope.method || 'GET').toUpperCase();
      const json = (scope.mode || 'html') === 'json';

      function buildRequest(params:any) {
        const request:any = {
          url: scope.url,
          method: method,
          headers: {},
        };

        // In HTML mode, expect html response
        if (json) {
          request.headers['Accept'] = 'application/json';
        } else {
          request.headers['Accept'] = 'text/html';
        }

        // Append request to either URL params or body
        // Angular doesn't differentiate between those two on its own.
        if (method === 'GET') {
          request['params'] = params;
        } else {
          request['data'] = params;
        }

        return request;
      }

      function updater() {
        var params:any = {};

        // Gather request keys
        input.each((i, el) => {
          var field = angular.element(el);
          params[field.data('remoteFieldKey')] = field.val();
        });

        $http(buildRequest(params)).then((response:any) => {
          if (json) {
            _.each(response.data, (val:string, selector:string) => {
              jQuery('#' + selector).html(val);
            });
          } else {
            // Replace the given target
            target.html(response.data);
          }
        });
      }

      input.on('keyup change', _.debounce(function(event:any) {
          // This prevents an update of the result list when
          // tabbing to the result list (9),
          // pressing enter (13)
          // tabbing back with shift (16) and
          // special cases where the tab code is not correctly recognized (undefined).
          // Thus the focus is kept on the first element of the result list.
          let keyCodesArray = [keyCodes.TAB, keyCodes.ENTER, keyCodes.SHIFT];
          if (keyCodesArray.indexOf(event.keyCode) === -1 && event.keyCode !== null) {
            updater();
          }
        }, 200)
      );
    }
  };
}

openprojectLegacyModule.directive('remoteFieldUpdater', remoteFieldUpdater);