UploadedFileInfo.cs



#region using statements

using Microsoft.AspNetCore.Components;
using Microsoft.AspNetCore.Components.Forms;
using System;
using System.Drawing;
using System.IO;

#endregion

namespace DataJuggler.Blazor.FileUpload
{
    public class UploadedFileInfo
    {

        #region Private Variables
        private bool appendPartialGuid;
        private string partialGuid;
        private DateTime lastModified;
        private string name;
        private long size;
        private string type;
        private int height;
        private int width;
        private bool aborted;
        private string errorMessage;
        private string extension;
        private string uploadFolder;
        private int customId;
        private string tag;
        private bool lastFileInBatch;
        private Exception exception;
        private MemoryStream stream;
        private Image image;
        #endregion

        #region Constructor
        /// <summary>
        /// Create a new instance of an UploadedFileInfo object
        /// </summary>
        /// <param name="file"></param>
        /// <param name="partialGuid"></param>
        public UploadedFileInfo(IBrowserFile file, string partialGuid, bool appendPartialGuid, string uploadFolder)
        {
            // verify both objects exist
            if ((file != null) && (!String.IsNullOrWhiteSpace(partialGuid)))
            {
                // store the arg
                UploadFolder = uploadFolder;

                // Set all the properties
                this.LastModified = file.LastModified.DateTime;
                this.AppendPartialGuid = appendPartialGuid;
                this.Name = file.Name;
                this.Extension = GetExtension(file.Name);
                this.PartialGuid = partialGuid;
                this.Size = file.Size;
                this.Type = GetExtension(file.Name);
            }
        }
        #endregion

        #region Methods

            #region GetExtension(string fileName)
            /// <summary>
            /// This method returns the Extension
            /// </summary>
            public string GetExtension(string fileName)
            {
                // initial value
                string extension = "";

                // if the string exists
                if (!String.IsNullOrEmpty(fileName))
                {
                    // get the last index of a period
                    int index = fileName.LastIndexOf(".");

                    // if the string exists
                    if (index >= 0)
                    {
                        // set the extension
                        extension = fileName.Substring(index);
                    }
                }
                
                // return value
                return extension;
            }
            #endregion
            
        #endregion

        #region Properties

            #region Aborted
            /// <summary>
            /// This property gets or sets the value for 'Aborted'.
            /// </summary>
            public bool Aborted
            {
                get { return aborted; }
                set 
                {
                    aborted = value;

                    if (aborted)
                    {
                        // break point only
                        aborted = true;
                    }
                }
            }
            #endregion
            
            #region AppendPartialGuid
            /// <summary>
            /// This property gets or sets the value for 'AppendPartialGuid'.
            /// </summary>
            public bool AppendPartialGuid
            {
                get { return appendPartialGuid; }
                set { appendPartialGuid = value; }
            }
            #endregion
            
            #region CustomId
            /// <summary>
            /// This property gets or sets the value for RequireCustomIddSizeMessage.
            /// Optional. This property can be used to set information such as databaseId, parentId,
            /// categoryId or some other external classification. This value will lbe returned with
            /// this class if included in the FileUpload component.
            /// </summary>
            public int CustomId
            {
                get { return customId; }
                set { customId = value; }
            }
            #endregion
            
            #region ErrorMessage
            /// <summary>
            /// This property gets or sets the value for 'ErrorMessage'.
            /// </summary>
            public string ErrorMessage
            {
                get { return errorMessage; }
                set { errorMessage = value; }
            }
            #endregion
            
            #region Exception
            /// <summary>
            /// This property gets or sets the value for 'Exception'.
            /// </summary>
            public Exception Exception
            {
                get { return exception; }
                set { exception = value; }
            }
            #endregion
            
            #region Extension
            /// <summary>
            /// This property gets or sets the value for 'Extension'.
            /// </summary>
            public string Extension
            {
                get { return extension; }
                set { extension = value; }
            }
            #endregion

            #region FullName
            /// <summary>
            /// This read only property returns the File Name plus the PartialGuid, if AppendPartialGuid is true.
            /// </summary>
            public string FullName
            {
                get
                {
                    // return value
                    return NameWithPartialGuid;
                }
            }
            #endregion

            #region FullPath
            /// <summary>
            /// This read only property returns the File Name plus the PartialGuid, if AppendPartialGuid is true.
            /// </summary>
            public string FullPath
            {
                get
                {
                    // return value
                    return Path.Combine(UploadFolder, FullName);
                }
            }
            #endregion
            
