openproject/frontend/app/components/wp-table/timeline/global-elements/wp-timeline-relations.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 {timelineElementCssClass, TimelineViewParameters} from '../wp-timeline';
import {WorkPackageTimelineTableController} from '../container/wp-timeline-container.directive';
import {openprojectModule} from '../../../../angular-modules';
import {States} from '../../../states.service';
import {WorkPackageStates} from '../../../work-package-states.service';
import {WorkPackageRelationsService} from '../../../wp-relations/wp-relations.service';
import {scopeDestroyed$} from '../../../../helpers/angular-rx-utils';
import {TimelineRelationElement} from './timeline-relation-element';
import {RelationResource} from '../../../api/api-v3/hal-resources/relation-resource.service';
import {WorkPackageTableTimelineService} from '../../../wp-fast-table/state/wp-table-timeline.service';
import {WorkPackageTableTimelineState} from '../../../wp-fast-table/wp-table-timeline';

import {Observable} from 'rxjs';
import * as moment from 'moment';
import Moment = moment.Moment;
import {RenderedRow} from '../../../wp-fast-table/builders/modes/table-render-pass';
import {debugLog} from '../../../../helpers/debug_output';


export const timelineGlobalElementCssClassname = 'relation-line';

function newSegment(vp:TimelineViewParameters,
                    classNames:string[],
                    Yposition:number,
                    top:number,
                    left:number,
                    width:number,
                    height:number):HTMLElement {

  const segment = document.createElement('div');
  segment.classList.add(
    timelineElementCssClass,
    timelineGlobalElementCssClassname,
    ...classNames
  );

  // segment.style.backgroundColor = color;
  segment.style.top = ((Yposition * 41) + top) + 'px';
  segment.style.left = left + 'px';
  segment.style.width = width + 'px';
  segment.style.height = height + 'px';
  return segment;
}

export class WorkPackageTableTimelineRelations {

  public wpTimeline:WorkPackageTimelineTableController;

  private container:JQuery;

  private workPackageIdOrder:RenderedRow[] = [];
  private relationsRequestedFor:string[] = [];

  private elements:TimelineRelationElement[] = [];

  constructor(public $element:ng.IAugmentedJQuery,
              public $scope:ng.IScope,
              public states:States,
              public wpStates:WorkPackageStates,
              public wpTableTimeline:WorkPackageTableTimelineService,
              public wpRelations:WorkPackageRelationsService) {
  }

  $onInit() {
    this.container = this.$element.find('.wp-table-timeline--relations');
    this.wpTimeline.onRefreshRequested('relations', (vp:TimelineViewParameters) => this.refreshView(vp));

    this.requireVisibleRelations();
    this.setupRelationSubscription();
  }

  private refreshView(vp:TimelineViewParameters) {
    this.update(vp);
  }

  /**
   * Ensure visible relations (through table.rows) are loaded automatically.
   */
  private requireVisibleRelations() {
    Observable.combineLatest(
      this.states.table.timelineVisible.values$(),
      this.states.table.rendered.values$()
    )
      .takeUntil(scopeDestroyed$(this.$scope))
      .filter(([timelineState, result]) => timelineState.isVisible && result.renderedOrder.length > 0)
      .map(([timelineState, result]) => result.renderedOrder)
      .subscribe((orderedRows) => {
        // remove all elements. They are refreshed either after initial loading
        this.removeAllVisibleElements();
        this.workPackageIdOrder = orderedRows;
        this.refreshRelationsWhenNeeded();
      });
  }

  private refreshRelationsWhenNeeded():void {
    const requiredForRelations:string[] = [];

    _.each(this.workPackageIdOrder, (el:RenderedRow) => {
      if (el.workPackageId) {
        requiredForRelations.push(el.workPackageId);
      }
    });

    if (_.isEqual(requiredForRelations, this.relationsRequestedFor)) {
      debugLog('WP order unchanged, not requesting new relations, only updating them.');
      this.renderElements(this.wpTimeline.viewParameters);
      return;
    }

    this.relationsRequestedFor = requiredForRelations;
    this.wpRelations.requireInvolved(requiredForRelations);
  }

  /**
   * Refresh relations of visible rows.
   */
  private setupRelationSubscription() {
    // Refresh drawn work package order
    // TODO: Move the rendered work packages into separate state
    Observable.combineLatest(
      this.wpStates.relations.observeChange().takeUntil(scopeDestroyed$(this.$scope)),
      this.states.table.rendered.values$().takeUntil(scopeDestroyed$(this.$scope))
    )
      .withLatestFrom(
        this.states.table.timelineVisible.values$().takeUntil(scopeDestroyed$(this.$scope))
      )
      .filter(([[relations, rendered], timelineVisible]) => relations && timelineVisible.isVisible)
      .map(([[relations, rendered], timelineVisible]) => relations)
      .map(([workPackageId, relations]) => {
        let relevantRelations = _.pickBy(relations!, (relation:RelationResource) => (relation.type === 'precedes' || relation.type === 'follows'));
        return [workPackageId, relevantRelations];
      })
      .filter(([workPackageId, relations]) => !!(workPackageId && this.wpTimeline.cells[workPackageId as string]))
      .subscribe(([workPackageId, relations]) => {
        this.refreshRelations(workPackageId as string, relations);
      });
  }

