source: branches/HeuristicLab.Hive-3.4/sources/HeuristicLab.Clients.Hive/3.4/ServiceClients/HiveExperiment.cs @ 6006

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2010 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab 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 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab 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 HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using HeuristicLab.Clients.Hive.Jobs;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Optimization;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;

namespace HeuristicLab.Clients.Hive {
  [StorableClass]
  public partial class HiveExperiment : IDeepCloneable, IContent, IProgressReporter {
    private JobResultPoller jobResultPoller;

    [Storable]
    private bool useLocalPlugins;
    public bool UseLocalPlugins {
      get { return useLocalPlugins; }
      set { useLocalPlugins = value; }
    }

    [Storable]
    private ExecutionState executionState;
    public ExecutionState ExecutionState {
      get { return executionState; }
      internal set {
        if (executionState != value) {
          executionState = value;
          OnExecutionStateChanged();
        }
      }
    }

    [Storable]
    private TimeSpan executionTime;
    public TimeSpan ExecutionTime {
      get { return executionTime; }
      internal set {
        if (executionTime != value) {
          executionTime = value;
          OnExecutionTimeChanged();
        }
      }
    }

    [Storable]
    private ItemCollection<HiveJob> hiveJobs;
    public ItemCollection<HiveJob> HiveJobs {
      get { return hiveJobs; }
      set {
        DeregisterHiveJobsEvents();
        if (hiveJobs != value) {
          hiveJobs = value;
          RegisterHiveJobsEvents();
          OnHiveJobsChanged();
        }
      }
    }

    [Storable]
    private bool isProgressing;
    public bool IsProgressing {
      get { return isProgressing; }
      set {
        if (isProgressing != value) {
          isProgressing = value;
          OnIsProgressingChanged();
        }
      }
    }

    /** include jobs when refreshing **/
    [Storable]
    private bool includeJobs;
    public bool IncludeJobs {
      get { return includeJobs; }
      set { includeJobs = value; }
    }

    [Storable]
    private bool refreshAutomatically;
    public bool RefreshAutomatically {
      get { return refreshAutomatically; }
      set {
        if (refreshAutomatically != value) {
          refreshAutomatically = value;
          OnRefreshAutomaticallyChanged();
          if (RefreshAutomatically) {
            StartResultPolling();
          } else {
            StopResultPolling();
          }
        }
      }
    }

    [Storable]
    private IProgress progress;
    public IProgress Progress {
      get { return progress; }
      set { this.progress = value; }
    }

    #region Constructors and Cloning
    public HiveExperiment() {
      this.ResourceNames = "HEAL";
      this.includeJobs = true;
      this.refreshAutomatically = true;
    }

    protected HiveExperiment(HiveExperiment original, Cloner cloner) {
      cloner.RegisterClonedObject(original, this);
      this.OwnerUserId = original.OwnerUserId;
      this.DateCreated = original.DateCreated;
      this.ResourceNames = original.ResourceNames;
      this.LastAccessed = original.LastAccessed;
      this.Name = original.Name;
      this.Description = original.Description;
      this.Id = original.Id;

      this.UseLocalPlugins = original.UseLocalPlugins;
      this.ExecutionTime = original.ExecutionTime;
    }
    public override IDeepCloneable Clone(Cloner cloner) {
      return new HiveExperiment(this, cloner);
    }
    #endregion

    public override string ToString() {
      return Name;
    }

    #region Events
    public event EventHandler ExecutionTimeChanged;
    private void OnExecutionTimeChanged() {
      EventHandler handler = ExecutionTimeChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }

    public event EventHandler ExecutionStateChanged;
    private void OnExecutionStateChanged() {
      EventHandler handler = ExecutionStateChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }

