fix: delete empty tests folder

- server: change request blank filename check

Dockerfile.server

@@ -9,9 +9,10 @@ WORKDIR /server
 
 # Create files with random content in the /server directory
 RUN mkdir /server_directory
-# these files is only 750 bytes
+
+# These files is only 750 bytes, can fit inside a UDP/TCP packet
 RUN dd if=/dev/urandom of=/server_directory/file_server.txt bs=1 count=750
 RUN dd if=/dev/urandom of=/server_directory/image_server.png bs=1 count=750
 
-# Start your Python application
+# generate a file that has random numbers
-#CMD python server.py --port_number 12000 --debug 1
+RUN for _ in $(seq 1 150); do shuf -i 0-1000 -n 1 >> /server_directory/numbers.txt; done

Makefile

@@ -15,3 +15,8 @@ client-no-debug:
 clean:
 	docker-compose down --volumes
 
+docker-client:
+	docker exec -it project-ftp_client-1 bash
+
+docker-server:
+	docker exec -it project-ftp_server-1 bash

README.md

@@ -1,20 +1,35 @@
 # MyFTP
 
+A Python implementation of a FTP server. Supports both TCP and UDP protocols. Tested on Python 3.11 and Python 3.10.
+
 ## Dependencies
 
-Zero. Only python standard libs were used. Tested on Python 3.11
+Zero. Only python standard libs were used. 
 
 ## Running
 
 ### Client
 
-You can run `python3 src/myftp/client.py --directory <insert valid directory that you have read/write permissions>` to start the client or `python3 src/myftp/client.py --debug 1 --directory <insert valid directory that you have read/write permissions>` for debugging purposes.
+You can run `python3 src/myftp/client.py --directory <insert valid directory that you have read/write permissions>` to start the client.
+
+To run with debug info: `python3 src/myftp/client.py --debug 1 --directory <insert valid directory that you have read/write permissions>`.
+
+Some example test commands:
+
+- `get file_server.txt`
+- `summary numbers.txt`
+- `put file_local.txt`
+- `put image_local.png`
+- `change file_server.txt file_server1.txt`
+- `help`
 
 ### Server
 
 By default, the server IP address or hostname or server name will be `0.0.0.0` or `localhost` (meaning it will bind to all interfaces). The `--port_number` flag, if not specified will be by default `12000`.
 
-You can run `python3 src/myftp/server.py --directory <insert valid directory that you have read/write permissions>` to start the server or `python3 src/myftp/server.py --ip_addr <insert ip addr of the server> --port_number <insert port number here> --debug 1 --directory <insert valid directory that you have read/write permissions>` for debugging purposes and to specify the port number.
+You can run `python3 src/myftp/server.py --directory <insert valid directory that you have read/write permissions>` to start the server.
+
+Or run `python3 src/myftp/server.py --ip_addr <insert ip addr of the server> --port_number <insert port number here> --debug 1 --directory <insert valid directory that you have read/write permissions>` for debugging purposes.
 
 ## Localhost testing
 
@@ -46,6 +61,8 @@ Run `python3 src/myftp/server.py --debug 1 --directory server_directory`
 - Run the server with `make server` in a terminal.
 - Run the client with `make client` in a terminal.
 - For the client, when asked to put in the ip address and port number of the server, you can put in `ftp_server 12000` or adjust to your chosen port number. The IP address is resolved by Docker so ftp_server can not be changed.
+- Go into the `client` docker container with `make docker-client`. The folder in which FTP is using to host client files is located at `/client_directory/`
+- Or go into the `server` docker container with `make docker-server`. The folder in which FTP is using to host server files is located at `/server_directory/`
 - Tear down everything with `make clean`.
 
 #### Fast setup

server_directory/numbers.txt

