Simple Tracker project. Part 7: server and client

Simple Tracker, Qt, Iscander Che, C++

Consider now the server and the client.

Questions regarding the general organization of client-server interaction can be found in this article: " An example of using QLocalServer and QLocalSocket ". Here I will touch only on the points directly related to the transfer of information on the task and closing the task.

Server

// trackerserver.cpp

TrackerServer::TrackerServer(QWidget* parent)
    : QWidget(parent)
{
    // Задаём имя сервера
    nameServer = "TrackerServer";
    // Устанавливаем размер следующего блока равным нулю
    nextBlockSize = 0;
    ...
}

// Метод создания и запуска сервера
void TrackerServer::createServer()
{
    localServer = new QLocalServer(this);
    // Если сервер не запустить, выдать сообщение и завершить программу
    if(!localServer->listen(nameServer))
    {
        QMessageBox::critical(0,
                              tr("Ошибка сервера"),
                              tr("Невозможно запустить сервер ") + nameServer + ": "
                              + localServer->errorString());
        localServer->close();
        return;
    }
}
...

// Метод создания подключений
void TrackerServer::createConnections()
{
    // Подключение сигнала сервера о новом подключении к обработчику нового подключения
    connect(localServer, &QLocalServer::newConnection, this, &TrackerServer::slotNewConnection);
    ...
}

Now consider the server slots.

// trackerserver.cpp

// Слот обработки нового соединения
void TrackerServer::slotNewConnection()
{
    // Получаем сокет, подключённый к серверу
    QLocalSocket* socket = localServer->nextPendingConnection();

    // Соединяем сигнал отключения сокета с обработчиком удаления сокета
    connect(socket, &QLocalSocket::disconnected, socket, &QLocalSocket::deleteLater);

    // Соединяем сигнал сокета о готовности передачи данных со слотом закрытия задачи
    connect(socket, &QLocalSocket::readyRead, this, &TrackerServer::slotCloseTask);
}

// Слот получения информации от клиента и закрытия задачи
void TrackerServer::slotCloseTask()
{
    QLocalSocket* socket = (QLocalSocket*)sender();
    QDataStream in(socket);
    in.setVersion(QDataStream::Qt_5_3);
    for(;;)
    {
        if(!nextBlockSize)
        {
            if(socket->bytesAvailable() < (int)sizeof(quint16))
                break;
            in >> nextBlockSize;
        }

        in >> clientTaskNumber >> clientRevision;

        nextBlockSize = 0;
    }

    if(!database->isClosed(clientTaskNumber) && clientTaskNumber && clientRevision)
        // Если задача не закрыта и если номер задачи и ревизия не пустые, закрываем задачу
    {
        database->closeTask(clientTaskNumber, QString("%1").arg(clientRevision));

        // Обновляем SQL-таблицу задач
        taskSqlTableModel->select();

        // Если все задачи для текущего проекта закрыты
        if(database->isClosedAllTasks(projectCurrentId))
            // сделать доступной кнопку "Архивировать"
            archiveProjectButton->setEnabled(true);
        else
            // иначе блокировать кнопку "Архивировать"
            archiveProjectButton->setDisabled(true);
    }
}

Customer

// main.cpp

#include "trackerclient.h"
#include <QCoreApplication>
#include <QFile>
#include <QTextStream>
#include <QDebug>
#include <QRegExp>

int main(int argc, char* argv[])
{
    QCoreApplication app(argc, argv);

    // Считываем из аргумента 1 командной строки путь к файлу log.txt
    QString pathToFile = argv[1];

    QString result;

    // Если файл открывается, считываем данные из файла в строку
    QFile file(pathToFile);
    if(file.open(QIODevice::ReadOnly | QIODevice::Text))
    {
        QTextStream stream(&file);
        result = stream.readAll();
        file.close();
    }
    else
        qDebug() << "Unable open file " + pathToFile;

    int taskNumber = 0;
    int revisionNumber = 0;

    // С помощью регулярного выражения извлекаем из строки номер задачи и номер ревизии
    QString expr = "(.*)(\\#\\{)(\\d+)(\\})(.*)(r\\{)(\\d+)(\\})";
    QRegExp taskRevision(expr);
    int position = taskRevision.indexIn(result);
    if(position > -1)
    {
        taskNumber = taskRevision.cap(3).toInt(); // это номер задачи
        revisionNumber = taskRevision.cap(7).toInt(); // это номер ревизии
    }

    // Инициализируем клиента с соответствующими параметрами
    TrackerClient client("TrackerServer", taskNumber, revisionNumber);

    app.exit(0);
}