    public event EventHandler HiveJobsChanged;
    private void OnHiveJobsChanged() {
      if (jobResultPoller != null && jobResultPoller.IsPolling) {
        jobResultPoller.Stop();
        DeregisterResultPollingEvents();
      }
      if (HiveJobs != null && HiveJobs.Count > 0 && GetAllHiveJobs().All(x => x.Job.Id != Guid.Empty)) {
        if (this.RefreshAutomatically)
          StartResultPolling();
      }
      EventHandler handler = HiveJobsChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }

    public event EventHandler IsProgressingChanged;
    private void OnIsProgressingChanged() {
      EventHandler handler = IsProgressingChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }

    public event EventHandler RefreshAutomaticallyChanged;
    private void OnRefreshAutomaticallyChanged() {
      EventHandler handler = RefreshAutomaticallyChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }
    #endregion

    private void RegisterHiveJobsEvents() {
      //if (HiveJobs != null) {
      //  HiveJobs.JobStateChanged += new EventHandler(HiveJob_JobStateChanged);
      //}
    }

    private void DeregisterHiveJobsEvents() {
      //if (HiveJobs != null) {
      //  HiveJobs.JobStateChanged -= new EventHandler(HiveJob_JobStateChanged);
      //}
    }

    private void HiveJob_JobStateChanged(object sender, EventArgs e) {
      //if (this.HiveJobs != null) {
      //  this.RootJobId = HiveJobs.Job.Id;
      //}
    }

    public Experiment GetExperiment(int idx) {
      if (this.HiveJobs != null) {
        var hj = HiveJobs.ElementAtOrDefault(idx);
        if (hj != null)
          return hj.OptimizerJob.OptimizerAsExperiment;
      }
      return null;
    }

    public void AddExperiment(Experiment experiment) {
      if (this.HiveJobs == null) 
        this.HiveJobs = new ItemCollection<HiveJob>();
      this.HiveJobs.Add(new HiveJob(experiment));
    }

    public void SetExperiment(Experiment experiment) {
      if (this.HiveJobs == null)
        this.HiveJobs = new ItemCollection<HiveJob>();
      else
        this.HiveJobs.Clear();
      this.HiveJobs.Add(new HiveJob(experiment));
    }

    protected override void OnPropertyChanged(PropertyChangedEventArgs e) {
      base.OnPropertyChanged(e);
      if (e.PropertyName == "Name") {
        OnToStringChanged();
      }
    }

    #region JobResultPoller Events

    public void StartResultPolling() {
      if (jobResultPoller == null) {
        jobResultPoller = new JobResultPoller(HiveJobs, /*ApplicationConstants.ResultPollingInterval*/new TimeSpan(0, 0, 5)); //TODO: find a better place for ApplicationConstants
        RegisterResultPollingEvents();
      }

      if (!jobResultPoller.IsPolling) {
        jobResultPoller.Start();
      }
    }

    public void StopResultPolling() {
      if (jobResultPoller != null && jobResultPoller.IsPolling) {
        jobResultPoller.Stop();
      }
    }

