DinoWebServe

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 13 Open GitHub ↗

A lightweight web server that supports running both Python and PHP simultaneously

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# <img src="pyserve.png" alt="icon" width="50" align="center"> DinoWebServe

<div align="left">
  <a href="README_ZH.md">中文</a> | <a href="README.md">English</a>
</div>
</br>

A lightweight multi-functional web server based on Flask, supporting dynamic script execution, file serving, and custom configuration.

## ✨ Features

### 🌐 Core Functions
- **Static File Serving**: HTTP service supporting various file types
- **Directory Browsing**: Configurable directory listing functionality
- **Dynamic Script Support**:
  - **Python Scripts (.pys)**: Embedded Python code execution
  - **PHP Support**: Execute PHP scripts through PHP-CGI
- **Custom Error Pages**: Support for custom HTTP error pages
- **Request Logging**: Log all HTTP requests by date
- **Automatic Log Cleanup**: Delete old logs based on retention days
- **Intelligent Route Mapping**:
  - **Virtual Extension Mapping**: Access `rss.xml` to automatically map to `rss.xml.pys`
  - **Flexible Index Files**: Supports `index.ANY_SUFFIX.pys` as a directory default page
  - **Wildcard Matching**: Supports `post.{}.pys` to match `post/abc` or `post-123.html` etc.

## 📋 System Requirements

- Python 3.8+
- Flask
- colorama
- PHP-CGI (for PHP support)

## 🚀 Quick Start

### 1. Install Dependencies

```bash
pip install flask colorama
```

### 2. Project Structure

```
DinoWebServe/
├── DinoWebServe.py      # Main program file
├── config/
│   └── config.cfg      # Configuration file
├── WWW/                # Web root directory
│   └── error/          # Error pages directory
│       ├── 404.html
│       └── ...
├── PHP/                # PHP related files
│   └── php-cgi.exe     # PHP-CGI executable
└── log/                # Log directory
```

### 3. Run the Server

```bash
python DinoWebServe.py
```

The server starts on port 80 by default. Visit http://localhost to access.

## ⚙️ Configuration

Edit the `config/config.cfg` file to customize server behavior:

```python
# Basic Configuration
Config.PORT = 80                  # Server port
Config.ENCODING = 'utf-8'         # File encoding
Config.WWW_ROOT = './WWW'         # Web root directory
Config.ERROR_DIR = '/error'       # Error pages directory
Config.DIR_LISTING = False        # Enable directory listing
Config.LOG_DIR = './log'          # Log files directory
Config.LOG_RETENTION_DAYS = None  # Log retention (None disables auto-deletion)
Config.CONFIG_DIR = "./config"    # Configuration directory

# PHP Configuration
Config.PHP_CGI_PATH = "./PHP/php-cgi"  # PHP-CGI path
```

You can also configure file type categories, MIME type mapping, and Python execution whitelist in `config.cfg`:

```python
# File type categories (extensible)
Config.HTML_EXTENSIONS = ['html', 'htm', 'pys', 'php', 'pp']

# MIME type mapping (common types are built-in; extend as needed)
Config.MIME_TYPES.update({
    'md': 'text/markdown'
})

# Python execution restrictions
DISABLE_PYTHON_FUNCTIONS = []  # Disabled functions
ENABLE_PYTHON_LIBRARIES = ['sys', 'os', 'math', 'datetime', 'time', 'json', ...]  # Allowed libraries
```

### Host Mapping & Reverse Proxy (New)

When `Config.WWW_ROOT` is a `dict`, the server routes by `Host` to different sites. If a mapped value starts with `http`, the request is forwarded to the upstream as a reverse proxy with streaming response.

- Host-based routing: `Config.WWW_ROOT[request.host]` matches a static directory or an upstream address
- Fallback rule: use key `ELSE` to specify a default site
- Upstream proxy: values starting with `http` forward requests to the upstream (no auto-follow for redirects)

Example configuration:

```python
Config.WWW_ROOT = {
    "www.example.com": "D:/sites/example",         # Static directory
    "api.example.com": "http://127.0.0.1:9000",    # Reverse proxy to upstream
    "ELSE": "D:/sites/default"                     # Fallback site
}
```

Notes:

- Ensure the upstream validates and properly handles `X-Real-IP`/`X-Forwarded-*` headers

## 🎯 Usage Examples

### Dynamic Pages Support

#### Python Scripts (.pys)

Create `WWW/index.pys` file:

```html
<!DOCTYPE html>
<html>
<body>
    <h1>Welcome to DinoWebServe</h1>
    <python>
echo("<p>Current time: " + str(datetime.datetime.now()) + "</p>")
echo("<p>Your IP address: " + remote_addr() + "</p>")
    </python>
</body>
</html>
```

#### PHP+Python Hybrid Files (.pp)

Create `WWW/index.pp` file that can contain both PHP and Python code:

```html
<!DOCTYPE html>
<html>
<body>
    <?php
        echo "<h1>PHP Generated Content</h1>";
        echo "<p>Server time: ".date('Y-m-d H:i:s')."</p>";
    ?>
    
    <python>
echo("<p>Python says: Current timestamp is " + str(time.time()) + "</p>")
    </python>
</body>
</html>
```

### Intelligent Route Mapping Examples

#### 1. Virtual Extension Mapping
If you request `/rss.xml` and `rss.xml.pys` exists in the `WWW` directory, the server will automatically execute that script and return the result.

#### 2. Wildcard Files
Create a file named `post.{}.pys` to capture various dynamic paths:
- Request `/post/123` -> matches `post.{}.pys`
- Request `/post-news.html` -> matches `post.{}.pys`
- Calling `path()` in the script returns the original request path (e.g., `/post/123`).

#### 3. Flexible Index
Supports `index.ANY_SUFFIX.pys` as a directory entry point. For example, `index.rss.pys` will be executed when accessing the directory root (if standard `index.pys` is missing).

### Available Python Functions

- Full technical reference: [FUNCTIONS.md](./FUNCTIONS.md)

## 🔒 Security Considerations

1. **Sandbox Execution**: Python code executes in a restricted environment
2. **Function Restrictions**: Disable specific functions via `DISABLE_PYTHON_FUNCTIONS`
3. **Library Control**: Only libraries specified in `ENABLE_PYTHON_LIBRARIES` are allowed
4. **File Access**: Restricted within WWW_ROOT directory

## 📝 Logging

The server creates log files by date in the `log/` directory and supports automatic cleanup of expired logs:

```
{'timestamp': '2025-01-09T10:30:45', 'ip': '127.0.0.1', 'method': 'GET', 'path': '/', ...}
```

- Set `Config.LOG_RETENTION_DAYS` to a positive integer (e.g., `7`) to automatically delete log files older than that number of days when writing logs.

## 🤝 Contributing

Welcome to submit Issues and Pull Requests!

## 📄 License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0). See [LICENSE](LICENSE) file for details.

## 👤 Author

- **zplbFelix**

## ☕ Support the Author

If this project helps you, feel free to buy the author a coffee! (WeChat Pay)

<p align="center">
  <i>Scan to donate. Your support is my motivation for continuous development!</i>
</p>

<p align="center">
  <strong>Thank you for your support!</strong> 🙏
</p>

DinoWebServe

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README