Add futur user class

.gitignore

@@ -24,6 +24,9 @@ wheels/
 .installed.cfg
 *.egg
 MANIFEST
+bin/
+share/
+pyvenv.cfg
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

README.md

@@ -3,6 +3,9 @@
 
 > Print out shit from the cloud.
 
+![Ditherd image of a Adafruit Thermal Printer](dither_it_cover.png)
+[CC-BY oomlout](https://commons.wikimedia.org/wiki/File:TPRI-01_(14335248671).jpg)
+
 ## About
 
 This project started when I got a Thermal Printer from a friend. I don't really know if you can do anything more, but I guess it's fun.
@@ -11,39 +14,57 @@ This project started when I got a Thermal Printer from a friend. I don't really
 ## Requirements
 
 To make this project work, you will need :
-- [A Thermal Printer](https://www.adafruit.com/product/597)
-- A Raspberry Pi
+- A Thermal Printer :
+    - I used Adafruit's thermal printer at first, but it broke down. You can get it [here](https://www.adafruit.com/product/597).
+    - I then used a EPSON TM-T2OIII. It's expensive, but it's also high quality, and has better CUPS and specific library support.
+- A Raspberry Pi or any computer with USB or Serial.
 - Some electric wires.
-- Some knowledge of the command line
-- 3h of your time
+- Some knowledge of the command line,
+- Some knowledge of Python.
+- 3h of your time, 5h if things need debugging.
+- `git`, `virtualenv`,`pip` and `python` >= 3.8.6.
 
 ## Installation
 
-Start by following the guide [here](https://learn.adafruit.com/networked-thermal-printer-using-cups-and-raspberry-pi) to install the CUPS software needed to print images. If you want, you can install it via the command line, [following this guide](https://help.ubuntu.com/lts/serverguide/cups.html).
+For the EPSON TM-T20III, you can get the CUPS driver from [here](https://download.epson-biz.com/modules/pos/index.php?page=soft&scat=32). It's not specific to the printer I've been using, so you can try with other printers.
+
+With that, you can try out your printer and print normal text, images or pdf documents for example. LittlePrynter itself does not require any other software than the ones installed with it, i.e the ones listed in the `requirements.txt` file.
+
+
+
+For the Adafruit printer, start by following the guide [here](https://learn.adafruit.com/networked-thermal-printer-using-cups-and-raspberry-pi) to install the CUPS software needed to print images. If you want, you can install it via the command line, [following this guide](https://help.ubuntu.com/lts/serverguide/cups.html).
 
 You can also get some information from [here](https://learn.adafruit.com/mini-thermal-receipt-printer) and [here](https://learn.adafruit.com/instant-camera-using-raspberry-pi-and-thermal-printer) if you're stuck.
 
 Then, setup the project :
 ```
 git clone https://git.n07070.xyz/n07070/LittlePrynter
+virtualenv LittlePrynter
 cd LittlePrynter
+source bin/activate
 pip install -r requirements.txt
 ```
-Now, edit `the users.json` and add a user. **Don't forget to remove the test user.**
+
+> tip : when you're done, you can get out of the virtualenv either by closing your terminal, or by running `deactivate`.
+
+You should see a folder named `configuration`. Enter it, and duplicate the file named `config.toml.sample`, and rename the copy to `config.toml`. Now, edit this file by following the comments in the file itself.
 
 You can now start the web server with
 
 ```
-export FLASK_APP=littleprynter.py
+export FLASK_APP=main.py
 flask run
 ```
 
+This command should start a web server with which you can test your configuration. If you plan on exposing your printer to the Internet, and give it an IP / URL, _please, please, please_, don't run it this way. Look at Flask's documentation and read about running a production server. It's a little more work, but it will prevent your computer/server being hacked in too easily.  
+
 Voilà !
 
 ## More
+
 If you liked this project, feel free to support my work !
 
-[https://n07070.xyz/post/about-me/about-me/](Donations welcome :-])
+[Donations welcome ! :)](https://n07070.xyz/about-me)
 
 ## Links
 
@@ -51,7 +72,6 @@ If you liked this project, feel free to support my work !
 - [Github repo with CUPS drivers for the Adafruit Thermal Printer ( zj-58 )](https://github.com/klirichek/zj-58)
 - [A link to buy one in Europe](https://rlx.sk/sk/various-boards/1829-mini-thermal-receipt-printer-adafruit-597.html)
 - [Another link to buy one, direct from factory](https://www.cashinotech.com/csn-a2-58mm-mini-panel-thermal-receipt-printer_p11.html)
--
 
 
 ## Licence

configuration/config.toml

@@ -0,0 +1,14 @@
+# Configuration file the LittlePrynter
+
+# Printer settings
+[printer]
+vendor_id = 0x04b8
+device_id = 0x0e28
+
+# Users = Password
+[users]
+admin = "admin"
+
+# Secrets for flask
+[secrets]
+flask_secret_key = "ChÕÓhÑLa)Ù<î=F;ÑÊÝ5fV÷}º35+FâXg£Ì;Ñ58ëȤ^ìãtzº<$úÌ¢ü>A¡ÿ:--_Uc²æmÇ)ëÛòöéZ¥÷Z¯¦`,ç¶B°>Å:Zÿ¼Á@ªu-º´¬XäwYÃ`c>YÜYÏJ${_f{MJ[ÙkNzg_WZv"

configuration/config.toml.sample

@@ -0,0 +1,15 @@
+# Configuration file the LittlePrynter
+
+# Printer settings
+[printer]
+vendor_id = "0x04b8"
+device_id = "0x0e28"
+
+# Users = Password
+[users]
+admin = "admin"
+
+# Secrets for flask
+# See "How to generate good secret keys" in https://flask.palletsprojects.com/en/1.1.x/quickstart/
+[secrets]
+flask_secret_key = "random string to do things"

requirements.txt

@@ -1,13 +1,13 @@
-Adafruit-Thermal==1.1.0
-Click==7.0
-Flask==1.0.2
-Flask-Limiter==1.0.1
-itsdangerous==0.24
-Jinja2==2.10
-limits==1.3
-MarkupSafe==1.0
-Pillow==5.3.0
-pyserial==3.4
-six==1.11.0
-Unidecode==1.0.22
-Werkzeug==0.14.1
+Adafruit-Thermal>=1.1.0
+Click>=7.0
+Flask>=1.0.2
+Flask-Limiter>=1.0.1
+itsdangerous>=0.24
+Jinja2>=2.10
+limits>=1.3
+MarkupSafe>=1.0
+Pillow>=5.3.0
+pyserial>=3.4
+six>=1.11.0
+Unidecode>=1.0.22
+Werkzeug>=0.14.1

src/main.py

@@ -0,0 +1,119 @@
+# Welcome to the LittlePrynter's source code.
+# This program expose a web interface, with user authentification, that makes it possible to print messages from the web.
+# It also exposes a API, making it possible to print and interface with much of the printer's abilities.
+
+# We first define the connection to the printer itself,
+# Then we build the API around Flask,
+# Then we build the web interface, using the simple Jinja2 templating.
+
+# Following are the librairies we import,
+from flask import Flask, request, render_template, flash, abort, redirect, url_for, make_response, jsonify       # Used for the web framework
+from flask_limiter import Limiter
+from flask_limiter.util import get_remote_address
+from printer import Printer             # The wrapper for the printer class
+from web import Web                     # Wrapper for the web routes and API
+import toml                             # Used for the config file parsing
+import pprint                           # To pretty print JSON
+import time                             # To sleep
+import os                               # For VARS from the shell.
+# Variables
+
+# Load the configuration file
+try:
+    configuration_file = toml.load("configuration/config.toml")
+except TypeError :
+    print("Unable to load the config file: invalid type or is a list containing invalid types")
+    exit(-1)
+except toml.TomlDecodeError:
+    print("An error occured while decoding the file")
+    exit(-1)
+except Exception as e:
+    print("Error while loading file : " + str(e))
+
+# Define the USB connections here.
+vendor_id = configuration_file["printer"]["vendor_id"]
+device_id = configuration_file["printer"]["device_id"]
+
+# Output the config file
+if os.getenv('LIPY_DEBUG') == True:
+    pprint.pprint(configuration_file)
+
+# We define the app module used by Flask
+app = Flask(__name__)
+app.secret_key = configuration_file["secrets"]["flask_secret_key"]
+
+
+# Printer connection
+# Uses the class defined in the printer.py file
+printer = Printer(app,0x04b8, 0x0e28)
+printer.init_printer()
+
+# Web routes
+web = Web(app, printer)
+
+
+limiter = Limiter(
+    app,
+    key_func=get_remote_address,
+    default_limits=["200 per day", "50 per hour"]
+)
+
+@app.route('/')
+@limiter.limit("1/second", override_defaults=False)
+def index():
+    return render_template('index.html')
+
+# API routes
+# The api has the following methods
+# api/print/{sms,img,letter,qr,barcode}
+# api/auth/{login,logout}
+# api/status/{paper,ping,stats}
+
+# If you just call the api route, you get a help back.
+@app.route('/api')
+@app.route('/api/print')
+@limiter.limit("1/second", override_defaults=False)
+def api_index():
+    return render_template("api.html")
+
+
+@app.route('/api/print/sms', methods=['POST'])
+@limiter.limit("2/minute", override_defaults=False)
+def api_print_sms():
+    try:
+        txt = request.form["txt"]
+        sign = request.form["signature"]
+    except Exception as e:
+        flash(e)
+        redirect(url_for('index'))
+
+    flash(web.print_sms(txt,sign))
+    return redirect(url_for('index'))
+
+@app.route('/api/print/image', methods=['POST'])
+@limiter.limit("2/minute", override_defaults=False)
+def api_print_image():
+    flash(web.print_image())
+    return "print image"
+
+@app.route('/login')
+@limiter.limit("1/second", override_defaults=False)
+def login_page():
+    # web.login(username,password)
+    return render_template("index.html")
+
+@app.route('/logout')
+@limiter.limit("1/second", override_defaults=False)
+def logout_page():
+    # web.logout(username, password)
+    return render_template("index.html")
+
+@app.errorhandler(429)
+def ratelimit_handler(e):
+    flash("Rate limit reached, please slow down :) ( Currently at "+ e.description + ")", 'error')
+    return render_template('index.html')
+
+@app.route("/ping")
+@limiter.exempt
+def ping():
+    return "PONG"

src/printer.py

@@ -0,0 +1,148 @@
+# Importing the module to mage the connection to the printer.
+from flask import flash
+from escpos.printer import Usb, USBNotFoundError
+from time import sleep, gmtime, strftime
+import os.path
+
+
+class Printer(object):
+    """
+    # The connection is based on the ESC/POS library
+
+    ## Connection to the USB printer
+
+    ## Making sure the printer is alive
+
+    ## Making sure it has paper
+
+    ## Define default print settings
+
+    ## Print starting message, log time of first print, cut.
+
+    ## Annonce readyness : return a positive pong message.
+    """
+
+    # Is the printer ready to accept a new print ?
+    ready = False
+
+    def __init__(self, app, device_id, vendor_id):
+        super(Printer, self).__init__()
+        self.app = app
+        self.ready = False
+        self.printer = None
+        self.device_id = device_id
+        self.vendor_id = vendor_id
+        self.usb_args = {}
+        self.usb_args['idVendor'] = self.device_id
+        self.usb_args['idProduct'] = self.vendor_id
+
+    def check_paper(self) -> bool:
+        # Let's check paper status
+        self.app.logger.debug('Checking paper status...')
+        self.printer.open(self.usb_args)
+        status = self.printer.paper_status()
+        match status:
+            case 0:
+                self.app.logger.error('Printer has no more paper, aborting...')
+                flash("No more paper on the printer. Sorry.",category='error')
+                self.printer.close()
+                return False
+            case 1:
+                self.app.logger.warning('Printer needs paper to be changed very soon ! ')
+                flash('Printer needs paper to be changed very soon ! ', category='info')
+                self.printer.close()
+                return True
+            case 2:
+                self.app.logger.debug('Printer has paper, good to go')
+                self.printer.close()
+                return True
+
+    def init_printer(self):
+
+        # Is the printer online ? Is the communication with the printer successfull ?
+        waiting_elapsed = 30
+        self.app.logger.debug('Waiting for printer to get online...')
+
+        while not self.ready:
+            try:
+                # This also calls open(), which we need to close()
+                # or else the device will appear as busy.
+                p = Usb(self.device_id, self.vendor_id, 0, profile="TM-P80")
+            except USBNotFoundError as e:
+                self.app.logger.error("The USB device is not plugged in, trying again : " + str(e))
+                pass
+
+            try:
+                if p.is_online():
+                    self.ready = True
+                    self.app.logger.debug('Printer online !')
+            except Exception as e:
+                pass
+
+            sleep(1)
+            waiting_elapsed -= 1
+            if waiting_elapsed < 1:
+                self.app.logger.error('Printer took more than 30 seconds to get online, aborting...')
+                waiting_elapsed = 30 # Reset the waiting time for the next print.
+                return False
+
+
+
+
+        # Setting up the printing options.
+        p.set(align='center', font='a', bold=False, underline=0, width=1, height=1, density=9, invert=False, smooth=False, flip=False, double_width=False, double_height=False, custom_size=False)
+        # Beware : if we print every time the printer becomes ready, it means
+        # we are printing before and after every print !
+        self.printer = p
+        self.ready = True;
+        self.printer.close();
+
+        if not self.check_paper():
+            return False
+
+        return True
+
+    def print_sms(self, msg, signature) -> bool:
+        clean_msg = str(msg)
+        clean_signature = str(signature)
+
+        if not self.check_paper():
+            return False
+
+        if len(clean_msg) > 256 or len(clean_msg) < 3 :
+            self.app.logger.warning("Could not print message of this length: " + str(len(clean_msg)))
+            flash("Could not print message of this length :" + str(len(clean_msg)) + ", needs to between 3 and 256 caracters long.",category='error')
+            return False
+
+        if len(signature) > 256 or len(signature) < 3:
+            self.app.logger.warning("Could not print message without a signature.")
+            flash("Could not print message without a signature.",category='error')
+            return False
+
+        if not os.getenv('LIPY_DEBUG') == True:
+            self.printer.open(self.usb_args);
+            self.printer.set(align='left', font='a', bold=False, underline=0, width=1, height=1, density=8, invert=False, smooth=True, flip=False, double_width=False, double_height=False, custom_size=False)
+            self.printer.textln(clean_msg)
+            self.printer.set(align='left', font='b', bold=False, underline=1, width=1, height=1, density=9, invert=False, smooth=True, flip=False, double_width=False, double_height=False, custom_size=False)
+            self.printer.textln("> " + clean_signature + " @ " + strftime("%Y-%m-%d %H:%M:%S", gmtime()))
+            self.printer.cut()
+            self.printer.close()
+        flash("Message printed : " + clean_msg ,category='info')
+        return True
+
+    def print_img(self, path):
+
+        if os.path.isfile(str(path)):
+            pass
+        else:
+            self.app.logger.warning("File does not exist : " + str(path))
+
+        try:
+            self.printer.open(self.usb_args)
+            self.printer.image(path)
+            self.printer.close()
+        except Exception as e:
+            self.printer.close()
+            return e
+        else:
+            self.app.logging.debug("Printed an image : " + str(path))

src/templates/api.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en" dir="ltr">
+  <head>
+    <meta charset="utf-8">
+    <title>LittlePrynter API</title>
+  </head>
+  <body>
+    "Welcome to the printing software's API. Please see the index page to get started.
+  </body>
+</html>

src/templates/index.html

@@ -0,0 +1,60 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="utf-8">
+        <title>LittlePrynter</title>
+        <link rel="shortcut icon" href="{{ url_for('static', filename='favicon.ico') }}">
+        <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+        <link href="{{ url_for('static', filename='css/bootstrap.min.css') }}" rel="stylesheet">
+        <link rel="stylesheet" href="{{ url_for('static',filename='css/style.css') }}">
+    </head>
+    <body class="container">
+        <div class="col-md-6 offset-md-3">
+            <img class="rounded" width="100px" src="{{ url_for('static', filename='images/little-printer.png') }}" alt="LittlePrynter icon"><h1 class="card-title font-weight-bold">Little Prynter</h1>
+            <hr>
+            <br>
+            {% with messages = get_flashed_messages(category_filter=('error')) %}
+              {% if messages %}
+                {% for message in messages %}
+                  <div class="alert alert-warning" role="alert">{{ message }}</div>
+                {% endfor %}
+              {% endif %}
+            {% endwith %}
+
+            {% with messages = get_flashed_messages(category_filter=('info')) %}
+              {% if messages %}
+                {% for message in messages %}
+                  <div class="alert alert-info" role="alert">{{ message }}</div>
+                {% endfor %}
+              {% endif %}
+            {% endwith %}
+
+            <!-- <br>
+            <h3>Imprimer une image aléatoire</h3>
+            <a class="btn btn-primary btn-lg" href="/api/print/image"> Imprimer</a>
+            <hr>
+            <br> -->
+            <div class="card">
+              <h3 class="card-header">Print a short message</h3>
+              <div class="card-body">
+
+                <form class="form-group" action="/api/print/sms" method="post">
+                  <input class="form-control" type="text" name="txt" placeholder="200 chars or less " maxlength="200"><br>
+                  <input class="form-control" type="text" name="signature" placeholder="Signature or pseudo" maxlength="200"><br>
+
+                  <input class="btn btn-primary float-right" type="submit" value="Imprimer" name="imprimer">
+                </form>
+              </div>
+
+              <div id="pbar" style="display:none">
+                <img src="{{ url_for('static',filename='load.gif') }}" alt="loading wheel">
+              </div>
+
+            </div>
+            <br>
+            <br>
+            <hr>
+            <footer>Little Prynter is built for fun by <a href="https://n07070.xyz/about-me/">n07070</a> for fun :) </footer>
+        </div>
+    </body>
+</html>

src/user.py

@@ -0,0 +1,6 @@
+class User(object):
+    """docstring for User."""
+
+    def __init__(self, arg):
+        super(User, self).__init__()
+        self.arg = arg

src/web.py

@@ -0,0 +1,29 @@
+from flask import Flask, request
+from printer import Printer
+import time
+import os
+
+class Web(object):
+    """docstring for web."""
+
+    def __init__(self, app, printer ):
+        super(Web).__init__()
+        self.printer = printer
+        self.app = app
+
+    def print_sms(self, texte, sign: str):
+        # TODO: verify the texte before printing it here ?
+        self.app.logger.debug("Printing : " + str(texte))
+        if not os.getenv('LIPY_DEBUG'):
+            time.sleep(10)
+
+        return self.printer.print_sms(texte, sign)
+
+    def print_image(self, image):
+        pass
+        
+    def login(username: str,password: str) -> bool:
+        pass
+
+    def logout(username: str, password: str) -> bool:
+        pass

templates/index.html

@@ -1,75 +0,0 @@
-<!DOCTYPE html>
-<html>
-    <head>
-        <meta charset="utf-8">
-        <title>LittlePrynter</title>
-        <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-        <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
-        <link rel="stylesheet" href="{{ url_for('static',filename='css/style.css') }}">
-    </head>
-    <body class="container">
-        <div class="col-md-6 offset-md-3">
-            <h1 class="font-weight-bold">Little Prynter</h1>
-            <hr>
-            <br>
-            {% with messages = get_flashed_messages() %}
-              {% if messages %}
-                {% for message in messages %}
-                  <div class="alert alert-danger" role="alert">{{ message }}</div>
-                {% endfor %}
-              {% endif %}
-            {% endwith %}
-            <br>
-            <h3>Imprimer une image aléatoire</h3>
-            <a class="btn btn-primary btn-lg btn-block" href="/print/image"> Imprimer</a>
-            <hr>
-            <br>
-            <h3>Imprimer ton propre texte</h3>
-            <form class="form-group" action="/print/text" method="post">
-                <input class="form-control" type="text" name="message" placeholder="200 caractères ou moins " maxlength="200"><br>
-                <input class="btn btn-primary float-right" type="submit" value="Imprimer" name="imprimer">
-            </form>
-
-            <div id="pbar" style="display:none">
-                <img src="{{ url_for('static',filename='load.gif') }}" alt="loading wheel">
-            </div>
-            <br>
-            <br>
-            <footer><a href="/logout">Se déconnecter</a></footer>
-        </div>
-    </body>
-
-    <script>
-
-    function printImage() {
-        // Make an ajax call to the flask server on the /print/image route to trigger an image to be printer.
-        var xhttp = new XMLHttpRequest();
-         xhttp.onreadystatechange = function() {
-             var x = document.getElementById("pbar");
-                if (x.style.display === "none") {
-                    x.style.display = "inline";
-                }
-           if (this.readyState == 4 && this.status == 429) {
-               x.style.display = "none";
-               alert("Hé, attends un peu avant d'imprimer une autre image, je me repose...");
-           } else if (this.readyState == 4 && this.status == 200) {
-               x.style.display = "none";
-           }
-         };
-         xhttp.open("GET", "/print/image", true);
-         xhttp.send();
-    }
-
-    function printText(){
-        var xhttp = new XMLHttpRequest();
-         xhttp.onreadystatechange = function() {
-             if (this.readyState == 4 && this.status == 400) {
-               alert("Le text est trop long !");
-           }
-         };
-         xhttp.open("GET", "/print/text", true);
-         xhttp.send();
-    }
-
-    </script>
-</html>