    private void RegisterResultPollingEvents() {
      jobResultPoller.ExceptionOccured += new EventHandler<EventArgs<Exception>>(jobResultPoller_ExceptionOccured);
      jobResultPoller.JobResultsReceived += new EventHandler<EventArgs<IEnumerable<LightweightJob>>>(jobResultPoller_JobResultReceived);
      jobResultPoller.IsPollingChanged += new EventHandler(jobResultPoller_IsPollingChanged);
    }
    private void DeregisterResultPollingEvents() {
      jobResultPoller.ExceptionOccured -= new EventHandler<EventArgs<Exception>>(jobResultPoller_ExceptionOccured);
      jobResultPoller.JobResultsReceived -= new EventHandler<EventArgs<IEnumerable<LightweightJob>>>(jobResultPoller_JobResultReceived);
      jobResultPoller.IsPollingChanged -= new EventHandler(jobResultPoller_IsPollingChanged);
    }
    private void jobResultPoller_IsPollingChanged(object sender, EventArgs e) {
      this.refreshAutomatically = jobResultPoller.IsPolling;
      OnRefreshAutomaticallyChanged();
    }
    private void jobResultPoller_JobResultReceived(object sender, EventArgs<IEnumerable<LightweightJob>> e) {
      foreach (LightweightJob lightweightJob in e.Value) {
        HiveJob hj = GetHiveJobById(lightweightJob.Id);
        if (hj != null) {
          DateTime lastJobDataUpdate = hj.Job.LastJobDataUpdate;
          hj.UpdateFromLightweightJob(lightweightJob);

          // lastJobDataUpdate equals DateTime.MinValue right after it was uploaded. When the first results are polled, this value is updated
          if (lastJobDataUpdate != DateTime.MinValue && lastJobDataUpdate < hj.Job.LastJobDataUpdate) {
            OptimizerJob optimizerJob = ExperimentManagerClient.LoadOptimizerJob(hj.Job.Id);
            if (optimizerJob == null) {
              // something bad happened to this job. bad job, BAAAD job!
            } else {
              // if the job is paused, download but don't integrate into parent optimizer (to avoid Prepare)
              if (hj.Job.State == JobState.Paused) {
                hj.OptimizerJob = optimizerJob;
              } else {
                if (lightweightJob.ParentJobId.HasValue) {
                  HiveJob parentHiveJob = GetHiveJobById(lightweightJob.ParentJobId.Value);
                  parentHiveJob.UpdateChildOptimizer(optimizerJob, hj.Job.Id);
                }
              }
            }
          }
        }
      }
      GC.Collect(); // force GC, because .NET is too lazy here (deserialization takes a lot of memory)
      if (AllJobsFinished()) {
        this.ExecutionState = Core.ExecutionState.Stopped;
        StopResultPolling();
        //OnStopped();
      }
      UpdateTotalExecutionTime();
      UpdateStats();
    }

    public HiveJob GetHiveJobById(Guid jobId) {
      foreach (HiveJob job in HiveJobs) {
        HiveJob hj = job.GetHiveJobByJobId(jobId);
        if (hj != null)
          return hj;
      }
      return null;
    }

    private void UpdateStats() {
      var jobs = GetAllHiveJobs();
      this.JobCount = jobs.Count();
      this.CalculatingCount = jobs.Count(j => j.Job.State == JobState.Calculating);
      this.FinishedCount = jobs.Count(j => j.Job.State == JobState.Finished);
    }

    public IEnumerable<HiveJob> GetAllHiveJobs() {
      var jobs = new List<HiveJob>();
      foreach (HiveJob job in HiveJobs) {
        jobs.AddRange(job.GetAllHiveJobs());
      }
      return jobs;
    }

    public bool AllJobsFinished() {
      return GetAllHiveJobs().All(j => j.Job.State == JobState.Finished
                                            || j.Job.State == JobState.Aborted
                                            || j.Job.State == JobState.Failed);
    }

    private void jobResultPoller_ExceptionOccured(object sender, EventArgs<Exception> e) {
      //OnExceptionOccured(e.Value);
    }

    public void UpdateTotalExecutionTime() {
      this.ExecutionTime = TimeSpan.FromMilliseconds(GetAllHiveJobs().Sum(x => x.Job.ExecutionTime.HasValue ? x.Job.ExecutionTime.Value.TotalMilliseconds : 0));
    }
    #endregion

    protected override void RaisePropertyChanged(string propertyName) {
      if (!(propertyName == "ExecutionTime")
        && !(propertyName == "JobCount")
        && !(propertyName == "CalculatingCount")
        && !(propertyName == "FinishedCount")) {
        base.RaisePropertyChanged(propertyName);
      }
    }

    public bool IsFinished() {
      return HiveJobs != null
        && HiveJobs.All(x => x.Job.DateFinished.HasValue && x.Job.DateCreated.HasValue);
    }
  }
}