/*
Copyright (c) 2019, Lars Brubaker, John Lewin
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.
*/

using System;
using System.Collections.Generic;
using MatterHackers.Agg;
using MatterHackers.Localizations;
using MatterHackers.MatterControl.SlicerConfiguration;
using MatterHackers.VectorMath;

namespace MatterHackers.MatterControl.ConfigurationPage.PrintLeveling
{
	public class ProbeCalibrationWizard : PrinterSetupWizard
	{
		private double babySteppingValue;

		public ProbeCalibrationWizard(PrinterConfig printer)
			: base(printer)
		{
			this.Title = "Probe Calibration".Localize();
		}

		public override bool SetupRequired => NeedsToBeRun(printer);

		public override bool Visible
		{
			get
			{
				return printer.Settings.GetValue<bool>(SettingsKey.has_z_probe)
						&& printer.Settings.GetValue<bool>(SettingsKey.use_z_probe);
			}
		}

		public override bool Enabled => true;

		public static bool NeedsToBeRun(PrinterConfig printer)
		{
			// we have a probe that we are using and we have not done leveling yet
			return UsingZProbe(printer) && !printer.Settings.GetValue<bool>(SettingsKey.probe_has_been_calibrated);
		}

		public override void Dispose()
		{
			// If leveling was on when we started, make sure it is on when we are done.
			printer.Connection.AllowLeveling = true;

			// set the baby stepping back to the last known good value
			printer.Settings.SetValue(SettingsKey.baby_step_z_offset, babySteppingValue.ToString());

			// make sure we raise the probe on close
			if (printer.Settings.GetValue<bool>(SettingsKey.has_z_probe)
				&& printer.Settings.GetValue<bool>(SettingsKey.use_z_probe)
				&& printer.Settings.GetValue<bool>(SettingsKey.has_z_servo))
			{
				// make sure the servo is retracted
				var servoRetract = printer.Settings.GetValue<double>(SettingsKey.z_servo_retracted_angle);
				printer.Connection.QueueLine($"M280 P0 S{servoRetract}");
			}
		}

		public static bool UsingZProbe(PrinterConfig printer)
		{
			var required = printer.Settings.GetValue<bool>(SettingsKey.print_leveling_required_to_print);

			// we have a probe that we are using and we have not done leveling yet
			return (required || printer.Settings.GetValue<bool>(SettingsKey.print_leveling_enabled))
				&& printer.Settings.GetValue<bool>(SettingsKey.has_z_probe)
				&& printer.Settings.GetValue<bool>(SettingsKey.use_z_probe);
		}

