Merge pull request #500 from Hyperloop-UPV/electron/add-python-tftp-app

Electron/Add BLCU

Author: Humanoidear

blcu-programming/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

blcu-programming/.gitignore

@@ -0,0 +1,10 @@
+/.venv
+/.vscode
+*.pyc
+*__pycache__/
+*.pyo
+*.pyd
+.idea/
+containers/*/.venv
+.env
+*.log

blcu-programming/LICENSE

@@ -0,0 +1,76 @@
+# TFTP Server and Client
+
+**TFTP Server and Client** is a comprehensive Python-based application designed to facilitate Trivial File Transfer Protocol (TFTP) operations through a user-friendly graphical interface built with PyQt5. This tool allows users to efficiently manage file transfers to and from TFTP servers, making it an essential resource for network administrators.
+
+## Key Features
+
+### TFTP Server
+- **Start/Stop Server:** Easily control the TFTP server with start and stop functionalities.
+- **Select IP Address:** Choose the specific IP address for the server to listen on.
+- **Change Working Directory:** Modify the current working directory for file transfers with a straightforward interface.
+- **View Directory Contents:** Quickly access and view files in the current working directory.
+- **Logging:** Track server activity with real-time logging displayed in the application and stored in a log file.
+[tftp_server](../TFTP_GUI_Server_Client/screenshot/tftp_server.png)
+### TFTP Client
+- **Upload Files:** Seamlessly upload files to a TFTP server using a simple interface.
+- **Download Files:** Effortlessly download files from a TFTP server with progress monitoring.
+- **File Browsing:** Use an integrated file dialog for easy file selection.
+- **Status Updates:** Receive real-time status updates during upload and download processes.
+[tftp_client](../TFTP_GUI_Server_Client/screenshot/tftp_client.png)
+### Monitoring and Alerts
+- Monitor TFTP server activities and transfer statuses with immediate feedback on successes or failures.
+- Real-time updates ensure that users can track the progress of their operations.
+
+### Error Handling and Prompt Detection
+- Implement robust error handling specific to TFTP operations to ensure smooth functionality.
+- Dynamic prompt detection allows the application to handle varying device responses effectively.
+
+## Example Configurations
+
+### Setting Up the TFTP Server
+1. Launch the application and navigate to the TFTP Server tab.
+2. Select an available IP address from the dropdown menu.
+3. Specify the desired port number (default is 69).
+4. Click **Start Server** to begin listening for incoming TFTP requests.
+
+### Uploading Files
+1. Navigate to the TFTP Client tab.
+2. Enter the TFTP server IP address.
+3. Use the **Browse Upload...** button to select the file you wish to upload.
+4. Click **Upload File** and monitor the status for updates.
+
+### Downloading Files
+1. Enter the TFTP server IP address and specify the file name for download.
+2. Click **Download File** to initiate the download process.
+3. Progress and status will be displayed in real time.
+
+## System Requirements
+
+To run the TFTP Server and Client application, the following system requirements must be met:
+
+- **Python 3.x**
+- **PyQt5**
+- **TFTP Library** 
+- **OS:** Windows 10 or Ubuntu >=20.04 (recommended) or any modern Linux distribution 
+
+## Technologies Used
+
+- **Python:** The core language utilized for backend logic.
+- **PyQt5:** The framework used for developing the graphical user interface.
+- **TFTP Library:** Employed for implementing TFTP protocol functionalities.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! Please fork the repository and create a pull request with your enhancements. Alternatively, you can open an issue to suggest improvements or report bugs.
+
+## Author
+
+**petrunetworking** (Network Engineer)
+
+## Acknowledgements
+
+Developed using Python and inspired by the need for efficient file transfer solutions, this application aims to simplify TFTP operations for network professionals, enabling them to manage their file transfers effectively and reliably.

blcu-programming/README.md

@@ -0,0 +1,232 @@
+import sys
+import os
+import threading
+import socket
+import logging
+from PyQt5 import QtWidgets, QtGui, QtCore
+from tftp.TFTPServer import TftpPacketDAT, TftpPacketERR, TftpServer
+from tftp.TftpClient import TftpClient
+# Logging Configuration
+logger = logging.getLogger('tftp_server')
+logger.setLevel(logging.INFO)
+file_handler = logging.FileHandler('tftp_server_activity.log')
+formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
+file_handler.setFormatter(formatter)
+logger.addHandler(file_handler)
+
+import socket
+
+import psutil
+
+def get_ip_addresses():
+    """Get the list of available IP addresses on the local machine across all interfaces."""
+    ip_addresses = []
+
+    for interface, addresses in psutil.net_if_addrs().items():
+        for address in addresses:
+            if address.family == socket.AF_INET:  # IPv4 addresses only
+                ip_addresses.append(address.address)
+    
+    # Remove duplicates and return the list of IP addresses
+    return list(set(ip_addresses))
+
+class TFTPClient(QtWidgets.QWidget):
+    log_signal = QtCore.pyqtSignal(str)  # Signal to update log
+
+    def __init__(self):
+        super().__init__()
+        self.setWindowTitle("TFTP Client")
+        self.setGeometry(500, 100, 500, 400)
+
+        self.hardcoded_ip = "192.168.0.27"
+
+        self.ip_input = QtWidgets.QLineEdit(self)
+        self.ip_input.setPlaceholderText("Enter Server IP Address")
+        self.ip_input.setText(self.hardcoded_ip)  # Set hardcoded IP
+        self.ip_input.setReadOnly(True)
+
+        # Separate inputs for upload and download
+        self.upload_file_input = QtWidgets.QLineEdit(self)
+        self.upload_file_input.setPlaceholderText("Select File to Upload")
+        
+        self.download_file_input = QtWidgets.QLineEdit(self)
+        self.download_file_input.setPlaceholderText("Enter File Name to Download")
+
+        self.browse_button = QtWidgets.QPushButton("Browse Upload...", self)
+        self.browse_button.clicked.connect(self.browse_upload_file)
+
+        self.download_button = QtWidgets.QPushButton("Download File", self)
+        self.download_button.clicked.connect(self.download_file)
+
+        self.upload_button = QtWidgets.QPushButton("Upload File", self)
+        self.upload_button.clicked.connect(self.upload_file)
+
+        self.use_folder_checkbox = QtWidgets.QCheckBox("Use selected folder for download", self)
+        self.use_folder_checkbox.setChecked(False)  # Default unchecked
+
+        self.default_directory_label = QtWidgets.QLabel(self)
+        self.default_directory_label.setText(f"Default Download Directory: {self.get_default_directory()}")
+
+        self.status_label = QtWidgets.QLabel("Status: Waiting", self)
+        self.status_label.setStyleSheet("font-weight: bold;")
+
+        self.log_output = QtWidgets.QTextEdit(self)
+        self.log_output.setReadOnly(True)
+
+        layout = QtWidgets.QVBoxLayout()
+        layout.addWidget(QtWidgets.QLabel("Enter Server IP Address:"))
+        layout.addWidget(self.ip_input)
+
+        # Upload file section
+        layout.addWidget(QtWidgets.QLabel("File to Upload:"))
+        layout.addWidget(self.upload_file_input)
+        layout.addWidget(self.browse_button)
+
+        # Download file section
+        layout.addWidget(QtWidgets.QLabel("File to Download:"))
+        layout.addWidget(self.download_file_input)
+        layout.addWidget(self.use_folder_checkbox)  # Add the checkbox here
+
+        # Add the default directory label
+        layout.addWidget(self.default_directory_label)
+
+        button_layout = QtWidgets.QHBoxLayout()
+        button_layout.addWidget(self.download_button)
+        button_layout.addWidget(self.upload_button)
+        button_layout.addWidget(self.status_label)
+        layout.addLayout(button_layout)
+
+        layout.addWidget(QtWidgets.QLabel("Client Log:"))
+        layout.addWidget(self.log_output)
+
+        self.setLayout(layout)
+        self.setStyleSheet("background-color: #f0f0f0; font-family: Arial;")
+
+        self.total_size = 0
+        self.downloaded_size = 0
+
+        # Connect the log signal to the update_log method
+        self.log_signal.connect(self.update_log)
+
+    def get_default_directory(self):
+        """Return the default download directory."""
+        return os.path.expanduser("~")  # User's home directory
+
+    def browse_upload_file(self):
+        options = QtWidgets.QFileDialog.Options()
+        file_name, _ = QtWidgets.QFileDialog.getOpenFileName(self, "Select File to Upload", "", "All Files (*);;Text Files (*.txt)", options=options)
+        if file_name:
+            self.upload_file_input.setText(file_name)  # Save the full path for the selected file
+
+    def download_file(self):
+        ip = self.ip_input.text()  # Get the manually entered IP address
+        filename = self.download_file_input.text()
+
+        if self.use_folder_checkbox.isChecked():
+            # Open a dialog to select the folder for saving the downloaded file
+            folder = QtWidgets.QFileDialog.getExistingDirectory(self, "Select Folder to Save Downloaded File")
+            
+            if folder:  # Proceed only if a folder was selected
+                self.status_label.setText("Status: Downloading...")
+                self.log_output.clear()  # Clear previous logs
+
+                # Construct the full path for the downloaded file
+                full_path = os.path.join(folder, filename)
+
+                # Start a new thread for downloading to avoid blocking the UI
+                threading.Thread(target=self.perform_download, args=(ip, full_path), daemon=True).start()
+            else:
+                self.log_signal.emit("Download canceled: No folder selected.")
+        else:
+            # Default save path (you can modify this to your preferred default directory)
+            default_directory = self.get_default_directory()
+            full_path = os.path.join(default_directory, filename)
+
+            self.status_label.setText("Status: Downloading...")
+            self.log_output.clear()  # Clear previous logs
+
+            # Start a new thread for downloading to avoid blocking the UI
+            threading.Thread(target=self.perform_download, args=(ip, full_path), daemon=True).start()
+
+    def perform_download(self, ip, full_path):
+        try:
+            client = TftpClient(ip, 69)
+
+            # Get total file size
+            self.total_size = client.get_file_size(os.path.basename(full_path))
+            if self.total_size <= 0:
+                self.status_label.setText("Error: Invalid file size.")
+                self.log_signal.emit("Error: Invalid file size.")
+                return
+
+            # Function to update progress
+            def update_progress(packet):
+                if isinstance(packet, TftpPacketERR):
+                    self.log_signal.emit(f"Error: {packet.errmsg.decode()}")
+                    return
+                
+                # Check for DAT packets (data packets)
+                if isinstance(packet, TftpPacketDAT):
+                    self.downloaded_size += len(packet.data)
+                    self.log_signal.emit(f"Downloaded: {self.downloaded_size} bytes")
+
+            # Start downloading with the update_progress callback
+            client.download(os.path.basename(full_path), output=full_path, packethook=update_progress)
+
+            self.status_label.setText("Status: Download Complete")
+            self.log_signal.emit("Download complete.")
+        except Exception as e:
+            self.status_label.setText(f"Error: {str(e)}")
+            self.log_signal.emit(f"Error: {str(e)}")
+
+    def upload_file(self):
+        ip = self.ip_input.text()  # Get the manually entered IP address
+        filename = self.upload_file_input.text()
+        self.status_label.setText("Status: Uploading...")
+        self.log_output.clear()  # Clear previous logs
+
+        # Start a new thread for uploading to avoid blocking the UI
+        threading.Thread(target=self.perform_upload, args=(ip, filename), daemon=True).start()
+
+    def perform_upload(self, ip, filename):
+        try:
+            client = TftpClient(ip, 69)
+
+            # Get total file size
+            self.total_size = os.path.getsize(filename)
+            self.downloaded_size = 0  # Reset downloaded size
+
+            # Function to update progress
+            def update_progress(packet):
+                if isinstance(packet, TftpPacketERR):
+                    self.log_signal.emit(f"Error: {packet.errmsg.decode()}")
+                    return
+                
+                # Check for DAT packets (data packets)
+                if isinstance(packet, TftpPacketDAT):
+                    self.downloaded_size += len(packet.data)
+                    self.log_signal.emit(f"Uploaded: {self.downloaded_size} bytes")
+
+            # Start uploading with the update_progress callback
+            with open(filename, 'rb') as f:
+                client.upload(os.path.basename(filename), input=f, packethook=update_progress)
+
+            self.status_label.setText("Status: Upload Complete")
+            self.log_signal.emit("Upload complete.")
+        except Exception as e:
+            self.status_label.setText(f"Error: {str(e)}")
+            self.log_signal.emit(f"Error: {str(e)}")
+
+    def update_log(self, message):
+        self.log_output.append(message)
+        self.log_output.moveCursor(QtGui.QTextCursor.End)  # Scroll to the bottom
+
+
+if __name__ == "__main__":
+    app = QtWidgets.QApplication(sys.argv)
+    client = TFTPClient()
+    client.setWindowTitle("TFTP Client by petrunetworking")
+    client.setGeometry(100, 100, 500, 400)
+    client.setStyleSheet("background-color: #eaeaea; font-family: Arial;")
+    client.show()
+    sys.exit(app.exec_())