mattercontrol/MatterControlLib/Queue/QueueData.cs

/*
Copyright (c) 2017, Kevin Pope, 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 System.Text;
using MatterHackers.Agg;
using MatterHackers.Agg.Platform;
using MatterHackers.Agg.UI;
using MatterHackers.DataConverters3D;
using MatterHackers.Localizations;
using MatterHackers.MatterControl.DataStorage;
using MatterHackers.MatterControl.PrinterCommunication;
using MatterHackers.PolygonMesh.Processors;

namespace MatterHackers.MatterControl.PrintQueue
{
	public class ItemChangedArgs : EventArgs
	{
		public int Index { get; private set; }

		internal ItemChangedArgs(int index)
		{
			this.Index = index;
		}
	}

	public class QueueData
	{
		public static readonly string SdCardFileName = "SD_CARD";

		private List<PrintItemWrapper> printItems = new List<PrintItemWrapper>();

		public List<PrintItemWrapper> PrintItems
		{
			get { return printItems; }
		}

		public RootedObjectEventHandler ItemAdded = new RootedObjectEventHandler();
		public RootedObjectEventHandler ItemRemoved = new RootedObjectEventHandler();

		private static QueueData instance;
		public static QueueData Instance
		{
			get
			{
				if (instance == null)
				{
					instance = new QueueData();
					instance.LoadDefaultQueue();
				}
				return instance;
			}
		}

		public void RemoveAt(int index)
		{
			if (index >= 0 && index < ItemCount)
			{
				PrintItems.RemoveAt(index);

				OnItemRemoved(new ItemChangedArgs(index));
				SaveDefaultQueue();
			}
		}

		public void OnItemRemoved(EventArgs e)
		{
			ItemRemoved.CallEvents(this, e);
		}

		public PrintItemWrapper GetPrintItemWrapper(int index)
		{
			if (index >= 0 && index < PrintItems.Count)
			{
				return PrintItems[index];
			}

			return null;
		}

		public int GetIndex(PrintItemWrapper printItem)
		{
			return PrintItems.IndexOf(printItem);
		}

		public string[] GetItemNames()
		{
			List<string> itemNames = new List<string>();
			for (int i = 0; i < PrintItems.Count; i++)
			{
				itemNames.Add(PrintItems[i].Name);
			}

			return itemNames.ToArray();
		}

		public string GetItemName(int itemIndex)
		{
			return PrintItems[itemIndex].Name;
		}

		public List<PrintItem> CreateReadOnlyPartList(bool includeProtectedItems)
		{
			List<PrintItem> listToReturn = new List<PrintItem>();
			for (int i = 0; i < ItemCount; i++)
			{
				var printItem = GetPrintItemWrapper(i).PrintItem;
				if (includeProtectedItems
					|| !printItem.Protected)
				{
					listToReturn.Add(printItem);
				}
			}
			return listToReturn;
		}

		private static readonly bool Is32Bit = IntPtr.Size == 4;

		private PrintItemWrapper partUnderConsideration = null;

		public enum ValidateSizeOn32BitSystems { Required, Skip }

		public void AddItem(PrintItemWrapper item, int indexToInsert = -1, ValidateSizeOn32BitSystems checkSize = ValidateSizeOn32BitSystems.Required)
		{
			if (Is32Bit)
			{
				// Check if the part we are adding is BIG. If it is warn the user and
				// possibly don't add it
				bool warnAboutFileSize = false;
				long estimatedMemoryUse = 0;
				if (File.Exists(item.FileLocation)
					&& checkSize == ValidateSizeOn32BitSystems.Required)
				{
					estimatedMemoryUse = GetEstimatedMemoryUse(item.FileLocation);

					// If we have less than 2 gigs memory, warn on smaller file size
					if (AggContext.PhysicalMemory < 2000000000)
					{
						if (estimatedMemoryUse > 100000000)
						{
							warnAboutFileSize = true;
						}
					}
					else
					{
						if (estimatedMemoryUse > 500000000)
						{
							warnAboutFileSize = true;
						}
					}
				}

				if (warnAboutFileSize)
				{
					partUnderConsideration = item;
					// Show a dialog and only load the part to the queue if the user clicks yes.
					UiThread.RunOnIdle(() =>
					{
						string memoryWarningMessage = "Are you sure you want to add this part ({0}) to the Queue?\nThe 3D part you are trying to load may be too complicated and cause performance or stability problems.\n\nConsider reducing the geometry before proceeding.".Localize().FormatWith(item.Name);
						StyledMessageBox.ShowMessageBox(
							UserSaidToAllowAddToQueue, memoryWarningMessage, "File May Cause Problems".Localize(), StyledMessageBox.MessageType.YES_NO, "Add To Queue", "Do Not Add");
						// show a dialog to tell the user there is an update
					});
					return;
				}
				else
				{
					DoAddItem(item, indexToInsert);
				}
			}
			else
			{
				DoAddItem(item, indexToInsert);
			}
		}

		public static long GetEstimatedMemoryUse(string fileLocation)
		{
			switch (Path.GetExtension(fileLocation).ToUpper())
			{
				case ".STL":
					return StlProcessing.GetEstimatedMemoryUse(fileLocation);

				case ".AMF":
					return AmfDocument.GetEstimatedMemoryUse(fileLocation);

				case ".OBJ":
					throw new NotImplementedException();
			}

			return 0;
		}

		private void UserSaidToAllowAddToQueue(bool messageBoxResponse)
		{
			if (messageBoxResponse)
			{
				DoAddItem(partUnderConsideration, -1);
			}
		}

		private void DoAddItem(PrintItemWrapper item, int insertAt)
		{
			if (insertAt == -1)
			{
				insertAt = PrintItems.Count;
			}

			PrintItems.Insert(insertAt, item);
			OnItemAdded(new ItemChangedArgs(insertAt));
			SaveDefaultQueue();
		}

		public void LoadDefaultQueue()
		{
			RemoveAll();
			ManifestFileHandler manifest = new ManifestFileHandler(null);
			List<PrintItem> partFiles = manifest.ImportFromJson();
			if (partFiles != null)
			{
				foreach (PrintItem item in partFiles)
				{
					AddItem(new PrintItemWrapper(item), -1, QueueData.ValidateSizeOn32BitSystems.Skip);
				}
			}
			RemoveAllSdCardFiles();
		}

		public void RemoveAllSdCardFiles()
		{
			for (int i = ItemCount - 1; i >= 0; i--)
			{
				PrintItem printItem = PrintItems[i].PrintItem;
				if (printItem.FileLocation == QueueData.SdCardFileName)
				{
					RemoveAt(i);
				}
			}
		}

		public void OnItemAdded(EventArgs e)
		{
			ItemAdded.CallEvents(this, e);
		}

		public void SaveDefaultQueue()
		{
			List<PrintItem> partList = CreateReadOnlyPartList(true);
			ManifestFileHandler manifest = new ManifestFileHandler(partList);
			manifest.ExportToJson();
		}

		public int ItemCount
		{
			get
			{
				return PrintItems.Count;
			}
		}

		public void RemoveAll()
		{
			for (int i = PrintItems.Count - 1; i >= 0; i--)
			{
				RemoveAt(i);
			}
		}
	}
}