  private refreshRelations(workPackageId:string, relations:Object) {
    // Remove all previous relations for the work package
    const prefix = TimelineRelationElement.workPackagePrefix(workPackageId);
    this.container.find(`.${prefix}`).remove();
    _.remove(this.elements, (element) => element.belongsToId === workPackageId);

    _.each(relations, (relation:RelationResource) => {
      const elem = new TimelineRelationElement(workPackageId, relation);
      this.elements.push(elem);

      this.renderElement(this.wpTimeline.viewParameters, elem);
    });
  }

  private update(vp:TimelineViewParameters) {
    this.removeAllVisibleElements();
    this.renderElements(vp);
  }

  private removeAllVisibleElements() {
    this.container.find('.' + timelineGlobalElementCssClassname).remove();
  }

  private renderElements(vp:TimelineViewParameters) {
    for (const e of this.elements) {
      this.renderElement(vp, e);
    }
  }

  private renderElement(vp:TimelineViewParameters, e:TimelineRelationElement) {
    const involved = e.relation.ids;

    // Get the rendered rows
    const idxFrom = _.findIndex(this.workPackageIdOrder, (el:RenderedRow) => el.workPackageId === involved.from);
    const idxTo = _.findIndex(this.workPackageIdOrder, (el:RenderedRow) => el.workPackageId === involved.to);

    const startCell = this.wpTimeline.cells[involved.from];
    const endCell = this.wpTimeline.cells[involved.to];

    // If targets do not exist anywhere in the table, skip
    if (idxFrom === -1 || idxTo === -1 || _.isNil(startCell) || _.isNil(endCell)) {
      return;
    }

    // If any of the targets are hidden in the table, skip
    if (this.workPackageIdOrder[idxFrom].hidden || this.workPackageIdOrder[idxTo].hidden) {
      return;
    }

    // Skip if relations cannot be drawn between these cells
    if (!startCell.canConnectRelations() || !endCell.canConnectRelations()) {
      return;
    }

    const directionY = idxFrom < idxTo ? 1 : -1;
    let lastX = startCell.getRightmostPosition();
    let targetX = endCell.getLeftmostPosition();
    const directionX = targetX >= lastX ? 1 : -1;

    // start
    if (!startCell) {
      return;
    }

    // Draw the first line next to the bar/milestone element
    const startLength = 13;
    const height = Math.abs(idxTo - idxFrom);
    this.container.append(newSegment(vp, e.classNames, idxFrom, 19, lastX, startLength, 1));
    lastX += startLength;

    if (directionY === 1) {
      // Draw a line down from from idxFrom to idxTo
      this.container.append(newSegment(vp, e.classNames, idxFrom, 19, lastX, 1, height * 41));
    } else {
      // Draw a line from target row down to idxFrom
      this.container.append(newSegment(vp, e.classNames, idxTo, 20, lastX, 1, height * 41));
    }

    // Draw end corner to the target
    if (directionX === 1) {
      if (directionY === 1) {
        this.container.append(newSegment(vp, e.classNames, idxTo, 19, lastX, targetX - lastX, 1));
      } else {
        this.container.append(newSegment(vp, e.classNames, idxTo, 19, lastX, 1, 22));
        this.container.append(newSegment(vp, e.classNames, idxTo, 19, lastX, targetX - lastX, 1));
      }
    } else {
      if (directionY === 1) {
        this.container.append(newSegment(vp, e.classNames, idxTo, 0, lastX, 1, 8));
        this.container.append(newSegment(vp, e.classNames, idxTo, 8, targetX - 10, lastX - targetX + 11, 1));
        this.container.append(newSegment(vp, e.classNames, idxTo, 8, targetX - 10, 1, 11));
        this.container.append(newSegment(vp, e.classNames, idxTo, 19, targetX - 10, 10, 1));
      } else {
        this.container.append(newSegment(vp, e.classNames, idxTo, 32, lastX, 1, 8));
        this.container.append(newSegment(vp, e.classNames, idxTo, 32, targetX - 10, lastX - targetX + 11, 1));
        this.container.append(newSegment(vp, e.classNames, idxTo, 19, targetX - 10, 1, 13));
        this.container.append(newSegment(vp, e.classNames, idxTo, 19, targetX - 10, 10, 1));
      }
    }
  }

}

openprojectModule.component('wpTimelineRelations', {
  template: '<div class="wp-table-timeline--relations"></div>',
  controller: WorkPackageTableTimelineRelations,
  require: {
    wpTimeline: '^wpTimelineContainer'
  }
});