@@ -0,0 +1,150 @@
+970
+408
+627
+774
+374
+425
+292
+570
+681
+971
+141
+468
+271
+120
+450
+298
+802
+34
+448
+979
+181
+117
+322
+885
+733
+31
+818
+582
+83
+524
+104
+285
+932
+964
+292
+306
+621
+584
+109
+302
+555
+250
+2
+59
+602
+452
+357
+404
+486
+37
+616
+667
+154
+938
+552
+887
+969
+602
+701
+284
+358
+37
+802
+290
+1
+94
+829
+854
+678
+938
+156
+466
+420
+391
+757
+22
+843
+346
+658
+330
+383
+274
+229
+537
+444
+14
+656
+646
+616
+357
+930
+975
+626
+964
+497
+860
+290
+558
+714
+969
+496
+871
+667
+148
+262
+424
+402
+337
+770
+61
+899
+153
+567
+129
+922
+12
+375
+810
+658
+991
+399
+820
+198
+25
+17
+696
+885
+307
+254
+600
+508
+983
+703
+175
+363
+197
+831
+998
+534
+833
+291
+434
+218
+858
+795
+140
+102
+170
+182
+992

src/myftp/client.py

@@ -3,7 +3,7 @@
 # Description: FTP client (both UDP and TCP implemented)
 
 
-from socket import socket, AF_INET, SOCK_DGRAM
+from socket import socket, AF_INET, SOCK_DGRAM, SOCK_STREAM
 from typing import Pattern, Tuple, Optional
 from argparse import ArgumentParser
 import traceback
@@ -11,12 +11,15 @@ import os
 import re
 
 
-# patterns for command matchings
+# Patterns for command matchings
-# compiled for extra performance
+# - compiled for extra performance
-get_command_pattern: Pattern = re.compile(r"^get\s+[^\s]+$")
+# - Ignore case, get or GET both works
-put_command_pattern: Pattern = re.compile(r"^put\s+[^\s]+$")
+get_command_pattern: Pattern = re.compile(r"^get\s+[^\s]+$", re.IGNORECASE)
-summary_command_pattern: Pattern = re.compile(r"^summary\s+[^\s]+$")
+put_command_pattern: Pattern = re.compile(r"^put\s+[^\s]+$", re.IGNORECASE)
-change_command_pattern: Pattern = re.compile(r"^change\s+[^\s]+\s+[^\s]+$")
+summary_command_pattern: Pattern = re.compile(r"^summary\s+[^\s]+$", re.IGNORECASE)
+change_command_pattern: Pattern = re.compile(
+    r"^change\s+[^\s]+\s+[^\s]+$", re.IGNORECASE
+)
 
 # opcodes
 put_request_opcode: int = 0b000
@@ -58,22 +61,35 @@ class Client:
         self.debug = debug
 
     def run(self):
-        client_socket = socket(AF_INET, SOCK_DGRAM)
+        self.client_socket = socket(
-        client_socket.settimeout(10)
+            AF_INET, (SOCK_DGRAM if self.protocol == "UDP" else SOCK_STREAM)
+        )
+        self.client_socket.settimeout(10)
+
+        # only if using TCP
+        try:
+            self.client_socket.connect(
+                (self.server_name, self.server_port)
+            ) if self.protocol == "TCP" else None
+        except ConnectionRefusedError:
+            print(
+                f"myftp> - {self.protocol} - ConnectionRefusedError happened. Please restart the client program, make sure the server is running and/or put a different server name and server port."
+            )
+            return
 
         try:
             while True:
                 # get command from user
-                command = input(f"myftp> - {self.protocol} - : ").strip().lower()
+                command = input(f"myftp> - {self.protocol} - : ").strip()
 
                 # handling the "bye" command
-                if command == "bye":
+                if command == "bye" or command == "BYE":
-                    client_socket.close()
+                    self.client_socket.close()
                     print(f"myftp> - {self.protocol} - Session is terminated")
                     break
 
                 # help
-                elif command == "help":
+                elif command == "help" or command == "HELP":
                     first_byte: int = help_request_opcode << 5
                     command_name = "help"
 
@@ -83,7 +99,8 @@ class Client:
 
                 # get command handling
                 elif get_command_pattern.match(command):
-                    command_name, filename = command.split(" ", 1)
+                    _, filename = command.split(" ", 1)
+                    command_name = "get"
 
                     first_byte = (get_request_opcode << 5) + len(filename)
 
@@ -95,7 +112,8 @@ class Client:
 
                 # put command handling
                 elif put_command_pattern.match(command):
