mattercontrol/MatterControlLib/CustomWidgets/ExportPrintItemPage.cs

/*
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 System.IO;
using System.Linq;
using MatterHackers.Agg;
using MatterHackers.Agg.Platform;
using MatterHackers.Agg.UI;
using MatterHackers.Localizations;
using MatterHackers.MatterControl.CustomWidgets;
using MatterHackers.MatterControl.Library;
using MatterHackers.MatterControl.Library.Export;
using MatterHackers.MatterControl.PartPreviewWindow;

namespace MatterHackers.MatterControl
{
	public class ExportPrintItemPage : DialogPage
	{
		private CheckBox showInFolderAfterSave;

		private Dictionary<RadioButton, IExportPlugin> exportPluginButtons;

		private FlowLayoutWidget validationPanel;

		public ExportPrintItemPage(IEnumerable<ILibraryItem> libraryItems, bool centerOnBed, PrinterConfig printer)
		{
			this.WindowTitle = "Export File".Localize();
			var exportWholeBed = libraryItems.First().Name == printer?.Bed.Scene.Name;
			if (exportWholeBed)
			{
				this.HeaderText = "Export bed to".Localize() + ":";
				this.Name = "Export Scene Window";
			}
			else
			{
				this.HeaderText = "Export selection to".Localize() + ":";
				this.Name = "Export Item Window";
			}

			var commonMargin = new BorderDouble(4, 2);

			bool isFirstItem = true;

			// Must be constructed before plugins are initialized
			var exportButton = theme.CreateDialogButton("Export".Localize());
			validationPanel = new FlowLayoutWidget(FlowDirection.TopToBottom)
			{
				HAnchor = HAnchor.Stretch,
				VAnchor = VAnchor.Fit
			};

			// GCode export
			exportPluginButtons = new Dictionary<RadioButton, IExportPlugin>();

			foreach (IExportPlugin plugin in PluginFinder.CreateInstancesOf<IExportPlugin>().OrderBy(p => p.Priority))
			{
				plugin.Initialize(printer);

				// Skip plugins which are invalid for the current printer
				if (!plugin.Enabled)
				{
					if (!string.IsNullOrEmpty(plugin.DisabledReason))
					{
						// add a message to let us know why not enabled
						var disabledPluginButton = new RadioButton(new RadioImageWidget(plugin.ButtonText, theme.TextColor, plugin.Icon))
						{
							HAnchor = HAnchor.Left,
							Margin = commonMargin,
							Cursor = Cursors.Hand,
							Name = plugin.ButtonText + " Button",
							Enabled = false
						};
						contentRow.AddChild(disabledPluginButton);
						contentRow.AddChild(new TextWidget("Disabled: {0}".Localize().FormatWith(plugin.DisabledReason), textColor: theme.PrimaryAccentColor)
						{
							Margin = new BorderDouble(left: 80),
							HAnchor = HAnchor.Left
						});
					}

					continue;
				}

				// Create export button for each plugin
				var pluginButton = new RadioButton(new RadioImageWidget(plugin.ButtonText, theme.TextColor, plugin.Icon))
				{
					HAnchor = HAnchor.Left,
					Margin = commonMargin,
					Cursor = Cursors.Hand,
					Name = plugin.ButtonText + " Button"
				};
				contentRow.AddChild(pluginButton);

				if (plugin is GCodeExport)
				{
					var gcodeExportButton = pluginButton;
					gcodeExportButton.CheckedStateChanged += (s, e) =>
					{
						validationPanel.CloseChildren();

						if (gcodeExportButton.Checked)
						{
							var errors = new List<ValidationError>();
							printer.ValidateSettings(errors, validatePrintBed: false);

							exportButton.Enabled = !errors.Any(item => item.ErrorLevel == ValidationErrorLevel.Error);

							validationPanel.AddChild(
								new ValidationErrorsPanel(
									errors,
									AppContext.Theme)
								{
									HAnchor = HAnchor.Stretch
								});
						}
						else
						{
							exportButton.Enabled = true;
						}
					};
				}

				if (isFirstItem)
				{
					pluginButton.Checked = true;
					isFirstItem = false;
				}

				if (plugin is IExportWithOptions pluginWithOptions)
				{
                    var optionPanel = pluginWithOptions.GetOptionsPanel(libraryItems, pluginButton);
					if (optionPanel != null)
					{
						optionPanel.HAnchor = HAnchor.Stretch;
						optionPanel.VAnchor = VAnchor.Fit;
						contentRow.AddChild(optionPanel);
					}
				}

				exportPluginButtons.Add(pluginButton, plugin);
			}

			ContentRow.AddChild(new VerticalSpacer());
			contentRow.AddChild(validationPanel);

			// TODO: make this work on the mac and then delete this if
			if (AggContext.OperatingSystem == OSType.Windows
				|| AggContext.OperatingSystem == OSType.X11)
			{
				showInFolderAfterSave = new CheckBox("Show file in folder after save".Localize(), theme.TextColor, 10)
				{
					HAnchor = HAnchor.Left,
					Cursor = Cursors.Hand
				};
				contentRow.AddChild(showInFolderAfterSave);
			}

			exportButton.Name = "Export Button";
			exportButton.Click += (s, e) =>
			{
				IExportPlugin activePlugin = null;

				// Loop over all plugin buttons, break on the first checked item found
				foreach (var button in this.exportPluginButtons.Keys)
				{
					if (button.Checked)
					{
						activePlugin = exportPluginButtons[button];
						break;
					}
				}

				// Early exit if no plugin radio button is selected
				if (activePlugin == null)
				{
					return;
				}

				DoExport(libraryItems, printer, activePlugin, centerOnBed, showInFolderAfterSave?.Checked == true);

				this.Parent.CloseOnIdle();
			};

			this.AddPageAction(exportButton);
		}

		public static void DoExport(IEnumerable<ILibraryItem> libraryItems, PrinterConfig printer, IExportPlugin exportPlugin, bool centerOnBed = false, bool showFile = false)
		{
			string targetExtension = exportPlugin.FileExtension;

			if (exportPlugin is FolderExport)
			{
				UiThread.RunOnIdle(() =>
				{
					AggContext.FileDialogs.SelectFolderDialog(
						new SelectFolderDialogParams("Select Location To Export Files")
						{
							ActionButtonLabel = "Export".Localize(),
							Title = ApplicationController.Instance.ProductName + " - " + "Select A Folder".Localize()
						},
						(openParams) =>
						{
							ApplicationController.Instance.Tasks.Execute(
								"Saving".Localize() + "...",
								printer,
								async (reporter, cancellationTokenSource) =>
								{
									string path = openParams.FolderPath;
									if (!string.IsNullOrEmpty(path))
									{
										await exportPlugin.Generate(libraryItems, path, reporter, cancellationTokenSource.Token);
									}
								});
						});
				});

				return;
			}

            if (exportPlugin is ExportStlToExecutable)
            {
                ApplicationController.Instance.Tasks.Execute(
                    "Saving".Localize() + "...",
                    printer,
                    async (reporter, cancellationTokenSource) =>
                    {
                        await exportPlugin.Generate(libraryItems, null, reporter, cancellationTokenSource.Token);
                    });

                return;
            }
            
			UiThread.RunOnIdle(() =>
			{
				string title = ApplicationController.Instance.ProductName + " - " + "Export File".Localize();
				string workspaceName = "Workspace " + DateTime.Now.ToString("yyyy-MM-dd HH_mm_ss");
				AggContext.FileDialogs.SaveFileDialog(
					new SaveFileDialogParams(exportPlugin.ExtensionFilter)
					{
						Title = title,
						ActionButtonLabel = "Export".Localize(),
						FileName = Path.GetFileNameWithoutExtension(libraryItems.FirstOrDefault()?.Name ?? workspaceName)
					},
					(saveParams) =>
					{
						string savePath = saveParams.FileName;

						if (!string.IsNullOrEmpty(savePath))
						{
							ApplicationController.Instance.Tasks.Execute(
								"Exporting".Localize() + "...",
								printer,
								async (reporter, cancellationTokenSource) =>
								{
									string extension = Path.GetExtension(savePath);
									if (!extension.Equals(targetExtension, StringComparison.OrdinalIgnoreCase))
									{
										savePath += targetExtension;
									}

									List<ValidationError> exportErrors = null;

									if (exportPlugin != null)
									{
										if (exportPlugin is GCodeExport gCodeExport)
										{
											gCodeExport.CenterOnBed = centerOnBed;
										}

										exportErrors = await exportPlugin.Generate(libraryItems, savePath, reporter, cancellationTokenSource.Token);
									}

									if (exportErrors == null || exportErrors.Count == 0)
									{
										{
											if (AggContext.OperatingSystem == OSType.Windows || AggContext.OperatingSystem == OSType.X11)
											{
												if (showFile)
												{
													AggContext.FileDialogs.ShowFileInFolder(savePath);
												}
											}
										}
									}
									else
									{
										bool showGenerateErrors = !(exportPlugin is GCodeExport);

										// Only show errors in Generate if not GCodeExport - GCodeExport shows validation errors before Generate call
										if (showGenerateErrors)
										{
											ApplicationController.Instance.ShowValidationErrors("Export Error".Localize(), exportErrors);
										}
									}
								});
						}
					});
			});
		}
	}
}