RPN TCP Calculator

About

Tcp server and client application that allow the users to:

• Create an account
• Authenticate
• Perform calculations
• View their calculation history
• Report bugs

Written with .NET Framework 4.7.2, using a SQLite database.

Team

Product Owner: Bartosz Kosmala

Development Team:

• Roch Goszczyński
• Bartosz Kosmala
• Hubert Knioła

Scrum Master: Roch Goszczyński

Sprint Planning

• Data: 19.01.2021
• Czas trwania: 30m
• Przewidywany czas ukończenia sprintu: 19.01.2021
• Sprint Review: 19.01.2021

User Story

Funkcjonalność wymagana przez klienta:

• historia obliczeń użytkownika,
• możliwość zgłaszania błędów,
• obsługę użytkowników - login oraz hasło,
• rola użytkownika i administratora
• rozszerzenie puli możliwych operacji matematycznych,
• interfejs użytkownika,
• aplikacja okienkowa serwera,
• możliwość zmiany hasła przez użytkownika.

Introduction

Serwer RPN służy do obliczania wyników wyrażeń zapisanych w odwrotnej notacji polskiej (reverse Polish notation, RPN) i przesłania ich do klientów TCP. Dodatkowo umożliwia klientowi możliwość inicjacji zakończenia połączenia oraz wyświetlenia historii wpisanych przez niego wyrażeń wraz w wynikami. Przesłane wyrażenia mogą składać się z liczb, które można przekształcić do typu double lub znaków ( + - * / ^ % root log). Pomiędzy każdym znakiem lub liczbą powinien znajdować się pojedynczy znak spacji.

Functional requirements

• Administrator uruchamia serwer. Istnieje możliwość podania adresu IP oraz portu, na którym serwer ma nasłuchiwać na połączenia. W przypadku braku podania argumentów wartości te zostają ustawione na domyślne.
• Serwer łączy się z bazą danych.
• Serwer autoryzuje użytkowników.
• Serwer rozpoczyna pracę natychmiast po uruchomieniu aplikacji.
• Administrator kończy działanie serwera.
• Klient informuje administratora o błędzie, który napotkał.
• Klient tworzy konto użytkownika.
• Klient zmienia hasło dla wybranego konta
• Klient loguję się do systemu.
• Klient przesyła wiadomości zawierające wyrażenia zapisane w RPN lub nazwy operacji specjalnych, na które serwer odpowiada odpowiednim wynikiem operacji lub przerwaniem połączenia.

Non-functional requirements

• Aplikacja serwera jest aplikacją konsolową działającą na systemie Windows.
• Język programowania: C#.
• Komunikacja pomiędzy serwerem a klientem odbywa się wykorzystując protokół TCP.
• Historia operacji matematycznych klienta jest przechowywana w bazie danych.
• W przypadku błędnych operacji klient otrzymuje odpowiednią informację. Informacje o wewnętrznym błędzie serwera nie są przesyłane do klienta.
• Serwer może obsługiwać wiele połączeń jednorazowo.
• Serwer oraz klient posiadają interfejs graficzny.
• Funkcjonalność serwera może być w łatwy sposób rozszerzona.
• Rozłączenie jednego klienta nie powoduje rozłączenia pozostałych, sesje są od siebie niezależne.

Use case diagram

Activity diagrams

• Assigning admin role in server GUI application

• Assigning admin role in client application

• Change password

• Send calculation request

• Review bug reports

Sequence diagrams

• Change password

• Assigning admin role in client application

Deployment diagram

Class diagram

Client screenshots

Selected code fragments

• Client - function handling user authentication

public static async Task HandleAuthenticationProcedure(NetworkStream stream,
    AuthProcedure authProcedure,
    string username,
    string password,
    string newPassword = null)
{
    var streamReader = new StreamReader(stream);

    if (string.IsNullOrWhiteSpace(username) || string.IsNullOrWhiteSpace(password))
        throw new ArgumentNullException("fields cannot be blank");

    _ = await streamReader.ReadLineAsync(); //You are connected
    _ = await streamReader.ReadLineAsync(); //Please authenticate

    string procedure = string.Empty, request = null;

    switch (authProcedure)
    {
        case AuthProcedure.Login:
            procedure = CoreLocale.Login;
            break;
        case AuthProcedure.Register:
            procedure = CoreLocale.Register;
            break;
        case AuthProcedure.ChangePassword:
            procedure = CoreLocale.ChangePassword;
            request = $"{procedure} {username} {password} {newPassword}";
            break;
    }

    await SendToStreamAsync(stream, request ?? $"{procedure} {username} {password}");

    var message = await streamReader.ReadLineAsync(); //Enter RPN Expression / Error

    switch (message)
    {
        case CoreLocale.UserLoggedIn:
            throw new DuplicateNameException(message);
        case CoreLocale.UsernameTaken:
            throw new DuplicateNameException(message);
        case CoreLocale.NoSuchUsername:
            throw new InvalidCredentialException(message);
        case CoreLocale.InvalidPassword:
            throw new InvalidCredentialException(message);
    }

    _ = await streamReader.ReadLineAsync(); //'history' to check last inputs
    _ = await streamReader.ReadLineAsync(); //'exit' to disconnect
    _ = await streamReader.ReadLineAsync(); //'report <message>' to report a problem
}

• Server GUI Client

private async void startButton_Click(object sender, EventArgs e)
{
      try
      {
           SetVisibility(_buttons, true);
           startButton.Visible = false;
           IPAddress ipAddress = null;
           var port = 0;

           if (ipBox.TextLength.Equals(0) && portBox.TextLength.Equals(0)){     
                ipAddress = IPAddress.Loopback;
                port = 1024;
           }else{
                ipAddress = IPAddress.Parse(ipBox.Text);
                port = int.Parse(portBox.Text);
           }

           if (ipAddress == null || port == 0){
                Console.WriteLine("Please enter following arguments: 1. IP address, 2. port");
                return;
           }

           Console.WriteLine(ipAddress.ToString());

           var contextBuilder = new ContextBuilder(_ctrlWriter.Write);

           _rpnServer = new ResponseServerAsync(ipAddress, port, RPNCalculator.GetResult, Encoding.ASCII,
           contextBuilder.CreateRpnContext, _ctrlWriter.Write);

           if (!isRunned){
               _rpnServer.Start();
               isRunned = true;
           }else
               _ctrlWriter.Write("[Alert] Server is started!");
      }
      catch (Exception)
      {
              _ctrlWriter.Write("[Alert] Start server to use implemented options");
      }
}

• Server

private Task Send(NetworkStream stream, IEnumerable<object> models)
{
        return Send(stream, models.Select(m => m.ToString()));
}

private Task Send(NetworkStream stream, IEnumerable<string> lines)
{
        return Send(stream, string.Join("\r\n", lines));
}

private Task Send(NetworkStream stream, string message)
{
        var messageLine = $"{message}\r\n";
        return stream.WriteAsync(_encoding.GetBytes(messageLine), 0, messageLine.Length);
}

2020 @ PUT