-                    command_name, filename = command.split(" ", 1)
+                    _, filename = command.split(" ", 1)
+                    command_name = "put"
 
                     first_byte, second_byte_to_n_byte, data = self.put_payload_handling(
                         filename
@@ -107,25 +125,45 @@ class Client:
 
                 # summary command handling
                 elif summary_command_pattern.match(command):
-                    command_name, filename = command.split(" ", 1)
+                    _, filename = command.split(" ", 1)
+                    command_name = "summary"
+
                     print(
                         f"myftp> - {self.protocol} - Summary file {filename} from the server"
                     ) if self.debug else None
 
+                    first_byte = (summary_request_opcode << 5) + len(filename)
+
+                    second_byte_to_n_byte = filename.encode("ascii")
+
                 # change command handling
                 elif change_command_pattern.match(command):
-                    command_name, old_filename, new_filename = command.split()
+                    _, old_filename, new_filename = command.split()
+                    command_name = "change"
+
                     print(
                         f"myftp> - {self.protocol} - Changing file named {old_filename} into {new_filename} on the server"
                     ) if self.debug else None
 
+                    first_byte = (change_request_opcode << 5) + len(old_filename)
+
+                    second_byte_to_n_byte = (
+                        old_filename.encode("ascii")
+                        + len(new_filename).to_bytes(1, "big")
+                        + new_filename.encode("ascii")
+                    )
+
                 # unknown request, assigned opcode is 0b101
                 else:
                     command_name = None
                     first_byte: int = unknown_request_opcode << 5
 
-                # get or put case
+                # get change put cases
-                if command_name == "get":
+                if (
+                    command_name == "get"
+                    or command_name == "summary"
+                    or command_name == "change"
+                ):
                     payload = first_byte.to_bytes(1, "big") + second_byte_to_n_byte  # type: ignore
 
                 elif command_name == "put":
@@ -135,23 +173,22 @@ class Client:
                         else first_byte.to_bytes(1, "big")  # type: ignore
                     )
 
-                elif command_name == "summary":
-                    pass
-
-                elif command == "change":
-                    pass
-
                 # help case and unknown request
                 else:
                     payload: bytes = first_byte.to_bytes(1, "big")  # type: ignore
 
                 print(
-                    f"myftp> - {self.protocol} - sent payload {bin(int.from_bytes(payload, byteorder='big'))[2:]} to the server"  # type: ignore
+                    f"myftp> - {self.protocol} - sent payload {payload} to the server. Payload length is {len(payload)}"  # type: ignore
                 ) if self.debug else None
 
-                client_socket.sendto(payload, (self.server_name, self.server_port))  # type: ignore
+                if self.protocol == "UDP":
+                    self.client_socket.sendto(
+                        payload, (self.server_name, self.server_port)
+                    )  # type: ignore
+                else:
+                    self.client_socket.sendall(payload)  # type: ignore
 
-                response_payload = client_socket.recv(2048)
+                response_payload = self.client_socket.recv(2048)
 
                 self.parse_response_payload(response_payload)
 
@@ -166,6 +203,9 @@ class Client:
                 f"myftp> - {self.protocol} - Server at {self.server_name} did not respond within 5 seconds. Check the address or server status."
             )
 
+        except KeyboardInterrupt:
+            print(f"\nmyftp> - {self.protocol} - Client shutting down")
+
         except Exception as error:
             traceback_info = traceback.format_exc()
 
@@ -174,9 +214,14 @@ class Client:
             print(traceback_info)
 
         finally:
-            client_socket.close()
+            self.client_socket.close()
 
     def parse_response_payload(self, response_payload: bytes):
+        """
+        Parse response payload for further processing
+
+        response_payload is the the entire packet that was sent from the server
+        """
         first_byte = bytes([response_payload[0]])
         first_byte_binary = int.from_bytes(first_byte, "big")
         rescode = first_byte_binary >> 5
@@ -197,6 +242,7 @@ class Client:
 
         # error rescodes
         if rescode in [0b011, 0b100, 0b101]:
+            # print to client
             print(f"myftp> - {self.protocol} - {rescode_dict[rescode]}")
 
         # successful rescodes
@@ -209,6 +255,9 @@ class Client:
             # get rescode
             elif rescode == 0b001:
                 self.handle_get_response_from_server(filename_length, response_data)
