Add imageName field to request a specific name to save to

Also added uWSGI installation tutorial

.github/README.md

@@ -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.

README.md

@@ -1,26 +1,87 @@
 # 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`
-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
+---
+
+## 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
 
-## 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
+Note: replace `www-data` with whatever user your webserver runs as.
+
+1. Make /srv/imgupload: `sudo mkdir /srv/imgupload`
+2. Change ownership of /srv/imgupload: `sudo chown www-data:www-data /srv/imgupload`
+3. Enter www-data user: `sudo su www-data`
+4. Change directories to /srv/imgupload: `cd /srv/imgupload`
+5. Clone the repository: `git clone https://git.bbaovanc.com/bbaovanc/imgupload.git`
+6. Enter the imgupload directory: `cd imgupload`
+7. Create a virtualenv: `python3 -m venv env`
+8. Enter the virtualenv: `source env/bin/activate`
+9. Install dependencies: `python3 -m pip install -r requirements.txt`
+10. Leave the www-data user: `exit`
+11. Copy the default uWSGI configuration: `sudo cp /srv/imgupload/uwsgi.ini.default /etc/uwsgi/apps-available/imgupload.ini`
+12. Modify `/etc/uwsgi/apps-available/imgupload.ini` to your preferences
+13. Enable imgupload: `sudo ln -s /etc/uwsgi/apps-available/imgupload.ini /etc/uwsgi/apps-enabled/`
+14. Restart uWSGI: `sudo systemctl restart uwsgi`
+15. Set up your webserver to proxy the uwsgi.sock
+
+Example NGINX location block:
+```nginx
+location /upload {
+    include uwsgi_params;
+    uwsgi_pass unix:/srv/imgupload/uwsgi.sock;
+    client_max_body_size 25M;
+}
+```
 
 ### Using Flask development server
+
+
+#### Setup
+
+```shell
+$ git clone https://git.bbaovanc.com/bbaovanc/imgupload.git
+$ cd imgupload
+$ python3 -m venv env
+$ source env/bin/activate
+$ pip3 install -r requirements.txt
+```
+
+#### Run
+
 ```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)

configtest.py

@@ -4,6 +4,7 @@ configtest.py
 
 Tests the validity of your configuration in settings.py.
 """
+
 import os
 import settings as settings
 
@@ -84,8 +85,6 @@ if "ROOTURL" in checksettings:
         pass
     else:
         rooturl_good = False
-        print(settings.ROOTURL)
-        print(settings.ROOTURL.startswith("https://"))
         print("[!] ROOTURL does not start with `http://` or `https://`! This may cause issues!")
     if not settings.ROOTURL.endswith("/"):
         rooturl_good = False

functions.py.default

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

imgupload.py

@@ -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:
@@ -61,12 +67,27 @@ def upload():
 
                 fext = Path(f.filename).suffix  # get the uploaded extension
                 if allowed_extension(fext):  # if the extension is allowed
+                    if not "imageName" in request.form.keys():
                         print("Generating file with extension {0}".format(fext))
                         fname = functions.generate_name() + fext  # generate file name
                         print("Generated name: {0}".format(fname))
+                    else:
+                        fname = request.form["imageName"]
+                        if len(fname) > 0:
+                            print("Request imageName: {0}".format(fname))
+                            if not fname.lower().endswith(fext.lower()):  # if requested name doesn't have the correct extension
+                                fname += fext  # add the extension
+                                print("Added extension; new filename: {0}".format(fname))
+                        else:
+                            print("Requested filename is blank!")
+                            fname = functions.generate_name() + fext  # generate a valid filename
+                            print("Generated name: {0}".format(fname))
 
                     if f:  # if the uploaded image exists
                         print("Uploaded image exists")
+                        if Path(os.path.join(settings.UPLOAD_FOLDER, fname)).is_file():
+                            print("Requested filename already exists!")
+                            return jsonify({'status': 'error', 'error': 'FILENAME_TAKEN'}), status.HTTP_409_CONFLICT
                         f.save(os.path.join(settings.UPLOAD_FOLDER, fname))  # save the image
                         print("Saved to {0}".format(fname))
                         url = settings.ROOTURL + fname  # construct the url to the image
