openproject/frontend/app/components/routes/controllers/work-packages-list.controller.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.
// ++

angular
  .module('openproject.workPackages.controllers')
  .controller('WorkPackagesListController', WorkPackagesListController);

function WorkPackagesListController($scope, $rootScope, $state, $stateParams, $location, latestTab,
  I18n, WorkPackagesTableService, WorkPackageService, ProjectService, QueryService,
  PaginationService, AuthorisationService, UrlParamsHelper, Query,
  OPERATORS_AND_LABELS_BY_FILTER_TYPE, NotificationsService, EditableFieldsState) {

  $scope.projectIdentifier = $stateParams.projectPath || null;

  // Setup
  function initialSetup() {
    $scope.operatorsAndLabelsByFilterType = OPERATORS_AND_LABELS_BY_FILTER_TYPE;
    $scope.disableFilters = false;
    $scope.disableNewWorkPackage = true;
    setupFiltersVisibility();
    $scope.toggleShowFilterOptions = function() {
      WorkPackagesTableService.toggleShowFilterOptions();
      setupFiltersVisibility();
    };

    var queryParams = $location.search().query_props;

    var fetchWorkPackages;
    if(queryParams) {
      // Attempt to build up query from URL params
      fetchWorkPackages = fetchWorkPackagesFromUrlParams(queryParams);
    } else if($state.params.query_id) {
      // Load the query by id if present
      fetchWorkPackages = WorkPackageService.getWorkPackagesByQueryId(
        $scope.projectIdentifier, $state.params.query_id);

    } else {
      // Clear the cached query and load the default
      QueryService.clearQuery();
      fetchWorkPackages = WorkPackageService.getWorkPackages($scope.projectIdentifier);
    }

    $scope.settingUpPage = fetchWorkPackages // put promise in scope for cg-busy
      .then(function(json) {
        return setupPage(json, !!queryParams);
      })
      .then(function() {
        fetchAvailableColumns();
        fetchProjectQueries();
        QueryService.loadAvailableGroupedQueries($scope.projectIdentifier);
      });
  }

  function fetchWorkPackagesFromUrlParams(queryParams) {
    try {
      var queryData = UrlParamsHelper.decodeQueryFromJsonParams($state.params.query_id, queryParams);
      var queryFromParams = new Query(queryData, { rawFilters: true });

      // Set pagination options if present
      if(!!queryFromParams.page) {
        PaginationService.setPage(queryFromParams.page);
      }
      if(!!queryFromParams.perPage) {
        PaginationService.setPerPage(queryFromParams.perPage);
      }

      return WorkPackageService.getWorkPackages(
        $scope.projectIdentifier, queryFromParams, PaginationService.getPaginationOptions());

    } catch(e) {
      NotificationsService.addError(
          I18n.t('js.work_packages.query.errors.unretrievable_query')
      );
      clearUrlQueryParams();

      return WorkPackageService.getWorkPackages($scope.projectIdentifier);
    }
  }

  function clearUrlQueryParams() {
    $location.search('query_props', null);
    $location.search('query_id', null);
  }

  function fetchProjectQueries() {
    if ($scope.projectIdentifier) {
      ProjectService.getProject($scope.projectIdentifier)
        .then(function(project) {
          $scope.project = project;
          $scope.projects = [ project ];
        });
    }
  }

  function setupPage(json, queryParamsPresent) {
    initQuery(json.meta, queryParamsPresent);
    setupWorkPackagesTable(json);

    if (json.work_packages.length) {
      WorkPackageService.cache().put('preselectedWorkPackageId', json.work_packages[0].id);
    }
  }

  function initQuery(metaData, queryParamsPresent) {
    var queryData = metaData.query,
        columnData = metaData.columns;

    var cachedQuery = QueryService.getQuery();
    var urlQueryId = $state.params.query_id;

    if (cachedQuery && urlQueryId && cachedQuery.id == urlQueryId) {
      // Augment current unsaved query with url param data
      var updateData = angular.extend(queryData, { columns: columnData });
      $scope.query = QueryService.updateQuery(updateData, afterQuerySetupCallback);
    } else {
      // Set up fresh query from retrieved query meta data
      $scope.query = QueryService.initQuery($state.params.query_id, queryData, columnData,
        metaData.export_formats, afterQuerySetupCallback);

      if (queryParamsPresent) {
        $scope.query.dirty = true;
      }
    }

    $scope.maintainBackUrl();
  }

  function afterQuerySetupCallback(query) {
    setupFiltersVisibility();
  }

  function setupWorkPackagesTable(json) {
    var meta = json.meta,
        workPackages = json.work_packages,
        bulkLinks = json._bulk_links;

    // register data

    // table data
    WorkPackagesTableService.setColumns($scope.query.columns);
    WorkPackagesTableService.addColumnMetaData(meta);
    WorkPackagesTableService.setGroupBy($scope.query.groupBy);
    WorkPackagesTableService.buildRows(workPackages, $scope.query.groupBy);
    WorkPackagesTableService.setBulkLinks(bulkLinks);

    // query data
    QueryService.setTotalEntries(meta.total_entries);

    // pagination data
    PaginationService.setPerPageOptions(meta.per_page_options);
    PaginationService.setPerPage(meta.per_page);
    PaginationService.setPage(meta.page);

    // yield updatable data to scope
    $scope.columns = $scope.query.columns;
    $scope.rows = WorkPackagesTableService.getRows();
    $scope.groupableColumns = WorkPackagesTableService.getGroupableColumns();
    $scope.workPackageCountByGroup = meta.work_package_count_by_group;
    $scope.totalEntries = QueryService.getTotalEntries();

    // Authorisation
    AuthorisationService.initModelAuth("work_package", meta._links);
    AuthorisationService.initModelAuth("query", meta.query._links);
  }

  function setupFiltersVisibility() {
    $scope.showFiltersOptions = WorkPackagesTableService.getShowFilterOptions();
  }

  function fetchAvailableColumns() {
    return QueryService.loadAvailableUnusedColumns($scope.projectIdentifier)
      .then(function(data){
        $scope.availableUnusedColumns = data;
      });
  }

  $scope.maintainBackUrl = function() {
    $scope.backUrl = $location.url();
  };

  // Updates

  $scope.maintainUrlQueryState = function(){
    if($scope.query) {
      $location.search('query_props', UrlParamsHelper.encodeQueryJsonParams($scope.query));
    }
  };

  $scope.loadQuery = function(queryId) {
    // Clear unsaved changes to current query
    clearUrlQueryParams();

    // Load new query
    $scope.settingUpPage = $state.go('work-packages.list', { 'query_id': queryId });
  };

  function updateResults() {
    $scope.$broadcast('openproject.workPackages.updateResults');

    WorkPackageService.getWorkPackages($scope.projectIdentifier,
      $scope.query, PaginationService.getPaginationOptions())
      .then(setupWorkPackagesTable);
  }

  // More

  function serviceErrorHandler(data) {
    // TODO RS: This is where we'd want to put an error message on the dom
    $scope.isLoading = false;
  }

  // Go

  initialSetup();

  $scope.editAll = EditableFieldsState.editAll;

  $scope.$watch(QueryService.getQueryName, function(queryName){
    $scope.selectedTitle = queryName || I18n.t('js.toolbar.unselected_title');
  });

  $rootScope.$on('queryStateChange', function(event, message) {
    $scope.maintainUrlQueryState();
    $scope.maintainBackUrl();
  });

  $rootScope.$on('workPackagesRefreshRequired', function(event, message) {
    updateResults();
  });

  $rootScope.$on('queryClearRequired', function(event, message) {
    $location.search('query_props', null);
    if($location.search().query_id) {
      $location.search('query_id', null);
    } else {
      initialSetup();
    }
  });

  $rootScope.$on('workPackgeLoaded', function(event, message) {
    $scope.maintainBackUrl();
  });

  function nextAvailableWorkPackage() {
    var selected = WorkPackageService.cache().get('preselectedWorkPackageId');
    return selected || $scope.rows.first().object.id;
  }

  $scope.openLatestTab = function() {
    $scope.settingUpPage = $state.go(
      latestTab.getStateName(),
      {
        workPackageId: nextAvailableWorkPackage(),
        'query_props': $location.search()['query_props']
      });
  };

  $scope.openOverviewTab = function() {
    $scope.settingUpPage = $state.go(
      'work-packages.list.details.overview',
      {
        workPackageId: nextAvailableWorkPackage(),
        'query_props': $location.search()['query_props']
      });
  };

  $scope.closeDetailsView = function() {
    var queryProps = $state.params['query_props'];

    $state.go('work-packages.list', { 'query_props': queryProps});
  };

  $scope.showWorkPackageDetails = function(id, force) {
    if (force || $state.current.url != "") {
      $scope.settingUpPage = $state.go(
        latestTab.getStateName(),
        { workPackageId: id, 'query_props': $location.search()['query_props'] }
      );
    }
  };

  $scope.showWorkPackageShowView = function() {
    var id = $state.params.workPackageId
          || $scope.preselectedWorkPackageId || nextAvailableWorkPackage(),

        // Have to use $location.search() here as $state.params
        // isn't filled unless the url is queried for by the
        // browser. This seems to be caused by #maintainUrlQueryState
        // where we set the search via $location.search.
        queryProps = $location.search()['query_props'];

    $state.go('work-packages.show.activity', {
        projectPath: $scope.projectIdentifier || '',
        workPackageId: id,
        'query_props': queryProps
      });
  };

  $scope.getFilterCount = function() {
    if ($scope.query) {
      var filters = $scope.query.filters;
      return _.size(_.where(filters, function(filter) {
        return !filter.deactivated;
      }));
    } else {
      return 0;
    }
  };
}