httprint: initial commit

.gitignore

@@ -0,0 +1,11 @@
+conf/*.json
+conf/*.db
+.DS_Store
+node_modules/
+__pycache__
+storage/*
+npm-debug*.log
+ssl/*.pem
+*.py[cod]
+*.so
+.editorconfig

LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,38 @@
+# HTTPrint
+
+A very simple web interface to upload and print files.
+
+
+## Install and run
+
+To install it:
+``` bash
+wget https://bootstrap.pypa.io/get-pip.py
+sudo python3 get-pip.py
+# if you want to install these modules for an unprivileged user, add --user and remove "sudo";
+# if you want to upgrade the versions already present in the system, also add --upgrade
+sudo pip3 install tornado
+git clone https://github.com/alberanid/httprint
+cd httprint
+./httprint.py --debug
+```
+
+Now you can **point your browser to [http://localhost:7777/](http://localhost:7777/)**
+
+You can also **run the server in https**, putting in the *ssl* directory two files named *httprint_key.pem* and *httprint_cert.pem*
+
+
+# License and copyright
+
+Copyright 2019 Davide Alberani <da@mimante.net>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

dist/index.html

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8" />
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+    <link rel="stylesheet" type="text/css" href="/static/css/iziToast.min.css">
+    <script src="/static/js/iziToast.min.js"></script>
+    <script src="/static/js/httprint.js"></script>
+    <title>HTTPrint</title>
+</head>
+<body>
+    <h1>Upload a file to print</h1>
+
+    <input id="upload-file" type="file" />
+
+    <button onClick="uploadFile();">print</button>
+</body>
+</html>

dist/static/js/httprint.js

@@ -0,0 +1,38 @@
+function uploadFile() {
+    let photo = document.getElementById("upload-file").files[0];
+    let formData = new FormData();
+
+    formData.append("file", photo);
+    var uploadFile = document.getElementById('upload-file');
+    fetch("/api/upload", {method: "POST", body: formData})
+        .then(function(response) {
+            return response.json();
+        })
+        .then(function(reply) {
+            if (reply && !reply.error) {
+                iziToast.success({
+                    title: "DONE!",
+                    message: "file sent to printer",
+                    position: 'topCenter',
+                    layout: 2
+                });
+            } else {
+                iziToast.error({
+                    title: "ERROR!",
+                    message: reply.message,
+                    position: 'topCenter',
+                    layout: 2
+                });
+            }
+            uploadFile.value = null;
+        })
+        .catch(function(err) {
+            iziToast.error({
+                title: "ERROR!",
+                message: "failed to send file",
+                position: 'topCenter',
+                layout: 2
+            });
+            uploadFile.value = null;
+        });
+}

httprint.py

@@ -0,0 +1,211 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""httprint - print files via web
+
+Copyright 2019 Davide Alberani <da@mimante.net>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+import os
+import time
+import random
+import asyncio
+import logging
+import subprocess
+import multiprocessing as mp
+
+from tornado.ioloop import IOLoop
+import tornado.httpserver
+import tornado.options
+from tornado.options import define, options
+import tornado.web
+from tornado import gen, escape
+
+
+API_VERSION = '1.0'
+UPLOAD_PATH = 'uploads'
+PRINT_CMD = ['lp']
+PROCESS_TIMEOUT = 60
+ENCODING = 'utf-8'
+
+logger = logging.getLogger()
+logger.setLevel(logging.INFO)
+
+
+class HTTPrintBaseException(Exception):
+    """Base class for httprint custom exceptions.
+
+    :param message: text message
+    :type message: str
+    :param status: numeric http status code
+    :type status: int"""
+    def __init__(self, message, status=400):
+        super(HTTPrintBaseException, self).__init__(message)
+        self.message = message
+        self.status = status
+
+
+class BaseHandler(tornado.web.RequestHandler):
+    """Base class for request handlers."""
+    # A property to access the first value of each argument.
+    arguments = property(lambda self: dict([(k, v[0].decode('utf-8'))
+                                            for k, v in self.request.arguments.items()]))
+
+    @property
+    def clean_body(self):
+        """Return a clean dictionary from a JSON body, suitable for a query on MongoDB.
+
+        :returns: a clean copy of the body arguments
+        :rtype: dict"""
+        return escape.json_decode(self.request.body or '{}')
+
+    def write_error(self, status_code, **kwargs):
+        """Default error handler."""
+        if isinstance(kwargs.get('exc_info', (None, None))[1], HTTPrintBaseException):
+            exc = kwargs['exc_info'][1]
+            status_code = exc.status
+            message = exc.message
+        else:
+            message = 'internal error'
+        self.build_error(message, status=status_code)
+
+    def initialize(self, **kwargs):
+        """Add every passed (key, value) as attributes of the instance."""
+        for key, value in kwargs.items():
+            setattr(self, key, value)
+
+    def build_error(self, message='', status=400):
+        """Build and write an error message.
+
+        :param message: textual message
+        :type message: str
+        :param status: HTTP status code
+        :type status: int
+        """
+        self.set_status(status)
+        self.write({'error': True, 'message': message})
+
+    def build_success(self, message='', status=200):
+        """Build and write a success message.
+
+        :param message: textual message
+        :type message: str
+        :param status: HTTP status code
+        :type status: int
+        """
+        self.set_status(status)
+        self.write({'error': False, 'message': message})
+
+    def _run(self, cmd):
+        p = subprocess.Popen(cmd, close_fds=True)
+        p.communicate()
+
+    def run_subprocess(self, cmd):
+        """Execute the given action.
+
+        :param cmd: the command to be run with its command line arguments
+        :type cmd: list
+        """
+        p = mp.Process(target=self._run, args=(cmd,))
+        p.start()
+
+class UploadHandler(BaseHandler):
+    """Reset schedules handler."""
+    @gen.coroutine
+    def post(self):
+        if not self.request.files.get('file'):
+            self.build_error("no file uploaded")
+            return
+        fileinfo = self.request.files['file'][0]
+        webFname = fileinfo['filename']
+        extension = ''
+        try:
+            extension = os.path.splitext(webFname)[1]
+        except Exception:
+            pass
+        if not os.path.isdir(UPLOAD_PATH):
+            os.makedirs(UPLOAD_PATH)
+        fname = '%s-%s%s' % (
+            time.strftime('%Y%m%d%H%M%S'),
+            '%04d' % random.randint(0, 9999),
+            extension)
+        pname = os.path.join(UPLOAD_PATH, fname)
+        try:
+            with open(pname, 'wb') as fd:
+                fd.write(fileinfo['body'])
+        except Exception as e:
+            self.build_error("error writing file %s: %s" % (pname, e))
+            return
+        try:
+            with open(pname + '.info', 'w') as fd:
+                fd.write('originale file name: %s\n' % webFname)
+        except Exception:
+            pass
+        cmd = PRINT_CMD + [pname]
+        self.run_subprocess(cmd)
+        self.build_success("file sent to printer")
+
+
+class TemplateHandler(BaseHandler):
+    """Handler for the template files in the / path."""
+    @gen.coroutine
+    def get(self, *args, **kwargs):
+        """Get a template file."""
+        page = 'index.html'
+        if args and args[0]:
+            page = args[0].strip('/')
+        arguments = self.arguments
+        self.render(page, **arguments)
+
+
+def serve():
+    """Read configuration and start the server."""
+    define('port', default=7777, help='run on the given port', type=int)
+    define('address', default='', help='bind the server at the given address', type=str)
+    define('ssl_cert', default=os.path.join(os.path.dirname(__file__), 'ssl', 'httprint_cert.pem'),
+            help='specify the SSL certificate to use for secure connections')
+    define('ssl_key', default=os.path.join(os.path.dirname(__file__), 'ssl', 'httprint_key.pem'),
+            help='specify the SSL private key to use for secure connections')
+    define('debug', default=False, help='run in debug mode', type=bool)
+    tornado.options.parse_command_line()
+
+    if options.debug:
+        logger.setLevel(logging.DEBUG)
+
+    ssl_options = {}
+    if os.path.isfile(options.ssl_key) and os.path.isfile(options.ssl_cert):
+        ssl_options = dict(certfile=options.ssl_cert, keyfile=options.ssl_key)
+
+    init_params = dict(listen_port=options.port, logger=logger, ssl_options=ssl_options)
+
+    _upload_path = r'upload/?'
+    application = tornado.web.Application([
+            (r'/api/%s' % _upload_path, UploadHandler, init_params),
+            (r'/api/v%s/%s' % (API_VERSION, _upload_path), UploadHandler, init_params),
+            (r'/?(.*)', TemplateHandler, init_params),
+        ],
+        static_path=os.path.join(os.path.dirname(__file__), 'dist/static'),
+        template_path=os.path.join(os.path.dirname(__file__), 'dist/'),
+        debug=options.debug)
+    http_server = tornado.httpserver.HTTPServer(application, ssl_options=ssl_options or None)
+    logger.info('Start serving on %s://%s:%d', 'https' if ssl_options else 'http',
+                                                 options.address if options.address else '127.0.0.1',
+                                                 options.port)
+    http_server.listen(options.port, options.address)
+    try:
+        IOLoop.instance().start()
+    except (KeyboardInterrupt, SystemExit):
+        pass
+
+
+if __name__ == '__main__':
+    serve()