libWiiSharp/HbcTransmitter.cs

/* This file is part of libWiiSharp
 * Copyright (C) 2009 Leathl
 * Copyright (C) 2020 - 2022 TheShadowEevee, Github Contributors
 * 
 * libWiiSharp 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.
 *
 * libWiiSharp 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

using System;
using System.ComponentModel;
using System.IO;
using System.Net.Sockets;
using System.Runtime.InteropServices;

namespace libWiiSharp
{
    public enum Protocol
    {
        /// <summary>
        /// Will preconfigure all settings for HBC to 1.0.5 (HAXX).
        /// </summary>
        HAXX = 0,
        /// <summary>
        /// Will preconfigure all settings for HBC from 1.0.5 (JODI).
        /// </summary>
        JODI = 1,
        /// <summary>
        /// Remember to define your custom settings.
        /// </summary>
        Custom = 2,
    }

    /// <summary>
    /// The HbcTransmitter can easily transmit files to the Homebrew Channel.
    /// In order to use compression, you need zlib1.dll in the application directory.
    /// </summary>
    public class HbcTransmitter : IDisposable
    {
        private int blocksize = 4096;
        private int wiiloadMayor;
        private int wiiloadMinor = 5;
        private bool compress;
        private string ipAddress;
        private int port = 4299;
        //private string lastErrorMessage = string.Empty;
        private readonly Protocol protocol;
        private TcpClient tcpClient;
        private NetworkStream nwStream;
        private string lastError = string.Empty;
        private int transmittedLength;
        private int compressionRatio;
        private bool isDisposed;

        /// <summary>
        /// The size of the buffer that is used to transmit the data.
        /// Default is 4 * 1024. If you're facing problems (freezes while transmitting), try a higher size.
        /// </summary>
        public int Blocksize
        {
            get => blocksize;
            set => blocksize = value;
        }

        /// <summary>
        /// The mayor version of wiiload. You might need to change it for upcoming releases of the HBC.
        /// </summary>
        public int WiiloadVersionMayor
        {
            get => wiiloadMayor;
            set => wiiloadMayor = value;
        }

        /// <summary>
        /// The minor version of wiiload. You might need to change it for upcoming releases of the HBC.
        /// </summary>
        public int WiiloadVersionMinor
        {
            get => wiiloadMinor;
            set => wiiloadMinor = value;
        }

        /// <summary>
        /// If true, the data will be compressed before being transmitted. NOT available for Protocol.HAXX!
        /// Also, compression will only work if zlib1.dll is in the application folder.
        /// </summary>
        public bool Compress
        {
            get => compress;
            set
            {
                if (protocol == Protocol.HAXX)
                {
                    return;
                }

                compress = value;
            }
        }

        /// <summary>
        /// The IP address of the Wii.
        /// </summary>
        public string IpAddress
        {
            get => ipAddress;
            set => ipAddress = value;
        }

        /// The port used for the transmission.
        /// You don't need to touch this unless the port changes in future releases of the HBC.
        /// </summary>
        public int Port
        {
            get => port;
            set => port = value;
        }

        /// <summary>
        /// After a successfully completed transmission, this value holds the number of transmitted bytes.
        /// </summary>
        public int TransmittedLength => transmittedLength;

        /// <summary>
        /// After a successfully completed transmission, this value holds the compression ratio.
        /// Will be 0 if the data wasn't compressed.
        /// </summary>
        public int CompressionRatio => compressionRatio;

        /// <summary>
        /// Holds the last occured error message.
        /// </summary>
        public string LastError => lastError;

        public HbcTransmitter(Protocol protocol, string ipAddress)
        {
            this.protocol = protocol;
            this.ipAddress = ipAddress;
            wiiloadMinor = protocol == Protocol.HAXX ? 4 : 5;
            compress = protocol == Protocol.JODI;
        }

        #region IDisposable Members

        ~HbcTransmitter() => Dispose(false);

        public void Dispose()
        {
            Dispose(true);
            GC.SuppressFinalize(this);
        }

        protected virtual void Dispose(bool disposing)
        {
            if (disposing && !isDisposed)
            {
                ipAddress = null;
                //this.lastErrorMessage = (string)null;
                lastError = null;
                if (nwStream != null)
                {
                    nwStream.Close();
                    nwStream = null;
                }
                if (tcpClient != null)
                {
                    tcpClient.Close();
                    tcpClient = null;
                }
            }
            isDisposed = true;
        }
        #endregion

        #region Public Functions
        public bool TransmitFile(string pathToFile)
        {
            return Transmit(Path.GetFileName(pathToFile), File.ReadAllBytes(pathToFile));
        }

        public bool TransmitFile(string fileName, byte[] fileData)
        {
            return Transmit(fileName, fileData);
        }
        #endregion

        #region Private Functions
        private bool Transmit(string fileName, byte[] fileData)
        {
            FireDebug("Transmitting {0} to {1}:{2}...", fileName, ipAddress, port);
            if (!Environment.OSVersion.ToString().ToLower().Contains("windows"))
            {
                compress = false;
            }

            if (fileName.ToLower().EndsWith(".zip"))
            {
                compress = false;
            }

            tcpClient = new TcpClient();
            byte[] buffer1 = new byte[4];
            FireDebug("   Connecting...");
            try
            {
                tcpClient.Connect(ipAddress, 4299);
            }
            catch (Exception ex)
            {
                FireDebug("    -> Connection Failed:\n" + ex.Message);
                lastError = "Connection Failed:\n" + ex.Message;
                tcpClient.Close();
                return false;
            }
            nwStream = tcpClient.GetStream();
            FireDebug("   Sending Magic...");
            buffer1[0] = 72;
            buffer1[1] = 65;
            buffer1[2] = 88;
            buffer1[3] = 88;
            try
            {
                nwStream.Write(buffer1, 0, 4);
            }
            catch (Exception ex)
            {
                FireDebug("    -> Error sending Magic:\n" + ex.Message);
                lastError = "Error sending Magic:\n" + ex.Message;
                nwStream.Close();
                tcpClient.Close();
                return false;
            }
            FireDebug("   Sending Version Info...");
            buffer1[0] = (byte)wiiloadMayor;
            buffer1[1] = (byte)wiiloadMinor;
            buffer1[2] = (byte)(fileName.Length + 2 >> 8 & byte.MaxValue);
            buffer1[3] = (byte)(fileName.Length + 2 & byte.MaxValue);
            try
            {
                nwStream.Write(buffer1, 0, 4);
            }
            catch (Exception ex)
            {
                FireDebug("    -> Error sending Version Info:\n" + ex.Message);
                lastError = "Error sending Version Info:\n" + ex.Message;
                nwStream.Close();
                tcpClient.Close();
                return false;
            }
            byte[] buffer2;
            if (compress)
            {
                FireDebug("   Compressing File...");
                try
                {
                    buffer2 = ZlibWrapper.Compress(fileData);
                }
                catch
                {
                    FireDebug("    -> Compression failed, continuing without compression...");
                    compress = false;
                    buffer2 = fileData;
                    fileData = new byte[0];
                }
            }
            else
            {
                buffer2 = fileData;
                fileData = new byte[0];
            }
            FireDebug("   Sending Filesize...");
            buffer1[0] = (byte)(buffer2.Length >> 24 & byte.MaxValue);
            buffer1[1] = (byte)(buffer2.Length >> 16 & byte.MaxValue);
            buffer1[2] = (byte)(buffer2.Length >> 8 & byte.MaxValue);
            buffer1[3] = (byte)(buffer2.Length & byte.MaxValue);
            try
            {
                nwStream.Write(buffer1, 0, 4);
            }
            catch (Exception ex)
            {
                FireDebug("    -> Error sending Filesize:\n" + ex.Message);
                lastError = "Error sending Filesize:\n" + ex.Message;
                nwStream.Close();
                tcpClient.Close();
                return false;
            }
            if (protocol != Protocol.HAXX)
            {
                buffer1[0] = (byte)(fileData.Length >> 24 & byte.MaxValue);
                buffer1[1] = (byte)(fileData.Length >> 16 & byte.MaxValue);
                buffer1[2] = (byte)(fileData.Length >> 8 & byte.MaxValue);
                buffer1[3] = (byte)(fileData.Length & byte.MaxValue);
                try
                {
                    nwStream.Write(buffer1, 0, 4);
                }
                catch (Exception ex)
                {
                    FireDebug("    -> Error sending Filesize:\n" + ex.Message);
                    lastError = "Error sending Filesize:\n" + ex.Message;
                    nwStream.Close();
                    tcpClient.Close();
                    return false;
                }
            }
            FireDebug("   Sending File...");
            int offset = 0;
            int num1 = 0;
            int num2 = buffer2.Length / Blocksize;
            int num3 = buffer2.Length % Blocksize;
            try
            {
                do
                {
                    FireProgress(++num1 * 100 / num2);
                    nwStream.Write(buffer2, offset, Blocksize);
                    offset += Blocksize;
                }
                while (num1 < num2);
                if (num3 > 0)
                {
                    nwStream.Write(buffer2, offset, buffer2.Length - offset);
                }
            }
            catch (Exception ex)
            {
                FireDebug("    -> Error sending File:\n" + ex.Message);
                lastError = "Error sending File:\n" + ex.Message;
                nwStream.Close();
                tcpClient.Close();
                return false;
            }
            FireDebug("   Sending Arguments...");
            byte[] buffer3 = new byte[fileName.Length + 2];
            for (int index = 0; index < fileName.Length; ++index)
            {
                buffer3[index] = (byte)fileName.ToCharArray()[index];
            }

            try
            {
                nwStream.Write(buffer3, 0, buffer3.Length);
            }
            catch (Exception ex)
            {
                FireDebug("    -> Error sending Arguments:\n" + ex.Message);
                lastError = "Error sending Arguments:\n" + ex.Message;
                nwStream.Close();
                tcpClient.Close();
                return false;
            }
            nwStream.Close();
            tcpClient.Close();
            transmittedLength = buffer2.Length;
            compressionRatio = !compress || fileData.Length == 0 ? 0 : buffer2.Length * 100 / fileData.Length;
            FireDebug("Transmitting {0} to {1}:{2} Finished...", fileName, ipAddress, port);
            return true;
        }
        #endregion

        #region Events
        /// <summary>
        /// Fires the Progress of various operations
        /// </summary>
        public event EventHandler<ProgressChangedEventArgs> Progress;

        /// <summary>
        /// Fires debugging messages. You may write them into a log file or log textbox.
        /// </summary>
        public event EventHandler<MessageEventArgs> Debug;

        private void FireDebug(string debugMessage, params object[] args)
        {
            EventHandler<MessageEventArgs> debug = Debug;
            if (debug == null)
            {
                return;
            }

            debug(new object(), new MessageEventArgs(string.Format(debugMessage, args)));
        }

        private void FireProgress(int progressPercentage)
        {
            EventHandler<ProgressChangedEventArgs> progress = Progress;
            if (progress == null)
            {
                return;
            }

            progress(new object(), new ProgressChangedEventArgs(progressPercentage, string.Empty));
        }
        #endregion
    }

    internal class ZlibWrapper
    {
        [DllImport("zlib1.dll")]
        private static extern ZlibWrapper.ZLibError Compress2(
          byte[] dest,
          ref int destLength,
          byte[] source,
          int sourceLength,
          int level);

        public static byte[] Compress(byte[] inFile)
        {
            byte[] array = new byte[inFile.Length + 64];
            int destLength = -1;
            ZlibWrapper.ZLibError zlibError = Compress2(array, ref destLength, inFile, inFile.Length, 6);
            if (zlibError != ZLibError.Z_OK || destLength <= -1 || destLength >= inFile.Length)
            {
                throw new Exception("An error occured while compressing! Code: " + zlibError.ToString());
            }

            Array.Resize<byte>(ref array, destLength);
            return array;
        }

        public enum ZLibError
        {
            Z_VERSION_ERROR = -6, // 0xFFFFFFFA
            Z_BUF_ERROR = -5, // 0xFFFFFFFB
            Z_MEM_ERROR = -4, // 0xFFFFFFFC
            Z_DATA_ERROR = -3, // 0xFFFFFFFD
            Z_STREAM_ERROR = -2, // 0xFFFFFFFE
            Z_ERRNO = -1, // 0xFFFFFFFF
            Z_OK = 0,
            Z_STREAM_END = 1,
            Z_NEED_DICT = 2,
        }
    }

}