openproject/frontend/app/ui_components/inplace-editor-directive.js

//-- 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.
//++

module.exports = function(
  $timeout, FocusHelper, PathHelper,
  InplaceEditorDispatcher, OverviewTabInplaceEditorConfig) {
  return {
    restrict: 'A',
    transclude: false,
    templateUrl: '/templates/components/inplace_editor.html',
    scope: {
      type: '@inedType',
      displayStrategy: '@?inedDisplayStrategy',
      entity: '=inedEntity',
      attribute: '@inedAttribute',
      attributeTitle: '@inedAttributeTitle',
      embedded: '=inedAttributeEmbedded',
      placeholder: '@',
      autocompletePath: '@'
    },
    link: link,
    controller: Controller
  };

  function link(scope, element, attrs) {
    element.on('click', '.ined-read-value.editable', function(e) {
      if (angular.element(e.target).is('a')) {
        return;
      }
      scope.$apply(function() {
        scope.startEditing();
      });
    });
    element.bind('keydown keypress', function(e) {
      if (e.keyCode == 27) {
        scope.$apply(function() {
          scope.discardEditing();
        });
      }
    });
    scope.$on('startEditing', function() {
      $timeout(function() {
        var inputElement = element.find('.ined-input-wrapper-inner .focus-input');
        if (inputElement.length) {
          FocusHelper.focus(inputElement);
          inputElement.triggerHandler('keyup');
        }
      });
    });
    scope.$on('finishEditing', function() {
      FocusHelper.focusElement(element.find('.editing-link-wrapper'));
    });
    InplaceEditorDispatcher.dispatchHook(scope, 'link', element);
  }

  Controller.$inject = ['$scope', 'WorkPackageService', 'ApiHelper'];
  function Controller($scope, WorkPackageService, ApiHelper) {
    $scope.isEditing = false;
    $scope.isEditable = !!$scope.entity.links.updateImmediately;
    $scope.isBusy = false;
    $scope.readValue = '';
    $scope.editTitle = I18n.t('js.inplace.button_edit', { attribute: $scope.attributeTitle });
    $scope.saveTitle = I18n.t('js.inplace.button_save', { attribute: $scope.attributeTitle });
    $scope.saveAndSendTitle = I18n.t('js.inplace.button_save_and_send', { attribute: $scope.attributeTitle });
    $scope.cancelTitle = I18n.t('js.inplace.button_cancel', { attribute: $scope.attributeTitle });
    $scope.error = null;
    $scope.options = [];

    $scope.startEditing = startEditing;
    $scope.discardEditing = discardEditing;
    $scope.submit = submit;
    $scope.onSuccess = onSuccess;
    $scope.onFail = onFail;
    $scope.onFinally = onFinally;
    $scope.getTemplateUrl = getTemplateUrl;
    $scope.getDisplayTemplateUrl = getDisplayTemplateUrl;
    $scope.collectChanges = collectChanges;
    $scope.acceptChanges = acceptChanges;
    $scope.acceptErrors = acceptErrors;
    $scope.pathHelper = PathHelper;

    $scope.nullValueLabel = I18n.t('js.inplace.null_value_label');

    activate();

    function activate() {
      // Editor activation and write value retrieval depend on the work package
      // form to be available. But the form is only available if the work
      // package is editable.
      if ($scope.isEditable) {
        InplaceEditorDispatcher.dispatchHook($scope, 'activate');
        setWriteValue();
      }

      setReadValue();
    }

    function setWriteValue() {
      InplaceEditorDispatcher.dispatchHook($scope, 'setWriteValue');
    }

    function startEditing() {
      setWriteValue();
      $scope.isEditing = true;
      $scope.error = null;
      $scope.isBusy = false;
      InplaceEditorDispatcher.dispatchHook($scope, 'startEditing');
      $scope.$broadcast('startEditing');
      OverviewTabInplaceEditorConfig.registerActiveEditorScope($scope);
    }

    function submit(notify) {
      // angular.copy here to make a new object instead of a reference
      $scope.isBusy = true;
      var data = angular.copy($scope.entity.form.embedded.payload.props);
      OverviewTabInplaceEditorConfig.collectChanges(data);
      var result = WorkPackageService.updateWorkPackage($scope.entity, data, notify);
      result.then(function(workPackage) {
        $scope.onSuccess(workPackage);
      });
      result.catch(function(e) {
        $scope.onFail(e);
        OverviewTabInplaceEditorConfig.dispatchErrors(e);
      });
    }

    function collectChanges(data) {
      InplaceEditorDispatcher.dispatchHook($scope, 'submit', data);
    }

    function acceptChanges(workPackage) {
      $scope.entity = workPackage;
      setReadValue();
      finishEditing();
      $scope.onFinally();
    }

    function acceptErrors(e) {
      $scope.onFail(e);
    }

    function onSuccess(entity) {
      $scope.error = null;
      $scope.isBusy = true;
      $scope.$emit(
        'workPackageRefreshRequired',
        function(workPackage) {
          OverviewTabInplaceEditorConfig.dispatchChanges(workPackage);
        }
      );
    }

    function onFail(e) {
      $scope.error = ApiHelper.getErrorMessage(e);
      InplaceEditorDispatcher.dispatchHook($scope, 'onFail');
      $scope.onFinally();
    }

    function onFinally() {
      $scope.isBusy = false;
    }

    function discardEditing() {
      finishEditing();
    }

    function finishEditing() {
      $scope.isEditing = false;
      $scope.$broadcast('finishEditing');
      $timeout(function() {
        OverviewTabInplaceEditorConfig.deregisterActiveEditorScope($scope);
      });
    }

    function setReadValue() {
      InplaceEditorDispatcher.dispatchHook($scope, 'setReadValue');
      if ($scope.isEditable && isReadValueEmpty() && $scope.placeholder) {
        $scope.readValue = $scope.placeholder;
        $scope.placeholderSet = true;
      } else {
        $scope.placeholderSet = false;
      }
    }

    function isReadValueEmpty() {
      return !$scope.readValue;
    }

    function getTemplateUrl() {
      return '/templates/components/inplace_editor/editable/' + $scope.type + '.html';
    }

    function getDisplayTemplateUrl() {
      return '/templates/components/inplace_editor/display/' +
        ($scope.displayStrategy || 'default') +'.html';
    }

  }
};