gorgzorg.h

/*
* This file is part of GorgZorg, a simple multiplatform CLI network file transfer tool.
* It was strongly inspired by the following article:
* https://topic.alibabacloud.com/a/file-transfer-using-the-tcp-protocol-in-qt-can-be-looped-in-one-direction_8_8_10249539.html
* Copyright (C) 2021 Alexandre Albuquerque Arnt
*
* This program 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.
*
* Source code hosted on: https://github.com/aarnt/gorgzorg
*/

#ifndef GORGZORG_H
#define GORGZORG_H

#include <QObject>

class QTcpSocket;
class QTcpServer;
class QFile;
class QElapsedTimer;

const int ctn_BLOCK_SIZE = 4;

const QString ctn_VERSION = QLatin1String("0.3.1(dev)");
const QString ctn_DIR_ESCAPE = QLatin1String("<^dir$>:");
const QString ctn_ZORGED_OK = QLatin1String("Z_OK");
const QString ctn_ZORGED_OK_SEND = QLatin1String("Z_OK_SEND");
const QString ctn_ZORGED_OK_SEND_AND_ZORGED_OK = QLatin1String("Z_OK_SENDZ_OK");
const QString ctn_ZORGED_CANCEL_SEND = QLatin1String("Z_KO_SEND");
const QString ctn_END_OF_TRANSFER = QLatin1String("<[--Finis_tr@nslationi$--]>");

class GorgZorg: public QObject
{
  Q_OBJECT
public:
  explicit GorgZorg();

private:
  QTcpSocket *m_tcpClient;
  QTcpServer *m_server;
  QTcpSocket *m_receivedSocket;
  QElapsedTimer *m_elapsedTime; //Counts ms since starting sending files
  QByteArray m_outBlock;
  QByteArray m_inBlock;
  QFile *m_localFile;
  QFile *m_newFile;
  QString m_fileName;
  QString m_currentPath;
  QString m_currentFileName;
  QString m_targetAddress;
  QString m_archiveFileName;//Contains the random generated name of the archived path to send
  QString m_zorgPath;       //Directory where the server saves received files
  QString m_masterDir;      //Directory which contains the path being received
  QString m_winDrive;       //When running on Windows, this member holds the path drive (ex: "C:\")

  bool m_createMasterDir;
  bool m_singleTransfer;
  bool m_tarContents;
  bool m_zipContents;
  bool m_sendingADir;
  bool m_receivingADir;
  bool m_verbose;
  bool m_alwaysAccept;
  bool m_askForAccept;
  bool m_quitServer;

  qint64 m_loadSize;        //The size of each send data
  qint64 m_byteToWrite;     //The remaining data size
  qint64 m_byteReceived;    //The size that has been sent
  qint64 m_totalSize;       //Total file size
  qint64 m_totalSent;       //Total bytes sent

  int m_block;
  int m_port;
  int m_sendTimes;          //Used to mark whether to send for the first time, after the first connection signal is triggered, followed by manually calling

  QString getShell();
  QString createArchive(const QString &pathToArchive);
  bool prepareToSendFile(const QString &fName);
  void sendFile(const QString &filePath);
  void sendFileHeader(const QString &filePath);
  void sendDirHeader(const QString &filePath);
  void sendEndOfTransfer();
  void removeArchive();

private slots:
  void acceptConnection();
  void readClient();
  void readResponse();
  void send();              //Transfer file header information (original version)
  void sendFileBody();      //Transfer file header information
  void goOnSend(qint64);    //Transfer file contents

public:
  void connectAndSend(const QString &targetAddress, const QString &pathToGorg);
  void startServer(const QString &ipAddress = "");
  void showHelp();
  void showVersion();
  static bool isValidIP(const QString &ip);
  static bool isLocalIP(const QString &ip);  
  static QString getWorkingDirectory();

  //Command line passing params
  inline void setBlockSize(int block) { m_block = block; }
  inline void setPort(int port) { m_port = port; }
  inline void setTarContents() { m_tarContents = true; }
  inline void setZipContents() { m_zipContents = true; }
  inline void setVerbose() { m_verbose = true; }
  inline void setAlwaysAccept() { m_alwaysAccept = true; }
  inline void setQuitServer() { m_quitServer = true; }
  inline void setZorgPath(const QString &value) { m_zorgPath = value; }

signals:
  void endTransfer();
  void cancelSend();
  void okSend();
};

#endif // GORGZORG_H