		protected override IEnumerator<WizardPage> GetPages()
		{
			var levelingStrings = new LevelingStrings();
			var autoProbePositions = new List<ProbePosition>(3);
			var manualProbePositions = new List<ProbePosition>(3);

			autoProbePositions.Add(new ProbePosition());
			manualProbePositions.Add(new ProbePosition());

			int hotendCount = Math.Min(2, printer.Settings.Helpers.HotendCount());
			int totalSteps = 3 * hotendCount;

			// make a welcome page if this is the first time calibrating the probe
			if (!printer.Settings.GetValue<bool>(SettingsKey.probe_has_been_calibrated))
			{
				yield return new WizardPage(
					this,
					"Initial Printer Setup".Localize(),
					string.Format(
						"{0}\n\n{1}",
						"Congratulations on connecting to your printer. Before starting your first print we need to run a simple calibration procedure.".Localize(),
						"The next few screens will walk your through calibrating your printer.".Localize()))
				{
					WindowTitle = Title
				};
			}

			// Initialize - turn off print leveling
			printer.Connection.AllowLeveling = false;

			// remember the current baby stepping values
			babySteppingValue = printer.Settings.GetValue<double>(SettingsKey.baby_step_z_offset);

			// clear them while we measure the offsets
			printer.Settings.SetValue(SettingsKey.baby_step_z_offset, "0");

			// show what steps will be taken
			yield return new WizardPage(
				this,
				"Overview".Localize(),
				string.Format(
					"{0}\n\n{1}\n\n{2}\n\n",
					"Probe Calibration measures the distance between the probe and the tip of the nozzle.".Localize(),
					"This data is required for software print leveling and ensures good first layer adhesion.".Localize(),
					"Click 'Next' to continue.".Localize()))
			{
				WindowTitle = Title
			};

			// add in the homing printer page
			yield return new HomePrinterPage(
				this,
				"Homing the printer".Localize(),
				levelingStrings.HomingPageInstructions(true, false),
				false);

			// if we have not run leveling yet and there is a level_x_carriage_markdown oem markdown page
			if (LevelingValidation.NeedsToBeRun(printer)
				&& !string.IsNullOrEmpty(printer.Settings.GetValue(SettingsKey.level_x_carriage_markdown)))
			{
				yield return PrintLevelingWizard.GetLevelXCarriagePage(this, printer);
			}

			if (LevelingValidation.NeedsToBeRun(printer))
			{
				// start heating up the bed as that will be needed next
				var bedTemperature = printer.Settings.GetValue<bool>(SettingsKey.has_heated_bed) ?
					printer.Settings.GetValue<double>(SettingsKey.bed_temperature)
					: 0;
				if (bedTemperature > 0)
				{
					printer.Connection.TargetBedTemperature = bedTemperature;
				}
			}

			var extruderCount = printer.Settings.GetValue<int>(SettingsKey.extruder_count);

			var temps = new double[4];
			for (int i = 0; i < extruderCount; i++)
			{
				temps[i] = printer.Settings.Helpers.ExtruderTargetTemperature(i);
			}

			yield return new WaitForTempPage(
				this,
				"Heating the printer".Localize(),
				((extruderCount == 1) ? "Waiting for the hotend to heat to ".Localize() + temps[0] + "°C.\n" : "Waiting for the hotends to heat up.".Localize())
					+ "This will ensure that no filament is stuck to your nozzle.".Localize() + "\n"
					+ "\n"
					+ "Warning! The tip of the nozzle will be HOT!".Localize() + "\n"
					+ "Avoid contact with your skin.".Localize(),
				0,
				temps);

			double startProbeHeight = printer.Settings.GetValue<double>(SettingsKey.print_leveling_probe_start);
			Vector2 probePosition = LevelingPlan.ProbeOffsetSamplePosition(printer);
			Vector3 probeStartPosition = new Vector3(probePosition, startProbeHeight);

			int extruderPriorToMeasure = printer.Connection.ActiveExtruderIndex;

			if (extruderCount > 1)
			{
				// reset the extruder that was active
				printer.Connection.QueueLine($"T0");
			}

			// do the automatic probing of the center position
			yield return new AutoProbeFeedback(
				this,
				probeStartPosition,
				"Probe at bed center".Localize(),
				"Sample the bed center position to determine the probe distance to the bed".Localize(),
				autoProbePositions,
				0);

			// show what steps will be taken
			yield return new WizardPage(
				this,
				"Measure the nozzle offset".Localize(),
				"{0}:\n\n\t• {1}\n\n{2}\n\n{3}".FormatWith(
					"To complete the next few steps you will need".Localize(),
					"A sheet of paper".Localize(),
					"We will use this paper to measure the distance between the nozzle and the bed.".Localize(),
					"Click 'Next' to continue.".Localize()));

			// we currently only support calibrating 2 extruders
			for (int extruderIndex = 0; extruderIndex < hotendCount; extruderIndex++)
			{
				if (extruderCount > 1)
				{
					// reset the extruder that was active
					printer.Connection.QueueLine($"T{extruderIndex}");
				}

				// do the manual prob of the same position
				yield return new GetCoarseBedHeight(
					this,
					new Vector3(probePosition, startProbeHeight),
					string.Format(
						"{0} {1} {2} - {3}",
						levelingStrings.GetStepString(totalSteps),
						"Position".Localize(),
						1,
						"Low Precision".Localize()),
					manualProbePositions,
					0,
					levelingStrings);

				yield return new GetFineBedHeight(
					this,
					string.Format(
						"{0} {1} {2} - {3}",
						levelingStrings.GetStepString(totalSteps),
						"Position".Localize(),
						1,
						"Medium Precision".Localize()),
					manualProbePositions,
					0,
					levelingStrings);

				yield return new GetUltraFineBedHeight(
					this,
					string.Format(
						"{0} {1} {2} - {3}",
						levelingStrings.GetStepString(totalSteps),
						"Position".Localize(),
						1,
						"High Precision".Localize()),
					manualProbePositions,
					0,
					levelingStrings);

				if (extruderIndex == 0)
				{
					// set the probe z offset
					double newProbeOffset = autoProbePositions[0].position.Z - manualProbePositions[0].position.Z;
					var probe_offset = printer.Settings.GetValue<Vector3>(SettingsKey.probe_offset);
					probe_offset.Z = -newProbeOffset;
					printer.Settings.SetValue(SettingsKey.probe_offset, $"{probe_offset.X},{probe_offset.Y},{probe_offset.Z}");
				}
				else if (extruderIndex == 1)
				{
					// store the offset into the extruder offset z position
					double newProbeOffset = autoProbePositions[0].position.Z - manualProbePositions[0].position.Z;
					var hotend0Offset = printer.Settings.GetValue<Vector3>(SettingsKey.probe_offset);
					var newZOffset = newProbeOffset + hotend0Offset.Z;
					printer.Settings.Helpers.SetExtruderZOffset(1, newZOffset);
				}
			}

			printer.Settings.SetValue(SettingsKey.probe_has_been_calibrated, "1");

			if (extruderCount > 1)
			{
				// reset the extruder that was active
				printer.Connection.QueueLine($"T{extruderPriorToMeasure}");
			}

			// clear the baby stepping so we don't save the old values
			babySteppingValue = 0;

			yield return new CalibrateProbeLastPageInstructions(
				this,
				"Done".Localize());
		}
	}
}