@@ -81,21 +102,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!")

keyctl.py

@@ -8,38 +8,43 @@ Command-line utility for easy management of the uploadkeys file.
 from pathlib import Path
 import argparse
 import logging
-import random
+import secrets
 import string
 
 
+def read_keyfile():
+    with open("uploadkeys", "r") as keyfile:  # open uploadkeys
+        keys = keyfile.readlines()  # read all the keys
+        logging.debug("Read uploadkeys")
+    keys = [x.strip("\n") for x in keys]  # strip newlines from keys
+    logging.debug("Stripped newlines from keys")
+    return keys
+
+
 def genkey(length):
-    key = ''.join(random.choice(string.ascii_letters + string.digits) for x in range(length))
+    key = ''.join(secrets.choice(string.ascii_letters + string.digits) for x in range(length))
     return key
 
 
 def savekey(key):
-    if not Path("uploadkeys").is_file():
+    if not Path("uploadkeys").is_file():  # if uploadkeys doesn't exist, log an info message
         logging.info("uploadkeys file doesn't exist, it will be created.")
     with open("uploadkeys", "a+") as keyfile:
-        keyfile.write(str(key) + "\n")
+        keyfile.write(str(key) + "\n")  # add the key
     logging.debug("Saved a key to uploadkeys: {0}".format(key))
 
 
 def rmkey(delkey):
     removedkey = False
-    with open("uploadkeys", "r") as keyfile:
-        allkeys = keyfile.readlines()
-        logging.debug("Loaded all upload keys")
-    allkeys = [x.strip("\n") for x in allkeys]
-    logging.debug("Stripped keys")
-    if delkey in allkeys:
-        allkeys.remove(delkey)
+    allkeys = read_keyfile()
+    if delkey in allkeys:  # if the key to remove exists
+        allkeys.remove(delkey)  # remove the first instance of the key
         removedkey = True
         logging.debug("Removed one instance of the key")
 
     with open("uploadkeys", "w") as keyfile:
         for k in allkeys:
-            keyfile.write(k + "\n")
+            keyfile.write(k + "\n")  # write the remaining keys
 
     if removedkey:
         return True
@@ -48,11 +53,8 @@ def rmkey(delkey):
 
 
 def find_duplicates():
-    with open("uploadkeys", "r") as keyfile:
-        allkeys = keyfile.readlines()
-        logging.debug("Read all keys")
-    allkeys = [x.strip("\n") for x in allkeys]
-    logging.debug("Stripped newlines")
+    allkeys = read_keyfile()
+
     seen = set()
     ukeys = []
     dupkeys = []
@@ -66,11 +68,7 @@ def find_duplicates():
 
 
 def get_keys():
-    with open("uploadkeys", "r") as keyfile:  # load valid keys
-        validkeys = keyfile.readlines()
-    logging.debug("Read uploadkeys")
-    validkeys = [x.strip("\n") for x in validkeys]
-    logging.debug("Stripped newlines from validkeys")
+    validkeys = read_keyfile()
     while "" in validkeys:
         validkeys.remove("")
     logging.debug("Removed blank keys")
@@ -85,7 +83,7 @@ def cmd_list(args):
     for i in range(len(validkeys)):
         showkey = validkeys[i][:6]
         if len(validkeys[i]) > 6:
-            showkey += "..."
+            showkey += "..."  # add ellipses since the key was shortened in list
 
         print("    [{0}] {1}".format(i+1, showkey))
 
@@ -121,7 +119,9 @@ def cmd_remove(args):
         logging.info("No key was removed.")
 
 def cmd_dedupe(args):
-    for d in find_duplicates():
+    dupes = find_duplicates()
+    if len(dupes) > 0:
+        for d in dupes:
             r = rmkey(d)
             logging.debug(r)
             logging.info("Removed duplicate key: {0}".format(d))

uwsgi.ini.default

@@ -0,0 +1,12 @@
+[uwsgi]
+socket = /srv/imgupload/uwsgi.sock
+chmod-socket = 755
+chdir = /srv/imgupload
+venv = /srv/imgupload/env
+master = true
+module = imgupload:app
+processes = 10
+threads = 1
+uid = www-data
+gid = www-data
+plugins = python3,logfile