Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dexter-xd/tcp_server_c
TCP server in C with dynamic HTML templating.
https://github.com/dexter-xd/tcp_server_c
c dynamic-html tcp-server
Last synced: about 7 hours ago
JSON representation
TCP server in C with dynamic HTML templating.
- Host: GitHub
- URL: https://github.com/dexter-xd/tcp_server_c
- Owner: dexter-xD
- License: mit
- Created: 2024-10-31T18:53:15.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-05T18:59:39.000Z (1 day ago)
- Last Synced: 2025-02-05T19:59:42.142Z (1 day ago)
- Topics: c, dynamic-html, tcp-server
- Language: C
- Homepage:
- Size: 29.3 KB
- Stars: 118
- Watchers: 3
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# TCP Server Project
This project is a simple TCP server written in C, using socket programming concepts. It listens on a specified port, accepts client connections, and serves dynamic HTML content based on incoming requests using a templating system that supports dynamic values, if-else conditions, and loops. The code is organized into multiple files with CMake as the build system.
## Project Structure
```
project/
├── CMakeLists.txt # Build configuration
├── include/
│ ├── server.h # Main server header file
│ ├── html_serve.h # Header for serve_html function
│ ├── request_handler.h # Header for handle_client function
│ ├── template.h # Header for template processing functions
│ └── socket_utils.h # Header for socket utility functions
├── src/
│ ├── server.c # Main server program
│ ├── html_serve.c # serve_html function
│ ├── request_handler.c # handle_client function
│ ├── template.c # Template processing functions
│ └── socket_utils.c # Utility functions for socket operations
└── README.md # Project documentation
```
### Files
- **`server.c`**: Contains the main server loop, which listens for and accepts client connections.
- **`html_serve.c`**: Handles HTML file reading and serves HTML content to clients. Contains the `serve_html` function.
- **`request_handler.c`**: Manages client requests by processing incoming HTTP requests and serving appropriate responses. Contains the `handle_client` function.
- **`template.c`**: Implements template processing functions to support dynamic values, if-else conditions, and loops in HTML content.
- **`socket_utils.c`**: Includes utility functions for socket initialization and client data handling. Contains the `initialize_server` and `read_client_data` functions.
- **`server.h`**: Declares main server-related constants and functions.
- **`html_serve.h`**: Declares the function used to read and serve HTML files.
- **`request_handler.h`**: Declares the function to handle client requests.
- **`template.h`**: Declares functions for processing templates with dynamic content.
- **`socket_utils.h`**: Declares utility functions for initializing sockets and reading client data.
## Prerequisites
- **CMake** (version 3.10 or higher)
- **GCC** or another compatible C compiler
- **Linux** or **WSL** (Windows Subsystem for Linux) recommended for running this server
## Setup Instructions
### 1. Clone the Repository
```bash
git clone
cd project
```
### 2. Build the Project
1. Create a `build` directory and navigate into it:
```bash
mkdir build && cd build
```
2. Generate the makefiles with CMake:
```bash
cmake ..
```
3. Compile the project using `make`:
```bash
make
```
This will create an executable file named `server` inside a `bin` directory under the `build` folder.
### 3. Run the Server
After building, you can start the server as follows:
```bash
valgrind --leak-check=full ./bin/server
```
The server will listen on port `8080` (default setting) and process incoming client requests.
## Template Features
The server supports a templating system that allows for dynamic content in HTML files. The following features are implemented:
### 1. Dynamic Values
You can replace placeholders in the template with dynamic values. Placeholders are defined as `{{key}}`, where `key` corresponds to the variable you want to insert.
### 2. If-Else Conditions
The server can handle if-else statements within templates. Use the following syntax:
```
{% if condition %}
Content to show if condition is true
{% else %}
Content to show if condition is false
{% endif %}
```
### 3. For Loops
You can create loops to iterate over a list of items in your templates using the following syntax:
```
{% for item in items %}
Content to repeat for each item
{% endfor %}
```
## Example Usage
### HTML Template
Create an HTML file (e.g., `index.html`) with the following content to test the features:
```html
Dynamic Template Example
Welcome to the Template Server
{{ greeting }}
{% if is_logged_in %}
Hello, {{ username }}!
{% else %}
Please log in to access more features.
{% endif %}
Your Items:
- {{ item }}
{% for item in items %}
{% endfor %}
```
### Sending a Request
To send a request to the server, you can use a web browser or a tool like `curl`. Make sure to specify the correct HTML file to serve based on your request.
## Troubleshooting
If you encounter errors:
1. Ensure that no other process is using port `8080`.
2. Verify that CMake and GCC are correctly installed.
3. Use the command `netstat -tuln | grep 8080` to check if the port is occupied.
## Acknowledgments
- [CMake](https://cmake.org/) - Cross-platform build system
- [Beej's Guide to Network Programming](https://beej.us/guide/bgnet/) - A great resource for learning socket programming
---
Feel free to reach out for any questions or improvements!