+            # summary rescode
+            elif rescode == 0b010:
+                self.handle_summary_response_from_server(filename_length, response_data)
 
     def put_payload_handling(
         self, filename: str
@@ -241,6 +290,8 @@ class Client:
         self, filename_length: int, response_data: bytes
     ):
         """
+        Handle the get response from the server
+
         Response_data is
         File name (filename_length bytes) +
         File size (4 bytes) +
@@ -257,8 +308,42 @@ class Client:
 
             print(
                 f"myftp> - {self.protocol} - Filename: {filename}, File_size: {file_size} bytes"
+            ) if self.debug else None
+
+            with open(os.path.join(self.directory_path, filename), "wb") as file:
+                file.write(file_content)
+
+            print(
+                f"myftp> - {self.protocol} - File {filename} has been downloaded successfully"
             )
 
+        except Exception:
+            raise
+
+    def handle_summary_response_from_server(
+        self, filename_length: int, response_data: bytes
+    ):
+        """
+        Handle summary response from server
+
+        Response_data is
+        File name (filename_length bytes) +
+        File size (4 bytes) +
+        File content (rest of the bytes)
+        """
+        try:
+            filename = response_data[:filename_length].decode("ascii")
+            file_size = int.from_bytes(
+                response_data[filename_length : filename_length + 4], "big"
+            )
+            file_content = response_data[
+                filename_length + 4 : filename_length + 4 + file_size
+            ]
+
+            print(
+                f"myftp> - {self.protocol} - Filename: {filename}, File_size: {file_size} bytes"
+            ) if self.debug else None
+
             with open(os.path.join(self.directory_path, filename), "wb") as file:
                 file.write(file_content)
 
@@ -341,27 +426,15 @@ def init():
 
     user_supplied_address = get_address_input()
 
-    # UDP client selected here
+    client = Client(
-    if protocol_selection == "2":
-        udp_client = Client(
         user_supplied_address[0],
         user_supplied_address[1],
         args.directory,
         args.debug,
-            "UDP",
+        ("UDP" if protocol_selection == "2" else "TCP"),
     )
 
-        udp_client.run()
+    client.run()
-    else:
-        tcp_client = Client(
-            user_supplied_address[0],
-            user_supplied_address[1],
-            args.directory,
-            args.debug,
-            "TCP",
-        )
-
-        tcp_client.run()
 
 
 if __name__ == "__main__":

src/myftp/server.py

@@ -3,7 +3,7 @@
 # Description: FTP server (both UDP and TCP implemented)
 
 
-from socket import socket, AF_INET, SOCK_DGRAM
+from socket import socket, AF_INET, SOCK_DGRAM, SOCK_STREAM
 from argparse import ArgumentParser
 from typing import Optional, Tuple
 import traceback
@@ -50,8 +50,14 @@ class Server:
         self.debug = debug
 
     def run(self):
-        self.server_socket = socket(AF_INET, SOCK_DGRAM)
+        server_socket = socket(
-        self.server_socket.bind((self.server_name, self.server_port))
+            AF_INET, (SOCK_DGRAM if self.protocol == "UDP" else SOCK_STREAM)
+        )
+
+        server_socket.bind((self.server_name, self.server_port))
+
+        # only needed for TCP
+        server_socket.listen(5) if self.protocol == "TCP" else None
 
         print(
             f"myftp> - {self.protocol} - Server is ready to receive at {self.server_name}:{self.server_port}"
@@ -60,12 +66,27 @@ class Server:
         shut_down = False
 
         try:
+            if self.protocol == "TCP":
+                client_socket, clientAddress = server_socket.accept()
+
+                print(
+                    f"myftp> - {self.protocol} - Connected to TCP client at {clientAddress}"
+                ) if self.debug else None
+
             while not shut_down:
                 print(
                     f"myftp> - {self.protocol} ------------------------------------------------------------------"
                 ) if self.debug else None
 
-                req_payload, clientAddress = self.server_socket.recvfrom(2048)
+                if self.protocol == "UDP":
+                    req_payload, clientAddress = server_socket.recvfrom(2048)
+                else:
+                    req_payload = client_socket.recv(2048)  # type: ignore
+
+                    # TCP client disconnected
+                    if not req_payload:
+                        client_socket.close()  # type: ignore
+                        return
 
                 first_byte = bytes([req_payload[0]])
 
@@ -74,7 +95,7 @@ class Server:
                 )
 
                 print(
-                    f"myftp> - {self.protocol} - Received message from client at {clientAddress}: {req_payload}"
+                    f"myftp> - {self.protocol} - Received message from client at {clientAddress}: {req_payload}. Payload length is {len(req_payload)}"  # type: ignore
                 ) if self.debug else None
 
                 # help request handling
@@ -124,6 +145,28 @@ class Server:
                         filename = None
                         response_data = None
 
+                elif request_type == "summary":
+                    # empty filename error
+                    if filename_length_in_bytes <= 0:
+                        rescode = rescode_fail_dict["file_not_error_rescode"]
+                    else:
+                        (
+                            rescode,
+                            filename,  # "summary.txt"
+                            filename_length_in_bytes,  # of the summary file
+                            response_data,  # summary.txt file content
+                        ) = self.process_summary_req(
+                            filename_length_in_bytes, req_payload[1:]
+                        )
+
+                elif request_type == "change":
+                    rescode = self.process_change_req(
+                        filename_length_in_bytes, req_payload[1:]
+                    )
+                    filename_length_in_bytes = None
+                    filename = None
+                    response_data = None
+
                 elif request_type == "unknown":
                     rescode = rescode_fail_dict["unknown_request_rescode"]
                     filename_length_in_bytes = None
@@ -137,15 +180,22 @@ class Server:
                     response_data=response_data,  # type:ignore
                 )
 
-                self.server_socket.sendto(res_payload, clientAddress)
+                if self.protocol == "UDP":
+                    server_socket.sendto(res_payload, clientAddress)  # type: ignore
+                else:
+                    client_socket.sendall(res_payload)  # type: ignore
 
                 print(
-                    f"myftp> - {self.protocol} - Sent message to client at {clientAddress}: {res_payload}"
+                    f"myftp> - {self.protocol} - Sent message to client at {clientAddress}: {res_payload}. Payload length is {len(res_payload)}"  # type: ignore
                 ) if self.debug else None
 
         except KeyboardInterrupt:
             shut_down = True
-            self.server_socket.close()
+            if self.protocol == "UDP":
+                server_socket.close()
+            else:
+                client_socket.close()  # type: ignore
+
             print(f"myftp> - {self.protocol} - Server shutting down")
 
         finally:
@@ -174,6 +224,112 @@ class Server:
 
         return request_type, filename_length_in_bytes
 
+    def process_change_req(
+        self, old_filename_length_in_bytes: int, req_payload: bytes
+    ) -> int:
+        """
+        Process change request from client
+        """
+        old_filename = req_payload[:old_filename_length_in_bytes].decode("ascii")
+        new_filename_length = int.from_bytes(
+            req_payload[
+                old_filename_length_in_bytes : old_filename_length_in_bytes + 1
+            ],
+            "big",
+        )
+        new_filename = req_payload[old_filename_length_in_bytes + 1 :].decode("ascii")
+
+        actual_new_filename_length = len(new_filename)
+
+        try:
+            if new_filename_length <= 31 or actual_new_filename_length <= 31:
+                old_filename_full_path = os.path.normpath(
+                    os.path.join(self.directory_path, old_filename)
+                )
+                new_filename_full_path = os.path.normpath(
+                    os.path.join(self.directory_path, new_filename)
+                )
+
+                print(
+                    f"myftp> - {self.protocol} - Changing file named {old_filename_full_path} to new file {new_filename_full_path}"
+                )
+
+                os.rename(old_filename_full_path, new_filename_full_path)
+
+                return rescode_success_dict["correct_put_and_change_request_rescode"]
+
+            else:
+                print(
+                    f"myftp> - {self.protocol} - New file name longer than 31 characters error"
+                )
+                return rescode_fail_dict["unsuccessful_change_rescode"]
+
+        except Exception as error:
+            traceback_info = traceback.format_exc()
+
+            print(f"myftp> - {self.protocol} - {error} happened.")
+
+            print(traceback_info)
+            return rescode_fail_dict["unsuccessful_change_rescode"]
+
+    def process_summary_req(
+        self, filename_length: int, req_payload: bytes
+    ) -> Tuple[int, Optional[str], Optional[int], Optional[bytes]]:
+        """
+        Find the filename mentioned
+        Calculate the min,max,avg
+        Put those numbers into a file called summary.txt
+        """
+        filename = req_payload[:filename_length].decode("ascii")
+
+        print(
+            f"myftp> - {self.protocol} - Summarizing the file named {filename} on the server"
+        )
+
+        try:
+            with open(os.path.join(self.directory_path, filename), "r") as file:
+                numbers = [int(line.strip()) for line in file if line.strip().isdigit()]
+
+                # Find the largest, smallest, and calculate the average
+                largest_number = max(numbers)
+                smallest_number = min(numbers)
+                average_value = sum(numbers) / len(numbers) if numbers else 0
+
+                print(
+                    f"myftp> - {self.protocol} - File {filename} summarized successfully. The max is {largest_number}, the min is {smallest_number}, the average is {average_value}"
+                )
+
+                with open(
+                    os.path.join(self.directory_path, "summary.txt"), "w"
+                ) as summary_file:
+                    summary_file.write(f"min: {smallest_number}\n")
+                    summary_file.write(f"max: {largest_number}\n")
+                    summary_file.write(f"avg: {average_value}\n")
+
+                print(
+                    f"myftp> - {self.protocol} - Created file summary.txt summarized successfully. Sending it back to the client"
+                )
+
+                with open(
+                    os.path.join(self.directory_path, "summary.txt"), "rb"
+                ) as summary_file:
+                    binary_content = summary_file.read()
+
+                return (
+                    rescode_success_dict["correct_summary_request_rescode"],
+                    "summary.txt",
+                    11,
+                    binary_content,
+                )
+
+        except Exception as error:
+            traceback_info = traceback.format_exc()
+
+            print(f"myftp> - {self.protocol} - {error} happened.")
+
+            print(traceback_info)
+            return rescode_fail_dict["file_not_error_rescode"], None, None, None
+
     def process_put_req(self, filename_length: int, req_payload: bytes) -> int:
         """
         Reconstruct file put by client
