Merge branch 'rc/maintenance'

Author: foosel

.versioneer-lookup

@@ -18,16 +18,16 @@ prerelease
 HEAD
 \(detached.*
 
-# maintenance is currently the branch for preparation of maintenance release 1.3.9
+# maintenance is currently the branch for preparation of maintenance release 1.3.11
 # so are any fix/... and improve/... branches
-maintenance 1.3.10 fdf0f75ffa5731fee406c6e761e84a9d2b47aa43 pep440-dev
-fix/.* 1.3.10 fdf0f75ffa5731fee406c6e761e84a9d2b47aa43 pep440-dev
-improve/.* 1.3.10 fdf0f75ffa5731fee406c6e761e84a9d2b47aa43 pep440-dev
+maintenance 1.3.11 e14c00f135bf2a955e54ac3f0a2928d8440055d2 pep440-dev
+fix/.* 1.3.11 e14c00f135bf2a955e54ac3f0a2928d8440055d2 pep440-dev
+improve/.* 1.3.11 e14c00f135bf2a955e54ac3f0a2928d8440055d2 pep440-dev
 
-# staging/maintenance is currently the branch for preparation of 1.3.10rc5
+# staging/maintenance is currently the branch for preparation of 1.3.11rc3
 # so is regressionfix/...
-staging/maintenance 1.3.10rc5 e628aedbc11e2ef03ba4172b93e5be2a892b955b pep440-dev
-regressionfix/.* 1.3.10rc5 e628aedbc11e2ef03ba4172b93e5be2a892b955b pep440-dev
+staging/maintenance 1.3.11rc3 18e7d2b72ad73c5d8e522cebbc001d0e8a3dff14 pep440-dev
+regressionfix/.* 1.3.11rc3 18e7d2b72ad73c5d8e522cebbc001d0e8a3dff14 pep440-dev
 
 # every other branch is a development branch and thus gets resolved to 1.4.0-dev for now
 .* 1.4.0 7f5d03d0549bcbd26f40e7e4a3297ea5204fb1cc pep440-dev

AUTHORS.md

@@ -94,6 +94,11 @@ date of first contribution):
   * [Gaston Dombiak](https://github.com/gdombiak)
   * [Brad Fisher](https://github.com/bradcfisher)
   * [Aldo Hoeben](https://github.com/fieldofview)
+  * [Henning Groß](https://github.com/hgross)
+  * [Jubaleth](https://github.com/jubaleth)
+  * [Daniel Joyce](https://github.com/DanielJoyce)
+  * [Andy Qua](https://github.com/AndyQ)
+  * [Fabio Santos](https://github.com/Fabi0San)
 
 OctoPrint started off as a fork of [Cura](https://github.com/daid/Cura) by
 [Daid Braam](https://github.com/daid). Parts of its communication layer and

CHANGELOG.md

@@ -143,5 +143,8 @@ be edited from OctoPrint's settings dialog.
 
 ## Special Thanks
 
-Cross-browser testing services are kindly provided by [BrowserStack](http://www.browserstack.com/).
-Profiling is done with the help of [PyVmMonitor](http://www.pyvmmonitor.com).
+Cross-browser testing services are kindly provided by [BrowserStack](https://www.browserstack.com/).
+
+Profiling is done with the help of [PyVmMonitor](https://www.pyvmmonitor.com).
+
+Error tracking is powered and sponsored by [Sentry](https://sentry.io).

README.md

@@ -9,49 +9,49 @@ thanks to everyone who contributed!
   * Andre Bubel
   * Andrew Moorby
   * Arnljot Arntsen
+  * Bjorn Breckenridge
   * Boris Hussein
   * Brad Jackson
   * Christian Petropolis
   * Christian Wolf
   * COLLE+McVOY
   * D Brian Kimmel
   * DeltaMaker 3D Printers
+  * Dorian Gray
   * E3D BigBox
   * Eric Betts
-  * Eric Slape
   * Ernesto Martinez
-  * Frank Sander
+  * Franziska Kunsmann
   * George Robles
-  * Jared Go
+  * jean-claude migneault
   * Jeff Renfer
   * Jefferson Hunt
   * Jeremiah Avery
   * Joseph Payne
-  * Josh Daniels
   * Joshua Wills
   * Justin Kaufman
   * Kaile Riser
   * Kale Stedman
   * Kazuhiro Ogura
   * LA 3D Printer Repair
-  * Lewis Newby
   * LulzBot®
   * Makespace Madrid
   * Mark Walker
   * Michael Aumock
   * Miles Flavel
   * Mosaic Manufacturing
+  * OMER MEHMET SUTAS
   * Patrick McGinnis
   * Prof Yuh Wen Chen
   * Randy C. Will
   * Robert Gusek
-  * Roger Strolz
   * Samer Najia
+  * Shawn Lewis
   * Simon Hallam
   * Stefan Krister
   * Sven Mueller
-  * Thomas Hatley
-  * Timothy D Hoogland
+  * TEVO 3D Printers
   * Trent Shumay
+  * Ulrich Kempken
 
-and 1446 more wonderful people pledging on the [Patreon campaign](https://patreon.com/foosel)!
+and 1544 more wonderful people pledging on the [Patreon campaign](https://patreon.com/foosel)!

SUPPORTERS.md

@@ -36,7 +36,6 @@
   * [Awesome-Slugify](https://pypi.python.org/pypi/awesome-slugify): GPLv3
   * [chainmap](https://bitbucket.org/jeunice/chainmap): Python
   * [Click](http://click.pocoo.org/): BSD
-  * [dateutil](https://dateutil.readthedocs.io/): BSD
   * [emoji](https://github.com/carpedm20/emoji/): BSD
   * [feedparser](https://github.com/kurtmckee/feedparser): BSD
   * [Flask](http://flask.pocoo.org/): BSD

THIRDPARTYLICENSES.md

@@ -11,6 +11,10 @@ Apps
 Session Keys
 ============
 
+.. deprecated:: 1.3.11
+
+   This functionality will be removed in 1.4.0. Use the :ref:`Application Keys Plugin workflow <sec-bundledplugins-appkeys-workflow>` instead.
+
 OctoPrint offers a special API key type for apps to use, the so called App Session Key. These keys have a time based
 validity and are generated by OctoPrint for requesting apps.
 

docs/api/apps.rst

@@ -11,9 +11,9 @@ General information
 Authorization
 =============
 
-OctoPrint's API expects an API key to be supplied with each request. This API key can be either the globally
-configured one, a user specific one if "Access Control" is enabled or an app and user specific one as generated
-by the authorization workflow implemented by the bundled :ref:`Application Keys Plugin <sec-bundledplugins-appkeys>` (since 1.3.10).
+If :ref:`Access Control <sec-features-access_control>` is enabled OctoPrint's API expects an API key to be supplied with each request. This API
+key can be either the globally configured one, a user specific one or an app and user specific one as generated by the
+authorization workflow implemented by the bundled :ref:`Application Keys Plugin <sec-bundledplugins-appkeys>` (since 1.3.10).
 
 Clients are advised to implement the :ref:`Application Keys Plugin workflow <sec-bundledplugins-appkeys-workflow>` first and
 fallback on directing the user to manually supply the the user specific API key. The global key should rarely be used.
@@ -26,8 +26,6 @@ The API key must be supplied in the custom HTTP header ``X-Api-Key``, e.g.
    Host: example.com
    X-Api-Key: abcdef...
 
-If it is missing or included but invalid, OctoPrint will directly return a response with status :http:statuscode:`403`.
-
 For testing purposes it is also possible to supply the API key via a query parameter ``apikey``, e.g.
 
 .. sourcecode:: http
@@ -37,6 +35,24 @@ For testing purposes it is also possible to supply the API key via a query param
 
 Please be advised that clients should use the header field variant if at all possible.
 
+If the key is missing or invalid, OctoPrint will treat the request as it would any unauthenticated anonymous request to the endpoint.
+Consequently, if the bundled :ref:`ForceLogin plugin <sec-bundledplugins-forcelogin>` is active (which is the default), that means
+that any requests without or with an invalid API key targeting other API endpoints than :ref:`Login <sec-api-general-login>`
+will be denied with a :http:statuscode:`403`.
+
+.. warning::
+
+   If :ref:`Access Control <sec-features-access_control>` is disabled, OctoPrint will treat any unauthenticated anonymous requests and thus also requests
+   with an invalid or outright missing API key as requests with full admin rights!
+
+.. note::
+
+   The API key requirements changed in 1.3.11. Up to that version, even if Access Control was disabled, all requests needed to
+   be supplied with an API Key. To make the webinterface work under these circumstances, an unauthenticated anonymous API key was injected into the
+   HTML page and also available on the :ref:`Push API <sec-api-push>`. The presence and ready availability of this unauthenticated
+   anonymous "UI API key" caused confusion and false alarm among users and didn't contribute to the security of the platform in a
+   meaningful way, so it was finally abandoned in 1.3.11.
+
 .. _fig-api-general-globalapikey:
 .. figure:: ../images/settings-global-api-key.png
    :align: center
@@ -58,11 +74,6 @@ Please be advised that clients should use the header field variant if at all pos
 
    The API key options in the "Change password" dialog. Users can generate and revoke their custom API key here.
 
-.. note::
-   OctoPrint's web interface uses a custom API key that is freshly generated on every server start. This key is not
-   intended to be used by any other client and would not be very useful in any case, since it basically represents
-   a completely anonymous client.
-
 .. _sec-api-general-contenttype:
 
 Content Type

docs/api/general.rst

@@ -212,7 +212,8 @@ Retrieve information about the current job
           "filepos": 337942,
           "printTime": 276,
           "printTimeLeft": 912
-        }
+        },
+        "state": "Printing"
       }
 
    :statuscode 200: No error
@@ -243,4 +244,8 @@ Job information response
      - 1
      - :ref:`sec-api-datamodel-jobs-progress`
      - Information regarding the progress of the current print job
-
+   * - ``state``
+     - 1
+     - String
+     - A textual representation of the current state of the job, i.e. "Operational", "Printing", "Pausing", "Paused",
+       "Cancelling", "Error" or "Offline".

docs/api/job.rst

@@ -22,6 +22,11 @@ Bed
   corresponding resource returns temperature information including an optional history. Note that Bed commands
   are only available if the currently selected printer profile has a heated bed.
   See :ref:`sec-api-printer-bedcommand`.
+Chamber
+  Chamber commands allow setting the temperature and temperature offset for the printer's heated chamber. Querying
+  the corresponding resource returns temperature information including an option history. Note that Chamber commands
+  are only available if the currently selected printer profile has a heated chamber.
+  See :ref:`sec-api-printer-chambercommand`.
 SD card
   SD commands allow initialization, refresh and release of the printer's SD card (if available). Querying the
   corresponding resource returns the current SD card state.
@@ -623,12 +628,12 @@ Issue a bed command
    are:
 
    target
-     Sets the given target temperature on the printer's tools. Additional parameters:
+     Sets the given target temperature on the printer's bed. Additional parameters:
 
      * ``target``: Target temperature to set.
 
    offset
-     Sets the given temperature offset on the printer's tools. Additional parameters:
+     Sets the given temperature offset on the printer's bed. Additional parameters:
 
      * ``offset``: Offset to set.
 
@@ -710,7 +715,7 @@ Retrieve the current bed state
    an :http:statuscode:`409`.
 
    .. note::
-      If you want both tool and bed temperature information at the same time, take a look at
+      If you want tool, bed and chamber temperature information at the same time, take a look at
       :ref:`Retrieve the current printer state <sec-api-printer-state>`.
 
    **Example**
@@ -760,6 +765,154 @@ Retrieve the current bed state
    :statuscode 409: If the printer is not operational or the selected printer profile
                     does not have a heated bed.
 
+.. _sec-api-printer-chambercommand:
+
+Issue a chamber command
+=======================
+
+.. http:post:: /api/printer/bed
+
+   Chamber commands allow setting the temperature and temperature offsets for the printer's heated chamber. Available commands
+   are:
+
+   target
+     Sets the given target temperature on the printer's chamber. Additional parameters:
+
+     * ``target``: Target temperature to set.
+
+   offset
+     Sets the given temperature offset on the printer's chamber. Additional parameters:
+
+     * ``offset``: Offset to set.
+
+   All of these commands may only be sent if the printer is currently operational. Otherwise a :http:statuscode:`409`
+   is returned.
+
+   Upon success, a status code of :http:statuscode:`204` and an empty body is returned.
+
+   If no heated chambed is configured for the currently selected printer profile, the resource will return
+   an :http:statuscode:`409`.
+
+   Requires user rights.
+
+   **Example Target Temperature Request**
+
+   Set the target temperature for the printer's heated chamber to 50°C.
+
+   .. sourcecode:: http
+
+      POST /api/printer/chamber HTTP/1.1
+      Host: example.com
+      Content-Type: application/json
+      X-Api-Key: abcdef...
+
+      {
+        "command": "target",
+        "target": 50
+      }
+
+   .. sourcecode:: http
+
+      HTTP/1.1 204 No Content
+
+   **Example Offset Temperature Request**
+
+   Set the temperature offset for the heated chamber to -5°C.
+
+   .. sourcecode:: http
+
+      POST /api/printer/chamber HTTP/1.1
+      Host: example.com
+      Content-Type: application/json
+      X-Api-Key: abcdef...
+
+      {
+        "command": "offset",
+        "offset": -5
+      }
+
+   .. sourcecode:: http
+
+      HTTP/1.1 204 No Content
+
+   :json string command: The command to issue, either ``target`` or ``offset``.
+   :json object target: ``target`` command: The target temperature to set.
+   :json object offset: ``offset`` command: The offset temperature to set.
+   :statuscode 204: No error
+   :statuscode 400: If ``target`` or ``offset`` is not a valid number or outside of the supported range, or if the
+                    request is otherwise invalid.
+   :statuscode 409: If the printer is not operational or the selected printer profile
+                    does not have a heated chamber.
+
+.. _sec-api-printer-chamberstate:
+
+Retrieve the current chamber state
+==================================
+
+.. http:get:: /api/printer/chamber
+
+   Retrieves the current temperature data (actual, target and offset) plus optionally a (limited) history (actual, target,
+   timestamp) for the printer's heated chamber.
+
+   It's also possible to retrieve the temperature history by supplying the ``history`` query parameter set to ``true``. The
+   amount of returned history data points can be limited using the ``limit`` query parameter.
+
+   Returns a :http:statuscode:`200` with a Temperature Response in the body upon success.
+
+   If no heated chamber is configured for the currently selected printer profile, the resource will return
+   an :http:statuscode:`409`.
+
+   .. note::
+      If you want tool, bed and chamber temperature information at the same time, take a look at
+      :ref:`Retrieve the current printer state <sec-api-printer-state>`.
+
+   **Example**
+
+   Query the chamber temperature data and also include the temperature history but limit it to two entries.
+
+   .. sourcecode:: http
+
+      GET /api/printer/chamber?history=true&limit=2 HTTP/1.1
+      Host: example.com
+      X-Api-Key: abcdef...
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Content-Type: application/json
+
+      {
+        "chamber": {
+          "actual": 50.221,
+          "target": 70.0,
+          "offset": 5
+        },
+        "history": [
+          {
+            "time": 1395651928,
+            "chamber": {
+              "actual": 50.221,
+              "target": 70.0
+            }
+          },
+          {
+            "time": 1395651926,
+            "chamber": {
+              "actual": 49.1123,
+              "target": 70.0
+            }
+          }
+        ]
+      }
+
+   :query history:  If set to ``true`` (or: ``yes``, ``y``, ``1``), history information will be included in the response
+                    too. If no ``limit`` parameter is given, all available temperature history data will be returned.
+   :query limit:    If set to an integer (``n``), only the last ``n`` data points from the printer's temperature history
+                    will be returned. Will be ignored if ``history`` is not enabled.
+   :statuscode 200: No error
+   :statuscode 409: If the printer is not operational or the selected printer profile
+                    does not have a heated chamber.
+
 .. _sec-api-printer-sdcommand:
 
 Issue an SD command