Now let's analyze the question of where log.txt comes from.

As I wrote in the previous part, to simplify the tracker, you can use the project creation button to create only a project without VCS support. That is, such a virtual project that exists only in the tracker database and nowhere else.

Projects with SLE support are formed using a bat-file. I wrote it a little earlier out of the need to create and use SVN repositories so that they are automatically archived when there are commits. Let's consider it in the part that concerns the creation of projects with support for hard currency, that is, projects that already exist in the file system.

rem Запрашиваем наименование проекта
set /p repo_name=[Input name project]: 
echo Name repository: %repo_name%

rem Устанавливаем путь к репозиторию
set repo_path=%repo_root%\%repo_name%
echo Full path to repository: %repo_path%

rem Создаём репозиторий
svnadmin create %repo_path%

rem Очищаем папку репозитория hooks
del /f /q %repo_path%\hooks\

rem Создаём / копируем в папке hooks файлы ini.bat, pre-commit.bat, post-commit.bat
echo set commit=n>%repo_path%\hooks\ini.bat
copy pre-commit.bat %repo_path%\hooks\
copy post-commit2.bat %repo_path%\hooks\post-commit.bat

rem Импортируем файловую структуру по умолчанию и формируем первый коммит
svn import %def_tree% file:///%repo_path% -m "initial import"

The ini.bat file contains the commit flag, set to "n" if there are no commits, or set to "y" if there is at least one commit. Based on its state, the archiving script determines whether the given repository should be archived.

rem pre-commit.bat
@echo off

rem Считываем переменные из командной строки
set repo_path=%1
set transaction=%2

rem Записываем сообщение коммита в файл log.txt
"G:\soft\svn\bin\svnlook.exe" log -t "%transaction%" "%repo_path%">%repo_path%\hooks\log.txt

The commit message contains the number of the task to be closed in the format #{ <issue number> } .

rem post-commit.bat

@echo off

rem Считываем переменные из командной строки
set repo_path=%1
set revision=%2

rem Устанавливаем в файле ini.bat флаг commit в "y"
echo set commit=y>%repo_path%\hooks\ini.bat

rem Записываем номер ревизии в файл log.txt
echo r{%revision%}>>%repo_path%\hooks\log.txt

rem 
%path_to_tracker%\ICTrackerClient.exe  %repo_path%\hooks\log.txt

After writing the revision to post-commit.bat, the log.txt file looks something like this.

Closing task #{2} end some editing files
r{29}

And the last client is called, which reads this data from the file.

It remains only to transfer this data to the server.

// trackerclient.h

#ifndef TRACKERCLIENT_H
#define TRACKERCLIENT_H

#include <QObject>
#include <QLocalSocket>

class TrackerClient : public QObject
{
    Q_OBJECT

public:
    explicit TrackerClient(const QString& serverName, int taskId, int revision,
                           QObject* parent = 0);

    ~TrackerClient();

private:
    QLocalSocket* localSocket;
    int taskId;
    int revision;

private slots:
    void sendToServer();
};

#endif // TRACKERCLIENT_H

// trackerclient.cpp

#include "trackerclient.h"
#include <QDataStream>

TrackerClient::TrackerClient(const QString &serverName, int taskId, int revision,
                             QObject* parent) :
    QObject(parent), taskId(taskId), revision(revision)
{
    localSocket = new QLocalSocket(this);
    localSocket->setServerName(serverName);

    connect(localSocket, &QLocalSocket::connected, this, &TrackerClient::sendToServer);

    localSocket->connectToServer();
}

TrackerClient::~TrackerClient()
{
}

void TrackerClient::sendToServer()
{
    QByteArray arrayBlock;
    QDataStream out(&arrayBlock, QIODevice::WriteOnly);
    out.setVersion(QDataStream::Qt_5_3);
    out << quint16(0) << taskId << revision;

    out.device()->seek(0);
    out << quint16(arrayBlock.size() - sizeof(quint16));

    localSocket->write(arrayBlock);

    localSocket->disconnectFromServer();
}