@@ -217,6 +373,7 @@ class Server:
         If not, return None, None, None tuple
         """
         filename = second_byte_to_byte_n.decode("ascii")
+        print(f"myftp> - {self.protocol} - trying to find file {filename}")
 
         try:
             with open(os.path.join(self.directory_path, filename), "rb") as file:
@@ -229,6 +386,10 @@ class Server:
             print(f"myftp> - {self.protocol} - file {filename} not found")
             return (None, None, None)
 
+        except IsADirectoryError:
+            print(f"myftp> - {self.protocol} - filename is blank")
+            return (None, None, None)
+
     # assembling the payload to send back to the client
     def build_res_payload(
         self,
@@ -263,13 +424,14 @@ class Server:
             # help case
             elif filename is None and response_data is not None:
                 first_byte = ((rescode << 5) + len(response_data)).to_bytes(1, "big")
-            # unsuccessful cases
+            # other cases
             else:
                 first_byte = (rescode << 5).to_bytes(1, "big")
 
             # we only need the firstbyte
             if filename is None:
                 second_byte_to_FL_plus_five = None
+            # second byte and more are needed
             else:
                 # get case
                 second_byte_to_FL_plus_five = (
@@ -282,11 +444,13 @@ class Server:
                 f"myftp> - {self.protocol} - First byte assembled for rescode {format(rescode, '03b')}: {bin(int.from_bytes(first_byte, byteorder='big'))[2:]}"
             ) if self.debug else None
 
+            # get/summary case
             if second_byte_to_FL_plus_five is not None and response_data is not None:
                 res_payload = first_byte + second_byte_to_FL_plus_five + response_data
             # help case
             elif second_byte_to_FL_plus_five is None and response_data is not None:
                 res_payload = first_byte + response_data
+            # change/put case
             else:
                 res_payload = first_byte
 
@@ -354,20 +518,16 @@ def init():
         )
         return
 
-    # UDP client selected here
+    # start the server
-    if protocol_selection == "2":
+    server = Server(
-        udp_server = Server(
+        args.ip_addr,
-            args.ip_addr, args.port_number, args.directory, args.debug, "UDP"
+        args.port_number,
+        args.directory,
+        args.debug,
+        ("UDP" if protocol_selection == "2" else "TCP"),
     )
 
-        udp_server.run()
+    server.run()
-
-    else:
-        tcp_server = Server(
-            args.ip_addr, args.port_number, args.directory, args.debug, "TCP"
-        )
-
-        tcp_server.run()
 
 
 if __name__ == "__main__":