9 Commits

Author SHA1 Message Date
ba68674e4e Add GitHub-specific README.md which links Gitea 2020-09-07 20:31:24 -05:00
99ff2c68a3 Change references of gitea.bbaovanc.com to git.bbaovanc.com 2020-09-07 02:07:36 -05:00
dd069bf395 Add newline after block comments at beginning 2020-09-06 15:24:20 -05:00
f21adfa04e Added FAQ and links to sections in README.md 2020-09-06 12:43:44 -05:00
3d5c55498f Clean up and add LICENSE section to README.md 2020-09-06 11:26:13 -05:00
5e2be10434 Change references of GitHub to gitea.bbaovanc.com 2020-09-06 11:09:06 -05:00
7c1f449bce Add "verify" field to request to not save image
This makes it easy for the user to debug authentication.
2020-09-05 18:55:56 -05:00
0dbcc0e380 Change file extension check to be case-insensitive 2020-09-05 16:21:50 -05:00
b8b5a2518c Change abort() calls to JSON responses
This makes the responses more consistent. Now, all responses are JSON.
2020-09-05 15:43:36 -05:00
5 changed files with 62 additions and 15 deletions

7
.github/README.md vendored Normal file
View File

@ -0,0 +1,7 @@
# imgupload
## Moving from GitHub to Gitea
**TL;DR: Please go to my Gitea instance instead of GitHub for anything related to imgupload. [https://git.bbaovanc.com/bbaovanc/imgupload](https://git.bbaovanc.com/bbaovanc/imgupload)**
This repository might not exist on GitHub in the future! Releases will not be released here in the future. Instead, they will be released on the repository on my Gitea instance, which you can find [here](https://git.bbaovanc.com/bbaovanc/imgupload). Issues and pull requests should also be created on Gitea. For now, commits will still be pushed to this repository, but that may change in the future.

View File

@ -1,26 +1,63 @@
# imgupload
![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/BBaoVanC/imgupload/master?color=purple) ![GitHub repo size](https://img.shields.io/github/repo-size/bbaovanc/imgupload?color=purple) ![GitHub All Releases](https://img.shields.io/github/downloads/bbaovanc/imgupload/total?color=purple) ![GitHub issues](https://img.shields.io/github/issues/bbaovanc/imgupload?color=purple) ![GitHub closed issues](https://img.shields.io/github/issues-closed/bbaovanc/imgupload?color=purple) ![GitHub](https://img.shields.io/github/license/bbaovanc/imgupload?color=purple)
### What is imgupload?
<!---![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/BBaoVanC/imgupload/master?color=purple)
![GitHub repo size](https://img.shields.io/github/repo-size/bbaovanc/imgupload?color=purple)
![GitHub All Releases](https://img.shields.io/github/downloads/bbaovanc/imgupload/total?color=purple)
![GitHub issues](https://img.shields.io/github/issues/bbaovanc/imgupload?color=purple)
![GitHub closed issues](https://img.shields.io/github/issues-closed/bbaovanc/imgupload?color=purple)
![GitHub](https://img.shields.io/github/license/bbaovanc/imgupload?color=purple)-->
## What is imgupload?
imgupload is a Flask + uWSGI application to serve as an all-purpose image/file uploader over POST requests.
### Installation
1. Clone the repository: `git clone https://github.com/BBaoVanC/imgupload.git`
---
## FAQ
**Where can I send bug reports and feature requests?**
You can create an issue [here](https://git.bbaovanc.com/bbaovanc/imgupload/issues).
**How do I use this program?**
See [Installation](#installation)
**I want to make a pull request. Where should I do that?**
First, fork [this repository](https://git.bbaovanc.com/bbaovanc/imgupload). If you don't have an account on my Gitea site yet, you can either create one, or sign in using your GitHub account. Commit your changes to your fork, and then create a pull request.
---
## Installation
1. Clone the repository: `git clone https://git.bbaovanc.com/bbaovanc/imgupload.git`
2. Enter the imgupload directory: `cd imgupload`
3. Create a virtualenv: `python3 -m venv env`
4. Enter the virtualenv: `source env/bin/activate`
5. Install dependencies: `python3 -m pip install -r requirements.txt`
6. Run the Flask app
6. [Run the Flask app](#running-the-flask-app)
---
## Running the Flask app
### Using uWSGI
[https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html](https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html)
Instructions specific to imgupload are coming soon
### Using Flask development server
```shell
$ source env/bin/activate # if you haven't already entered the virtualenv
$ export FLASK_APP=imgupload.py
$ flask run
```
---
## License
_imgupload_ is licensed under the GPLv3 license. For more information, please refer to [`LICENSE`](https://git.bbaovanc.com/bbaovanc/imgupload/src/branch/master/LICENSE)

View File

@ -4,6 +4,7 @@ configtest.py
Tests the validity of your configuration in settings.py.
"""
import os
import settings as settings

View File

@ -4,6 +4,7 @@ functions.py
Functions used by imgupload which can be easily customized.
"""
import string
import random

View File

@ -4,7 +4,8 @@ imgupload.py
Flask application for processing images uploaded through POST requests.
"""
from flask import Flask, request, jsonify, abort, Response
from flask import Flask, request, jsonify, Response
from flask_api import status
from pathlib import Path
import os
@ -17,7 +18,7 @@ app = Flask(__name__) # app is the app
def allowed_extension(testext):
if testext in settings.ALLOWED_EXTENSIONS:
if testext.lower() in settings.ALLOWED_EXTENSIONS:
return True
else:
return False
@ -49,6 +50,11 @@ def upload():
if request.form["uploadKey"] in validkeys: # check if uploadKey is valid
print("Key is valid!")
if "verify" in request.form.keys():
if request.form["verify"] == "true":
print("Request is asking if key is valid (it is)")
return jsonify({'status': 'key_valid'})
if "imageUpload" in request.files: # check if image to upload was provided
f = request.files["imageUpload"] # f is the image to upload
else:
@ -81,21 +87,16 @@ def upload():
else: # if the extension was invalid
print("Uploaded extension is invalid!")
abort(415)
return jsonify({'status': 'error', 'error': 'INVALID_EXTENSION'}), status.HTTP_415_UNSUPPORTED_MEDIA_TYPE
else: # if the key was not valid
print("Key is invalid!")
print("Request key: {0}".format(request.form["uploadKey"]))
abort(401)
return jsonify({'status': 'error', 'error': 'UNAUTHORIZED'}), status.HTTP_401_UNAUTHORIZED
else: # if uploadKey was not found in request body
print("No uploadKey found in request!")
abort(401)
else: # if the request method wasn't post
print("Request method was not POST!")
abort(405)
return jsonify({'status': 'error', 'error': 'UNAUTHORIZED'}), status.HTTP_401_UNAUTHORIZED
if __name__ == "__main__":
print("Run with `flask` or a WSGI server!")