            #region HasException
            /// <summary>
            /// This property returns true if this object has an 'Exception'.
            /// </summary>
            public bool HasException
            {
                get
                {
                    // initial value
                    bool hasException = (this.Exception != null);
                    
                    // return value
                    return hasException;
                }
            }
            #endregion
            
            #region HasPartialGuid
            /// <summary>
            /// This property returns true if the 'PartialGuid' exists.
            /// </summary>
            public bool HasPartialGuid
            {
                get
                {
                    // initial value
                    bool hasPartialGuid = (!String.IsNullOrWhiteSpace(this.PartialGuid));
                    
                    // return value
                    return hasPartialGuid;
                }
            }
            #endregion
            
            #region HasStream
            /// <summary>
            /// This property returns true if this object has a 'Stream'.
            /// </summary>
            public bool HasStream
            {
                get
                {
                    // initial value
                    bool hasStream = (this.Stream != null);
                    
                    // return value
                    return hasStream;
                }
            }
            #endregion
            
            #region Height
            /// <summary>
            /// This property gets or sets the value for 'Height'.
            /// This property is only available for .jpg and .png files for now.
            /// </summary>
            public int Height
            {
                get { return height; }
                set { height = value; }
            }
            #endregion
            
            #region Image
            /// <summary>
            /// This property gets or sets the value for 'Image'.
            /// </summary>
            public Image Image
            {
                get { return image; }
                set { image = value; }
            }
            #endregion
            
            #region LastFileInBatch
            /// <summary>
            /// This property gets or sets the value for 'LastFileInBatch'.
            /// </summary>
            public bool LastFileInBatch
            {
                get { return lastFileInBatch; }
                set { lastFileInBatch = value; }
            }
            #endregion
            
            #region LastModified
            /// <summary>
            /// This property gets or sets the value for 'LastModified'.
            /// </summary>
            public DateTime LastModified
            {
                get { return lastModified; }
                set { lastModified = value; }
            }
            #endregion
            
            #region Name
            /// <summary>
            /// This property gets or sets the value for 'Name'.
            /// </summary>
            public string Name
            {
                get { return name; }
                set { name = value; }
            }
            #endregion

            #region NameWithPartialGuid
            /// <summary>
            /// This read only property returns the File Name plus the PartialGuid.
            /// </summary>
            public string NameWithPartialGuid
            {
                get
                {
                    // initial value
                    string nameWithPartialGuid = Name;
                    
                    // if the value for AppendPartialGuid is true
                    if (AppendPartialGuid)
                    {
                        // set the return value
                        nameWithPartialGuid = name.Substring(0, name.Length - extension.Length + 1) + partialGuid + extension;
                    }

                    // return value
                    return nameWithPartialGuid;
                }
            }
            #endregion
            
            #region PartialGuid
            /// <summary>
            /// This property gets or sets the value for 'PartialGuid'.
            /// </summary>
            public string PartialGuid
            {
                get { return partialGuid; }
                set { partialGuid = value; }
            }
            #endregion
            
            #region Size
            /// <summary>
            /// This property gets or sets the value for 'Size'.
            /// </summary>
            public long Size
            {
                get { return size; }
                set { size = value; }
            }
            #endregion
            
            #region Stream
            /// <summary>
            /// This property gets or sets the value for 'Stream'.
            /// </summary>
            public MemoryStream Stream
            {
                get { return stream; }
                set { stream = value; }
            }
            #endregion
            
            #region Tag
            /// This property gets or sets the value for Tag.
            /// If set on the FileUpload control, this property can be used to pass information to help
            /// name or classify uploaded files. 
            public string Tag
            {
                get { return tag; }
                set { tag = value; }
            }
            #endregion
            
            #region Type
            /// <summary>
            /// This property gets or sets the value for 'Type'.
            /// </summary>
            public string Type
            {
                get { return type; }
                set { type = value; }
            }
            #endregion
            
            #region UploadFolder
            /// <summary>
            /// This property gets or sets the value for 'UploadFolder'.
            /// </summary>
            public string UploadFolder
            {
                get { return uploadFolder; }
                set { uploadFolder = value; }
            }
            #endregion
            
            #region Width
            /// <summary>
            /// This property gets or sets the value for 'Width'.
            /// This property is only available for .jpg and .png files for now.
            /// </summary>
            public int Width
            {
                get { return width; }
                set { width = value; }
            }
            #endregion
            
        #endregion

    }
}