openproject/frontend/app/components/work-packages/work-package-cache.service.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 {SchemaCacheService} from './../schemas/schema-cache.service';
import {State} from 'reactivestates';
import {Observable, Subject} from 'rxjs';
import {opWorkPackagesModule} from '../../angular-modules';
import {
  WorkPackageResourceInterface
} from '../api/api-v3/hal-resources/work-package-resource.service';
import {ApiWorkPackagesService} from '../api/api-work-packages/api-work-packages.service';
import {States} from '../states.service';
import {WorkPackageNotificationService} from './../wp-edit/wp-notification.service';
import IScope = angular.IScope;
import IPromise = angular.IPromise;
import {WorkPackageCollectionResourceInterface} from '../api/api-v3/hal-resources/wp-collection-resource.service';
import {SchemaResource} from '../api/api-v3/hal-resources/schema-resource.service';
import {StateCacheService} from '../states/state-cache.service';

function getWorkPackageId(id:number | string):string {
  return (id || "__new_work_package__").toString();
}

export class WorkPackageCacheService extends StateCacheService<WorkPackageResourceInterface> {

  private newWorkPackageCreatedSubject = new Subject<WorkPackageResourceInterface>();

  /*@ngInject*/
  constructor(private states:States,
              private $q:angular.IQService,
              private wpNotificationsService:WorkPackageNotificationService,
              private schemaCacheService:SchemaCacheService,
              private apiWorkPackages:ApiWorkPackagesService) {
    super();
  }

  newWorkPackageCreated(wp:WorkPackageResourceInterface) {
    this.newWorkPackageCreatedSubject.next(wp);
  }

  updateWorkPackage(wp:WorkPackageResourceInterface) {
    this.updateValue(wp.id, wp);
  }

  updateWorkPackageList(list:WorkPackageResourceInterface[]) {
    for (var wp of list) {
      const workPackageId = getWorkPackageId(wp.id);
      const wpState = this.states.workPackages.get(workPackageId);
      const lastValue = wpState.value;
      const wpForPublish = lastValue && lastValue.dirty
        ? lastValue // dirty, use current wp
        : wp; // not dirty or unknown, use new wp

      // Ensure the schema is loaded
      // so that no consumer needs to call schema#$load manually
      this.schemaCacheService.ensureLoaded(wp).then(() => {
        wpState.putValue(wpForPublish);
      });
    }
  }

  saveWorkPackage(workPackage:WorkPackageResourceInterface):IPromise<WorkPackageResourceInterface | null> {
    if (!(workPackage.dirty || workPackage.isNew)) {
      return this.$q.reject(null);
    }

    const deferred = this.$q.defer<WorkPackageResourceInterface>();
    workPackage.save()
      .then(() => {
        this.wpNotificationsService.showSave(workPackage);
        deferred.resolve(workPackage);
      })
      .catch((error) => {
        this.wpNotificationsService.handleErrorResponse(error, workPackage);
        deferred.reject(workPackage);
      });

    return deferred.promise;
  }

  /**
   * Wrapper around `require(id)`.
   *
   * @deprecated
   */
  loadWorkPackage(workPackageId:string, forceUpdate = false):State<WorkPackageResourceInterface> {
    const state = this.state(workPackageId);

    // Several services involved in the creation of work packages
    // use this method to resolve the latest created work package,
    // so let them just subscribe.
    if (workPackageId === 'new') {
      return state;
    }

    this.require(workPackageId, forceUpdate);
    return state;
  }

  onNewWorkPackage():Observable<WorkPackageResourceInterface> {
    return this.newWorkPackageCreatedSubject.asObservable();
  }

  protected loadAll(ids:string[]) {
    return new Promise<undefined>((resolve, reject) => {
      this.apiWorkPackages
        .loadWorkPackagesCollectionsFor(_.uniq(ids))
        .then((pagedResults:WorkPackageCollectionResourceInterface[]) => {
          _.each(pagedResults, (results) => {
            if (results.schemas) {
              _.each(results.schemas.elements, (schema:SchemaResource) => {
                this.states.schemas.get(schema.href as string).putValue(schema);
              });
            }

            if (results.elements) {
              this.updateWorkPackageList(results.elements);
            }

            resolve(undefined);
          });
        }, reject);
    });
  }

  protected load(id:string) {
    return new Promise<WorkPackageResourceInterface>((resolve, reject) => {
      this.apiWorkPackages.loadWorkPackageById(id, true)
        .then((workPackage:WorkPackageResourceInterface) => {
          this.schemaCacheService.ensureLoaded(workPackage).then(() => {
            this.updateValue(id, workPackage);
            resolve(workPackage);
          }, reject);
        }, reject);
    });
  }

  protected get multiState() {
    return this.states.workPackages;
  }

}

opWorkPackagesModule.service('wpCacheService', WorkPackageCacheService);