mirror of
https://github.com/Kizuren/uLinkShortener.git
synced 2025-12-21 21:16:17 +01:00
Merge pull request #6
- Removed python files - Clarified readme - Added MIT license
This commit is contained in:
MarcUs7i
GitHub
commit
38788eed26
6 changed files with 34 additions and 243 deletions
2
.github/workflows/build.yml
vendored
2
.github/workflows/build.yml
vendored
|
|
@ -6,6 +6,8 @@ on:
|
|||
branches: [main]
|
||||
pull_request:
|
||||
branches: [main]
|
||||
release:
|
||||
types: [created]
|
||||
|
||||
|
||||
jobs:
|
||||
|
|
|
|||
35
.github/workflows/release.yml
vendored
35
.github/workflows/release.yml
vendored
|
|
@ -1,35 +0,0 @@
|
|||
name: Build on Release
|
||||
|
||||
on:
|
||||
release:
|
||||
types: [created]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
packages: write
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Login to GitHub Container Registry
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Build and push Docker image
|
||||
uses: docker/build-push-action@v6
|
||||
with:
|
||||
context: .
|
||||
push: true
|
||||
platforms: linux/amd64, linux/arm64/v8, linux/arm/v7
|
||||
tags: ghcr.io/marcus7i/ulinkshortener:latest
|
||||
7
LICENSE
Normal file
7
LICENSE
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
Copyright 2025 MarcUs7i
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
46
README.md
46
README.md
|
|
@ -1,36 +1,43 @@
|
|||
# uLinkShortener
|
||||
|
||||
This project is the code behind [u.marcus7i.net](https://u.marcus7i.net), a custom URL shortener. It uses Flask, MongoDB, and Docker for quick deployment.
|
||||
This project is the code behind [u.marcus7i.net](https://u.marcus7i.net), a custom URL shortener. It uses Go, MongoDB, and Docker for quick deployment.
|
||||
|
||||
## Prerequisites
|
||||
- Python
|
||||
- Go
|
||||
- MongoDB database (local or remote)
|
||||
- Docker & Docker Compose (optional, for containerized deployments)
|
||||
|
||||
## Setup
|
||||
1. Clone the repository
|
||||
2. Create a virtual environment (optional):
|
||||
```
|
||||
python -m venv env
|
||||
source env/bin/activate # Linux/Mac
|
||||
env\Scripts\activate # Windows
|
||||
```
|
||||
3. Install dependencies:
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
4. Define environment variables in the `.env` file:
|
||||
```
|
||||
MONGO_URI=mongodb://<username>:<password>@<host>:<port>/<database>
|
||||
PORT=<desired_port>
|
||||
```
|
||||
|
||||
## Running Locally
|
||||
1. Start MongoDB
|
||||
2. Run:
|
||||
|
||||
### Without Docker
|
||||
|
||||
1. Install dependencies:
|
||||
```
|
||||
python server.py
|
||||
go mod download
|
||||
```
|
||||
2. Build and run:
|
||||
```
|
||||
go run cmd/api/main.go
|
||||
```
|
||||
|
||||
### With Docker
|
||||
|
||||
1. Build and run with docker compose:
|
||||
```
|
||||
docker-compose -f docker-compose-build.yml up --build
|
||||
```
|
||||
2. Use of pre-built image:
|
||||
```
|
||||
docker compose up -d
|
||||
```
|
||||
3. Access the app at http://localhost:5000
|
||||
|
||||
## Docker Deployment
|
||||
1. Build and run containers:
|
||||
|
|
@ -39,9 +46,6 @@ This project is the code behind [u.marcus7i.net](https://u.marcus7i.net), a cust
|
|||
```
|
||||
2. The application will be available at http://localhost:5000
|
||||
|
||||
## Using GHCR
|
||||
## License
|
||||
|
||||
Pull the prebuilt image:
|
||||
```bash
|
||||
docker pull ghcr.io/MarcUs7i/ulinkshortener:latest
|
||||
```
|
||||
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
flask
|
||||
flask-pymongo
|
||||
python-dotenv
|
||||
requests
|
||||
183
server.py
183
server.py
|
|
@ -1,183 +0,0 @@
|
|||
from flask import Flask, request, redirect, render_template, jsonify, make_response
|
||||
from flask_pymongo import PyMongo
|
||||
from datetime import datetime
|
||||
import random
|
||||
import string
|
||||
import os
|
||||
from dotenv import load_dotenv
|
||||
import json
|
||||
from urllib.parse import quote_plus, urlparse
|
||||
|
||||
load_dotenv()
|
||||
|
||||
app = Flask(__name__, template_folder='template', static_folder='static', static_url_path='/static')
|
||||
app.config["MONGO_URI"] = os.getenv("MONGO_URI")
|
||||
mongo = PyMongo(app)
|
||||
|
||||
def generate_short_id():
|
||||
return ''.join(random.choices(string.ascii_letters + string.digits, k=8))
|
||||
|
||||
def get_client_info():
|
||||
user_agent = request.user_agent
|
||||
ip_address = (request.headers.get('CF-Connecting-IP') or
|
||||
request.headers.get('X-Real-IP') or
|
||||
request.headers.get('X-Forwarded-For', '').split(',')[0].strip() or
|
||||
request.remote_addr or
|
||||
'Unknown')
|
||||
|
||||
return {
|
||||
'ip': ip_address,
|
||||
'user_agent': user_agent.string,
|
||||
'platform': request.headers.get('sec-ch-ua-platform', user_agent.platform or 'Unknown'),
|
||||
'browser': user_agent.browser or 'Unknown',
|
||||
'version': user_agent.version or '',
|
||||
'language': request.accept_languages.best or 'Unknown',
|
||||
'referrer': request.referrer or 'Direct',
|
||||
'timestamp': datetime.now(),
|
||||
'remote_port': request.environ.get('REMOTE_PORT', 'Unknown'),
|
||||
'accept': request.headers.get('Accept', 'Unknown'),
|
||||
'accept_language': request.headers.get('Accept-Language', 'Unknown'),
|
||||
'accept_encoding': request.headers.get('Accept-Encoding', 'Unknown'),
|
||||
'screen_size': request.headers.get('Sec-CH-UA-Platform-Screen', 'Unknown'),
|
||||
'window_size': request.headers.get('Viewport-Width', 'Unknown'),
|
||||
'country': request.headers.get('CF-IPCountry', 'Unknown'), # If using Cloudflare
|
||||
'isp': request.headers.get('X-ISP', 'Unknown'), # Requires additional middleware
|
||||
'ip_version': 'IPv6' if ':' in ip_address else 'IPv4'
|
||||
}
|
||||
|
||||
def is_valid_url(url):
|
||||
if not url or url.isspace():
|
||||
return False
|
||||
try:
|
||||
result = urlparse(url)
|
||||
return all([result.scheme, result.netloc])
|
||||
except:
|
||||
return False
|
||||
|
||||
@app.route('/')
|
||||
def home():
|
||||
account_id = request.cookies.get('account_id')
|
||||
|
||||
stats = {
|
||||
'total_links': mongo.db.links.count_documents({}),
|
||||
'total_clicks': mongo.db.analytics.count_documents({}),
|
||||
'chart_data': {
|
||||
'ip_versions': list(mongo.db.analytics.aggregate([
|
||||
{"$group": {"_id": "$ip_version", "count": {"$sum": 1}}},
|
||||
{"$sort": {"count": -1}}
|
||||
])),
|
||||
'os_stats': list(mongo.db.analytics.aggregate([
|
||||
{"$group": {"_id": "$platform", "count": {"$sum": 1}}},
|
||||
{"$sort": {"count": -1}},
|
||||
{"$limit": 10}
|
||||
])),
|
||||
'country_stats': list(mongo.db.analytics.aggregate([
|
||||
{"$group": {"_id": "$country", "count": {"$sum": 1}}},
|
||||
{"$sort": {"count": -1}},
|
||||
{"$limit": 10}
|
||||
])),
|
||||
'isp_stats': list(mongo.db.analytics.aggregate([
|
||||
{"$group": {"_id": "$isp", "count": {"$sum": 1}}},
|
||||
{"$sort": {"count": -1}},
|
||||
{"$limit": 10}
|
||||
]))
|
||||
},
|
||||
'logged_in': bool(account_id)
|
||||
}
|
||||
return render_template('index.html', stats=stats)
|
||||
|
||||
@app.route('/register', methods=['POST'])
|
||||
def register():
|
||||
account_id = ''.join(random.choices(string.digits, k=8))
|
||||
while mongo.db.users.find_one({'account_id': account_id}):
|
||||
account_id = ''.join(random.choices(string.digits, k=8))
|
||||
|
||||
mongo.db.users.insert_one({'account_id': account_id})
|
||||
response = make_response(jsonify({'account_id': account_id}))
|
||||
response.set_cookie('account_id', account_id, max_age=31536000)
|
||||
return response
|
||||
|
||||
@app.route('/login', methods=['POST'])
|
||||
def login():
|
||||
account_id = request.json.get('account_id')
|
||||
user = mongo.db.users.find_one({'account_id': account_id})
|
||||
if user:
|
||||
response = make_response(jsonify({'success': True}))
|
||||
response.set_cookie('account_id', account_id, max_age=31536000)
|
||||
return response
|
||||
return jsonify({'success': False}), 401
|
||||
|
||||
@app.route('/logout', methods=['POST'])
|
||||
def logout():
|
||||
response = make_response(jsonify({'success': True}))
|
||||
response.delete_cookie('account_id')
|
||||
return response
|
||||
|
||||
@app.route('/create', methods=['POST'])
|
||||
def create_link():
|
||||
account_id = request.json.get('account_id')
|
||||
target_url = request.json.get('url')
|
||||
|
||||
if not mongo.db.users.find_one({'account_id': account_id}):
|
||||
return jsonify({'error': 'Invalid account'}), 401
|
||||
|
||||
if not is_valid_url(target_url):
|
||||
return jsonify({'error': 'Invalid URL. Please provide a valid URL with scheme (e.g., http:// or https://)'}), 400
|
||||
|
||||
short_id = generate_short_id()
|
||||
mongo.db.links.insert_one({
|
||||
'short_id': short_id,
|
||||
'target_url': target_url,
|
||||
'account_id': account_id,
|
||||
'created_at': datetime.now()
|
||||
})
|
||||
|
||||
return jsonify({'short_url': f'/l/{short_id}'})
|
||||
|
||||
@app.route('/l/<short_id>')
|
||||
def redirect_link(short_id):
|
||||
link = mongo.db.links.find_one({'short_id': short_id})
|
||||
if not link:
|
||||
return 'Link not found', 404
|
||||
|
||||
client_info = get_client_info()
|
||||
mongo.db.analytics.insert_one({
|
||||
'link_id': short_id,
|
||||
'account_id': link['account_id'],
|
||||
**client_info
|
||||
})
|
||||
|
||||
return redirect(link['target_url'])
|
||||
|
||||
@app.route('/analytics/<account_id>')
|
||||
def get_analytics(account_id):
|
||||
if not mongo.db.users.find_one({'account_id': account_id}):
|
||||
return jsonify({'error': 'Invalid account'}), 401
|
||||
|
||||
links = list(mongo.db.links.find({'account_id': account_id}, {'_id': 0}))
|
||||
analytics = list(mongo.db.analytics.find({'account_id': account_id}, {'_id': 0}))
|
||||
|
||||
return jsonify({
|
||||
'links': links,
|
||||
'analytics': analytics
|
||||
})
|
||||
|
||||
@app.route('/delete/<short_id>', methods=['DELETE'])
|
||||
def delete_link(short_id):
|
||||
account_id = request.cookies.get('account_id')
|
||||
if not account_id:
|
||||
return jsonify({'error': 'Not logged in'}), 401
|
||||
|
||||
link = mongo.db.links.find_one({'short_id': short_id, 'account_id': account_id})
|
||||
if not link:
|
||||
return jsonify({'error': 'Link not found or unauthorized'}), 404
|
||||
|
||||
# Delete the link and its analytics
|
||||
mongo.db.links.delete_one({'short_id': short_id})
|
||||
mongo.db.analytics.delete_many({'link_id': short_id})
|
||||
|
||||
return jsonify({'success': True})
|
||||
|
||||
if __name__ == '__main__':
|
||||
port = int(os.getenv("PORT", 5000))
|
||||
app.run(debug=True, host="0.0.0.0", port=port)
|
||||
Loading…
Add table
Add a link
Reference in a new issue