Bump to 3.13.0

Currently translated at 100.0% (3850 of 3850 strings)

Translation: pretix/pretix
Translate-URL: https://translate.pretix.eu/projects/pretix/pretix/de_Informal/

powered by weblate

.github/workflows/docs.yml

@@ -31,7 +31,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system packages
-        run: sudo apt install enchant hunspell aspell-en
+        run: sudo apt update && sudo apt install enchant hunspell aspell-en
       - name: Install Dependencies
         run: pip3 install --no-use-pep517 -Ur doc/requirements.txt
       - name: Spellcheck docs

.github/workflows/strings.yml

@@ -4,10 +4,12 @@ on:
   push:
     branches: [ master ]
     paths:
+      - 'doc/**'
       - 'src/pretix/locale/**'
   pull_request:
     branches: [ master ]
     paths:
+      - 'doc/**'
       - 'src/pretix/locale/**'
 
 jobs:
@@ -27,7 +29,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system packages
-        run: sudo apt install gettext
+        run: sudo apt update && sudo apt install gettext
       - name: Install Dependencies
         run: pip3 install --no-use-pep517 -Ur src/requirements.txt
       - name: Compile messages
@@ -52,7 +54,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system packages
-        run: sudo apt install enchant hunspell hunspell-de-de aspell-en aspell-de
+        run: sudo apt update && sudo apt install enchant hunspell hunspell-de-de aspell-en aspell-de
       - name: Install Dependencies
         run: pip3 install --no-use-pep517 -Ur src/requirements/dev.txt
       - name: Spellcheck translations

.github/workflows/style.yml

@@ -31,7 +31,7 @@ jobs:
       - name: Install Dependencies
         run: pip3 install --no-use-pep517 -Ur src/requirements/dev.txt
       - name: Run isort
-        run: isort -c -rc -df .
+        run: isort -c .
         working-directory: ./src
   flake:
     name: flake8

.github/workflows/tests.yml

@@ -5,10 +5,12 @@ on:
     branches: [ master ]
     paths-ignore:
       - 'doc/**'
+      - 'src/pretix/locale/**'
   pull_request:
     branches: [ master ]
     paths-ignore:
       - 'doc/**'
+      - 'src/pretix/locale/**'
 
 jobs:
   test:
@@ -53,7 +55,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system dependencies
-        run: sudo apt install gettext mysql-client
+        run: sudo apt update && sudo apt install gettext mysql-client
       - name: Install Python dependencies
         run: pip3 install -r src/requirements.txt --no-use-pep517 -Ur src/requirements/dev.txt mysqlclient psycopg2-binary
       - name: Run checks

.gitlab-ci.yml

@@ -20,15 +20,17 @@ pypi:
         - cp /keys/.pypirc ~/.pypirc
         - virtualenv env
         - source env/bin/activate
-        - pip install -U pip wheel setuptools
+        - pip install -U pip wheel setuptools check-manifest twine
         - XDG_CACHE_HOME=/cache pip3 install -Ur src/requirements.txt -r src/requirements/dev.txt
         - cd src
         - python setup.py sdist
         - pip install dist/pretix-*.tar.gz
         - python -m pretix migrate
         - python -m pretix check
-        - python setup.py sdist upload
-        - python setup.py bdist_wheel upload
+        - check-manifest
+        - python setup.py sdist bdist_wheel
+        - twine check dist/*
+        - twine upload dist/*
     tags:
         - python3
     only:

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.6
+FROM python:3.8
 
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
@@ -29,8 +29,9 @@ RUN apt-get update && \
     mkdir /etc/pretix && \
     mkdir /data && \
     useradd -ms /bin/bash -d /pretix -u 15371 pretixuser && \
-    echo 'pretixuser ALL=(ALL) NOPASSWD: /usr/bin/supervisord' >> /etc/sudoers && \
-    mkdir /static
+    echo 'pretixuser ALL=(ALL) NOPASSWD:SETENV: /usr/bin/supervisord' >> /etc/sudoers && \
+    mkdir /static && \
+    mkdir /etc/supervisord
 
 ENV LC_ALL=C.UTF-8 \
     DJANGO_SETTINGS_MODULE=production_settings
@@ -47,12 +48,13 @@ RUN pip3 install -U \
         -r requirements.txt \
         -r requirements/memcached.txt \
         -r requirements/mysql.txt \
-        -r requirements/redis.txt \
-        gunicorn && \
+        gunicorn django-extensions ipython && \
     rm -rf ~/.cache/pip
 
 COPY deployment/docker/pretix.bash /usr/local/bin/pretix
-COPY deployment/docker/supervisord.conf /etc/supervisord.conf
+COPY deployment/docker/supervisord /etc/supervisord
+COPY deployment/docker/supervisord.all.conf /etc/supervisord.all.conf
+COPY deployment/docker/supervisord.web.conf /etc/supervisord.web.conf
 COPY deployment/docker/nginx.conf /etc/nginx/nginx.conf
 COPY deployment/docker/production_settings.py /pretix/src/production_settings.py
 COPY src /pretix/src

README.rst

@@ -19,9 +19,8 @@ Reinventing ticket presales, one ticket at a time.
 Project status & release cycle
 ------------------------------
 
-While there is always a lot to do and improve on, pretix by now has been in use for more than a dozen
-conferences that sold over ten thousand tickets combined without major problems. We therefore think of
-pretix as being stable and ready to use.
+While there is always a lot to do and improve on, pretix by now has been in use for thousands of events
+conferences that sold millions of tickets combined. We therefore think of pretix as being stable and ready to use.
 
 If you want to use or extend pretix, we strongly recommend to follow our `blog`_. We will announce all
 releases there. You can always find the latest stable version on PyPI or in the ``release/X.Y`` branch of
@@ -30,9 +29,13 @@ the sense that it does not break your data,  but its APIs might change without p
 
 To get started using pretix on your own server, look at the `installation guide`_ in our documentation.
 
-This project is 100 percent free and open source software. If you are interested in commercial support,
-hosting services or supporting this project financially, please go to `pretix.eu`_ or contact us at
-support@pretix.eu.
+Support
+-------
+
+This project is 100 percent free and open source software. You are welcome to ask questions in the GitHub
+repository. Private support via email or phone is only offered to customers of our pretix Hosted or pretix
+Enterprise offerings. If you are interested in commercial support, hosting services or supporting this project
+financially, please go to `pretix.eu`_ or contact us at support@pretix.eu.
 
 Contributing
 ------------
@@ -52,8 +55,8 @@ License
 The code in this repository is published under the terms of the Apache License. 
 See the LICENSE file for the complete license text.
 
-This project is maintained by Raphael Michel <mail@raphaelmichel.de>. See the
-AUTHORS file for a list of all the awesome folks who contributed to this project.
+This project is maintained by Raphael Michel. See the AUTHORS file for a list of all
+the awesome folks who contributed to this project.
 
 .. _installation guide: https://docs.pretix.eu/en/latest/admin/installation/index.html
 .. _developer documentation: https://docs.pretix.eu/en/latest/development/index.html

deployment/docker/pretix.bash

@@ -5,6 +5,8 @@ export DATA_DIR=/data/
 export HOME=/pretix
 export NUM_WORKERS=$((2 * $(nproc --all)))
 
+AUTOMIGRATE=${AUTOMIGRATE:-yes}
+
 if [ ! -d /data/logs ]; then
     mkdir /data/logs;
 fi
@@ -16,10 +18,16 @@ if [ "$1" == "cron" ]; then
     exec python3 -m pretix runperiodic
 fi
 
-python3 -m pretix migrate --noinput
+if [ "$AUTOMIGRATE" != "skip" ]; then
+  python3 -m pretix migrate --noinput
+fi
 
 if [ "$1" == "all" ]; then
-    exec sudo /usr/bin/supervisord -n -c /etc/supervisord.conf
+    exec sudo -E /usr/bin/supervisord -n -c /etc/supervisord.all.conf
+fi
+
+if [ "$1" == "web" ]; then
+    exec sudo -E /usr/bin/supervisord -n -c /etc/supervisord.web.conf
 fi
 
 if [ "$1" == "webworker" ]; then
@@ -33,17 +41,12 @@ if [ "$1" == "webworker" ]; then
 fi
 
 if [ "$1" == "taskworker" ]; then
-    export C_FORCE_ROOT=True
-    exec celery -A pretix.celery_app worker -l info
-fi
-
-if [ "$1" == "shell" ]; then
-    exec python3 -m pretix shell
+    shift
+    exec celery -A pretix.celery_app worker -l info "$@"
 fi
 
 if [ "$1" == "upgrade" ]; then
     exec python3 -m pretix updatestyles
 fi
 
-echo "Specify argument: all|cron|webworker|taskworker|shell|upgrade"
-exit 1
+exec python3 -m pretix "$@"

deployment/docker/supervisord.all.conf

@@ -0,0 +1,2 @@
+[include]
+files = /etc/supervisord/*.conf

deployment/docker/supervisord.conf

@@ -1,44 +0,0 @@
-[unix_http_server]
-file=/tmp/supervisor.sock
-
-[supervisord]
-logfile=/tmp/supervisord.log
-logfile_maxbytes=50MB
-logfile_backups=10
-loglevel=info
-pidfile=/tmp/supervisord.pid
-nodaemon=false
-minfds=1024
-minprocs=200
-
-[rpcinterface:supervisor]
-supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
-
-[supervisorctl]
-serverurl=unix:///tmp/supervisor.sock
-
-[program:pretixweb]
-command=/usr/local/bin/pretix webworker
-autostart=true
-autorestart=true
-priority=5
-user=pretixuser
-environment=HOME=/pretix
-
-[program:pretixtask]
-command=/usr/local/bin/pretix taskworker
-autostart=true
-autorestart=true
-priority=5
-user=pretixuser
-
-[program:nginx]
-command=/usr/sbin/nginx
-autostart=true
-autorestart=true
-priority=10
-stdout_events_enabled=true
-stderr_events_enabled=true
-
-[include]
-files = /etc/supervisord-*.conf

deployment/docker/supervisord.web.conf

@@ -0,0 +1,2 @@
+[include]
+files = /etc/supervisord/base.conf /etc/supervisord/nginx.conf /etc/supervisord/pretixweb.conf

deployment/docker/supervisord/base.conf

@@ -0,0 +1,18 @@
+[unix_http_server]
+file=/tmp/supervisor.sock
+
+[supervisord]
+logfile=/tmp/supervisord.log
+logfile_maxbytes=50MB
+logfile_backups=10
+loglevel=info
+pidfile=/tmp/supervisord.pid
+nodaemon=false
+minfds=1024
+minprocs=200
+
+[rpcinterface:supervisor]
+supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
+
+[supervisorctl]
+serverurl=unix:///tmp/supervisor.sock

deployment/docker/supervisord/nginx.conf

@@ -0,0 +1,7 @@
+[program:nginx]
+command=/usr/sbin/nginx
+autostart=true
+autorestart=true
+priority=10
+stdout_events_enabled=true
+stderr_events_enabled=true

deployment/docker/supervisord/pretixtask.conf

@@ -0,0 +1,6 @@
+[program:pretixtask]
+command=/usr/local/bin/pretix taskworker
+autostart=true
+autorestart=true
+priority=5
+user=pretixuser

deployment/docker/supervisord/pretixweb.conf

@@ -0,0 +1,7 @@
+[program:pretixweb]
+command=/usr/local/bin/pretix webworker
+autostart=true
+autorestart=true
+priority=5
+user=pretixuser
+environment=HOME=/pretix

doc/_themes/pretix_theme/static/css/pretix.css

@@ -6099,3 +6099,6 @@ img.screenshot, a.screenshot img {
 .versionchanged p:last-child {
     margin-bottom: 0;
 }
+.rst-content td > .line-block {
+    margin-left: 0 !important;
+}

doc/admin/config.rst

@@ -23,6 +23,14 @@ The config file may contain the following sections (all settings are optional an
 default values). We suggest that you start from the examples given in one of the
 installation tutorials.
 
+.. note::
+
+    The configuration file is the recommended way to configure pretix. However, you can
+    also set them through environment variables. In this case, the syntax is
+    ``PRETIX_SECTION_CONFIG``. For example, to configure the setting ``password_reset``
+    from the ``[pretix]`` section, set ``PRETIX_PRETIX_PASSWORD_RESET=off`` in your
+    environment.
+
 pretix settings
 ---------------
 
@@ -92,9 +100,14 @@ Example::
 
 ``trust_x_forwarded_proto``
     Specifies whether the ``X-Forwarded-Proto`` header can be trusted. Only set to ``on`` if you have a reverse
-    proxy that actively removes and re-adds the header to make sure the correct client IP is the first value.
+    proxy that actively removes and re-adds the header to make sure the correct value is set.
     Defaults to ``off``.
 
+``csp_log``
+    Log violations of the Content Security Policy (CSP). Defaults to ``on``.
+    
+``loglevel``
+    Set console and file log level (``DEBUG``, ``INFO``, ``WARNING``, ``ERROR`` or ``CRITICAL``). Defaults to ``INFO``.
 
 Locale settings
 ---------------
@@ -337,6 +350,15 @@ application. If you want to use sentry, you need to set a DSN in the configurati
     You will be given this value by your sentry installation.
 
 
+Caching
+-------
+
+You can adjust some caching settings to control how much storage pretix uses::
+
+    [cache]
+    tickets=48  ; Number of hours tickets (PDF, passbook, …) are cached
+
+
 Secret length
 -------------
 

doc/admin/index.rst

@@ -12,3 +12,4 @@ This documentation is for everyone who wants to install pretix on a server.
    config
    maintainance
    scaling
+   indexes

doc/admin/indexes.rst

@@ -0,0 +1,73 @@
+Additional database indices
+===========================
+
+If you have a large pretix database, some features such as search for orders or events might turn pretty slow.
+For PostgreSQL, we have compiled a list of additional database indexes that you can add to speed things up.
+Just like any index, they in turn make write operations insignificantly slower and cause the database to use
+more disk space.
+
+The indexes aren't automatically created by pretix since Django does not allow us to do so only on PostgreSQL
+(and they won't work on other databases). Also, they're really not necessary if you're not having tens of
+thousands of records in your database.
+
+However, this also means they won't automatically adapt if some of the referred fields change in future updates of pretix
+and you might need to re-check this page and change them manually.
+
+Here is the currently recommended set of commands::
+
+    CREATE EXTENSION pg_trgm;
+
+    CREATE INDEX CONCURRENTLY pretix_addidx_event_slug
+        ON pretixbase_event
+        USING gin (upper("slug") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_event_name
+        ON pretixbase_event
+        USING gin (upper("name") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_order_code
+        ON pretixbase_order
+        USING gin (upper("code") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_voucher_code
+        ON pretixbase_voucher
+        USING gin (upper("code") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_invoice_nu1
+        ON "pretixbase_invoice" (UPPER("invoice_no"));
+    CREATE INDEX CONCURRENTLY pretix_addidx_invoice_nu2
+        ON "pretixbase_invoice" (UPPER("full_invoice_no"));
+    CREATE INDEX CONCURRENTLY pretix_addidx_organizer_name
+        ON pretixbase_organizer
+        USING gin (upper("name") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_organizer_slug
+        ON pretixbase_organizer
+        USING gin (upper("slug") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_order_email
+        ON pretixbase_order
+        USING gin (upper("email") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_order_comment
+        ON pretixbase_order
+        USING gin (upper("comment") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_name
+        ON pretixbase_orderposition
+        USING gin (upper("attendee_name_cached") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_scret
+        ON pretixbase_orderposition
+        USING gin (upper("secret") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_email
+        ON pretixbase_orderposition
+        USING gin (upper("attendee_email") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_ia_name
+        ON pretixbase_invoiceaddress
+        USING gin (upper("name_cached") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_ia_company
+        ON pretixbase_invoiceaddress
+        USING gin (upper("company") gin_trgm_ops);
+
+
+Also, if you use our ``pretix-shipping`` plugin::
+
+    CREATE INDEX CONCURRENTLY pretix_addidx_sa_name
+        ON pretix_shipping_shippingaddress
+        USING gin (upper("name") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_sa_company
+        ON pretix_shipping_shippingaddress
+        USING gin (upper("company") gin_trgm_ops);
+

doc/admin/installation/docker_smallscale.rst

@@ -26,7 +26,7 @@ installation guides):
 * `Docker`_
 * A SMTP server to send out mails, e.g. `Postfix`_ on your machine or some third-party server you have credentials for
 * A HTTP reverse proxy, e.g. `nginx`_ or Apache to allow HTTPS connections
-* A `PostgreSQL`_, `MySQL`_ 5.7+, or MariaDB 10.2.7+ database server
+* A `PostgreSQL`_ 9.5+, `MySQL`_ 5.7+, or MariaDB 10.2.7+ database server
 * A `redis`_ server
 
 We also recommend that you use a firewall, although this is not a pretix-specific recommendation. If you're new to
@@ -284,13 +284,31 @@ Then, go to that directory and build the image::
 You can now use that image ``mypretix`` instead of ``pretix/standalone`` in your service file (see above). Be sure
 to re-build your custom image after you pulled ``pretix/standalone`` if you want to perform an update.
 
+Scaling up
+----------
+
+If you need to scale to multiple machines, please first read our :ref:`scaling guide <scaling>`.
+
+If you run the official docker container on multiple machines, it is recommended to set the environment
+variable ``AUTOMIGRATE=skip`` on all containers and run ``docker exec -it pretix.service pretix migrate``
+on one machine after each upgrade manually, otherwise multiple containers might try to upgrade the
+database schema at the same time.
+
+To run only the ``pretix-web`` component of pretix as well as a nginx server serving static files, you
+can invoke the container with ``docker run … pretix/standalone:stable web`` (instead of ``all``).
+
+To run only ``pretix-worker``, you can run ``docker run … pretix/standalone:stable taskworker``. You can
+also pass arguments to limit the worker to specific queues or to change the number of concurrent task
+workers, e.g. ``docker run … taskworker -Q notifications --concurrency 32``.
+
+
 .. _Docker: https://docs.docker.com/engine/installation/linux/debian/
 .. _Postfix: https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-postfix-as-a-send-only-smtp-server-on-ubuntu-16-04
 .. _nginx: https://botleg.com/stories/https-with-lets-encrypt-and-nginx/
 .. _Let's Encrypt: https://letsencrypt.org/
 .. _pretix.eu: https://pretix.eu/
 .. _MySQL: https://dev.mysql.com/doc/refman/5.7/en/linux-installation-apt-repo.html
-.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-9-4-on-debian-8
+.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-20-04
 .. _redis: https://blog.programster.org/debian-8-install-redis-server/
 .. _ufw: https://en.wikipedia.org/wiki/Uncomplicated_Firewall
 .. _redis website: https://redis.io/topics/security

doc/admin/installation/manual_smallscale.rst

@@ -23,7 +23,7 @@ installation guides):
 
 * A SMTP server to send out mails, e.g. `Postfix`_ on your machine or some third-party server you have credentials for
 * A HTTP reverse proxy, e.g. `nginx`_ or Apache to allow HTTPS connections
-* A `PostgreSQL`_, `MySQL`_ 5.7+, or MariaDB 10.2.7+ database server
+* A `PostgreSQL`_ 9.5+, `MySQL`_ 5.7+, or MariaDB 10.2.7+ database server
 * A `redis`_ server
 
 We also recommend that you use a firewall, although this is not a pretix-specific recommendation. If you're new to
@@ -308,7 +308,7 @@ example::
 .. _Let's Encrypt: https://letsencrypt.org/
 .. _pretix.eu: https://pretix.eu/
 .. _MySQL: https://dev.mysql.com/doc/refman/5.7/en/linux-installation-apt-repo.html
-.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-9-4-on-debian-8
+.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-20-04
 .. _redis: https://blog.programster.org/debian-8-install-redis-server/
 .. _ufw: https://en.wikipedia.org/wiki/Uncomplicated_Firewall
 .. _strong encryption settings: https://mozilla.github.io/server-side-tls/ssl-config-generator/

doc/admin/maintainance.rst

@@ -92,7 +92,8 @@ pretix_task_duration_seconds
 
 pretix_model_instances
     Gauge. Measures number of instances of a certain model within the database, labeled with
-    the ``model`` name.
+    the ``model`` name. Starting with pretix 3.11, these numbers might only be approximate for
+    most tables when running on PostgreSQL to mitigate performance impact.
 
 .. _metric types: https://prometheus.io/docs/concepts/metric_types/
 .. _Prometheus: https://prometheus.io/

doc/api/deviceauth.rst

@@ -49,11 +49,15 @@ information on your device as well as your API token:
        "device_id": 5,
        "unique_serial": "HHZ9LW9JWP390VFZ",
        "api_token": "1kcsh572fonm3hawalrncam4l1gktr2rzx25a22l8g9hx108o9oi0rztpcvwnfnd",
-       "name": "Bar"
+       "name": "Bar",
+       "gate": {
+           "id": 3,
+           "name": "South entrance"
+       }
    }
 
 Please make sure that you store this ``api_token`` value. We also recommend storing your device ID, your assigned
-``unique_serial``, and the ``organizer`` you have access to, but that's up to you.
+``unique_serial``, and the ``organizer`` you have access to, but that's up to you. ``gate`` might be ``null``.
 
 In case of an error, the response will look like this:
 
@@ -98,6 +102,8 @@ following endpoint:
        "software_version": "4.1.0"
    }
 
+You will receive a response equivalent to the response of your initialization request.
+
 Creating a new API key
 ----------------------
 
@@ -126,12 +132,65 @@ invalidate your API key. There is no way to reverse this operation.
 
 This can also be done by the user through the web interface.
 
-Permissions
------------
+Permissions & security profiles
+-------------------------------
 
 Device authentication is currently hardcoded to grant the following permissions:
 
 * View event meta data and products etc.
-* View and change orders
+* View orders
+* Change orders
+* Manage gift cards
 
 Devices cannot change events or products and cannot access vouchers.
+
+Additionally, when creating a device through the user interface or API, a user can specify a "security profile" for
+the device. These include an allow list of specific API calls that may be made by the device. pretix ships with security
+policies for official pretix apps like pretixSCAN and pretixPOS.
+
+Removing a device
+-----------------
+
+If you want implement a way to to deprovision a device in your software, you can call the ``revoke`` endpoint to
+invalidate your API key. There is no way to reverse this operation.
+
+.. sourcecode:: http
+
+   POST /api/v1/device/revoke HTTP/1.1
+   Host: pretix.eu
+   Authorization: Device 1kcsh572fonm3hawalrncam4l1gktr2rzx25a22l8g9hx108o9oi0rztpcvwnfnd
+
+This can also be done by the user through the web interface.
+
+Event selection
+---------------
+
+In most cases, your application should allow the user to select the event and check-in list they work with manually
+from a list. However, in some cases it is required to automatically configure the device for the correct event, for
+example in a kiosk-like situation where nobody is operating the device. In this case, the app can query the server
+for a suggestion which event should be used. You can also submit the configuration that is currently in use via
+query parameters:
+
+.. sourcecode:: http
+
+   GET /api/v1/device/eventselection?current_event=democon&current_subevent=42&current_checkinlist=542 HTTP/1.1
+   Host: pretix.eu
+   Authorization: Device 1kcsh572fonm3hawalrncam4l1gktr2rzx25a22l8g9hx108o9oi0rztpcvwnfnd
+
+You can get three response codes:
+
+* ``304`` The server things you already selected a good event
+* ``404`` The server has not found a suggestion for you
+* ``200`` The server suggests a new event (body see below)
+
+.. sourcecode:: http
+
+   HTTP/1.1 200 OK
+   Content-Type: application/json
+
+   {
+      "event": "democon",
+      "subevent": 23,
+      "checkinlist": 5
+   }
+

doc/api/index.rst

@@ -7,9 +7,6 @@ This part of the documentation contains information about the REST-style API
 exposed by pretix since version 1.5 that can be used by third-party programs
 to interact with pretix and its data structures.
 
-Currently, the API provides mostly read-only capabilities, but it will be extended
-in functionality over time.
-
 .. toctree::
    :maxdepth: 2
 

doc/api/oauth.rst

@@ -25,7 +25,7 @@ Obtaining an authorization grant
 --------------------------------
 
 To authorize a new user, link or redirect them to the ``authorize`` endpoint, passing your client ID as a query
-parameter. Additionally, you can pass a scope (currently either ``read``, ``write``, or ``read write``)
+parameter. Additionally, you can pass a scope (currently either ``read``, ``write``, ``read write`` or ``profile``)
 and an URL the user should be redirected to after successful or failed authorization. You also need to pass the
 ``response_type`` parameter with a value of ``code``. Example::
 
@@ -47,11 +47,9 @@ You will need this ``code`` parameter to perform the next step.
 
 On a failed registration, a query string like ``?error=access_denied`` will be appended to the redirection URL.
 
-.. note:: In this step, the user is allowed to restrict your access to certain organizer accounts. If you try to
-          re-authenticate the user later, the user might be instantly redirected back to you if authorization is already
-          given and would therefore be unable to review their organizer restriction settings. You can append the
-          ``approval_prompt=force`` query parameter if you want to make sure the user actively needs to confirm the
-          authorization.
+.. note:: By default, the user is asked to give permission on every call to this URL. If you **only** request the
+          ``profile`` scope, i.e. no access to organizer data, you can pass the ``approval_prompt=auto`` parameter
+          to skip user interaction on subsequent calls.
 
 Getting an access token
 -----------------------
@@ -193,10 +191,11 @@ If you need the user's meta data, you can fetch it here:
       Content-Type: application/json
 
       {
-        email: "admin@localhost",
-        fullname: "John Doe",
-        locale: "de",
-        timezone: "Europe/Berlin"
+        "email": "admin@localhost",
+        "fullname": "John Doe",
+        "locale": "de",
+        "is_staff": false,
+        "timezone": "Europe/Berlin"
       }
 
    :statuscode 200: no error

doc/api/resources/checkinlists.rst

@@ -30,6 +30,10 @@ position_count                        integer                    Number of ticke
 checkin_count                         integer                    Number of check-ins performed on this list (read-only).
 include_pending                       boolean                    If ``true``, the check-in list also contains tickets from orders in pending state.
 auto_checkin_sales_channels           list of strings            All items on the check-in list will be automatically marked as checked-in when purchased through any of the listed sales channels.
+allow_multiple_entries                boolean                    If ``true``, subsequent scans of a ticket on this list should not show a warning but instead be stored as an additional check-in.
+allow_entry_after_exit                boolean                    If ``true``, subsequent scans of a ticket on this list are valid if the last scan of the ticket was an exit scan.
+rules                                 object                     Custom check-in logic. The contents of this field are currently not considered a stable API and modifications through the API are highly discouraged.
+exit_all_at                           datetime                   Automatically check out (i.e. perform an exit scan) at this point in time. After this happened, this property will automatically be set exactly one day into the future. Note that this field is considered "internal configuration" and if you pull the list with ``If-Modified-Since``, the daily change in this field will not trigger a response.
 ===================================== ========================== =======================================================
 
 .. versionchanged:: 1.10
@@ -48,6 +52,19 @@ auto_checkin_sales_channels           list of strings            All items on th
 
     The ``auto_checkin_sales_channels`` field has been added.
 
+.. versionchanged:: 3.9
+
+    The ``subevent`` attribute may now be ``null`` inside event series. The ``allow_multiple_entries``,
+    ``allow_entry_after_exit``, and ``rules`` attributes have been added.
+
+.. versionchanged:: 3.11
+
+    The ``subevent_match`` and ``exclude`` query parameters have been added.
+
+.. versionchanged:: 3.12
+
+    The ``exit_all_at`` attribute has been added.
+
 Endpoints
 ---------
 
@@ -89,6 +106,10 @@ Endpoints
             "limit_products": [],
             "include_pending": false,
             "subevent": null,
+            "allow_multiple_entries": false,
+            "allow_entry_after_exit": true,
+            "exit_all_at": null,
+            "rules": {},
             "auto_checkin_sales_channels": [
               "pretixpos"
             ]
@@ -98,6 +119,8 @@ Endpoints
 
    :query integer page: The page number in case of a multi-page result set, default is 1
    :query integer subevent: Only return check-in lists of the sub-event with the given ID
+   :query integer subevent_match: Only return check-in lists that are valid for the sub-event with the given ID (i.e. also lists valid for all subevents)
+   :query string exclude: Exclude a field from the output, e.g. ``checkin_count``. Can be used as a performance optimization. Can be passed multiple times.
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
    :statuscode 200: no error
@@ -133,6 +156,10 @@ Endpoints
         "limit_products": [],
         "include_pending": false,
         "subevent": null,
+        "allow_multiple_entries": false,
+        "allow_entry_after_exit": true,
+        "exit_all_at": null,
+        "rules": {},
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -168,6 +195,7 @@ Endpoints
       {
         "checkin_count": 17,
         "position_count": 42,
+        "inside_count": 12,
         "event": {
           "name": "Demo Conference"
         },
@@ -229,6 +257,8 @@ Endpoints
         "all_products": false,
         "limit_products": [1, 2],
         "subevent": null,
+        "allow_multiple_entries": false,
+        "allow_entry_after_exit": true,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -251,6 +281,8 @@ Endpoints
         "limit_products": [1, 2],
         "include_pending": false,
         "subevent": null,
+        "allow_multiple_entries": false,
+        "allow_entry_after_exit": true,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -303,6 +335,8 @@ Endpoints
         "limit_products": [1, 2],
         "include_pending": false,
         "subevent": null,
+        "allow_multiple_entries": false,
+        "allow_entry_after_exit": true,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -582,6 +616,7 @@ Order position endpoints
    :<json datetime datetime: Specifies the datetime of the check-in. If not supplied, the current time will be used.
    :<json boolean force: Specifies that the check-in should succeed regardless of previous check-ins or required
                          questions that have not been filled. Defaults to ``false``.
+   :<json string type: Send ``"exit"`` for an exit and ``"entry"`` (default) for an entry.
    :<json boolean ignore_unpaid: Specifies that the check-in should succeed even if the order is in pending state.
                                  Defaults to ``false`` and only works when ``include_pending`` is set on the check-in
                                  list.
@@ -696,6 +731,7 @@ Order position endpoints
      ``canceled_supported`` to ``true``, otherwise these orders return ``unpaid``.
    * ``already_redeemed`` - Ticket already has been redeemed
    * ``product`` - Tickets with this product may not be scanned at this device
+   * ``rules`` - Check-in prevented by a user-defined rule
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch

doc/api/resources/devices.rst

@@ -0,0 +1,224 @@
+.. spelling:: fullname
+
+.. _`rest-devices`:
+
+Devices
+=======
+
+See also :ref:`rest-deviceauth`.
+
+Device resource
+----------------
+
+The device resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+device_id                             integer                    Internal ID of the device within this organizer
+unique_serial                         string                     Unique identifier of this device
+name                                  string                     Device name
+all_events                            boolean                    Whether this device has access to all events
+limit_events                          list                       List of event slugs this device has access to
+hardware_brand                        string                     Device hardware manufacturer (read-only)
+hardware_model                        string                     Device hardware model (read-only)
+software_brand                        string                     Device software product (read-only)
+software_version                      string                     Device software version (read-only)
+created                               datetime                   Creation time
+initialized                           datetime                   Time of initialization (or ``null``)
+initialization_token                  string                     Token for initialization
+revoked                               boolean                    Whether this device no longer has access
+security_profile                      string                     The name of a supported security profile restricting API access
+===================================== ========================== =======================================================
+
+Device endpoints
+----------------
+
+.. http:get:: /api/v1/organizers/(organizer)/devices/
+
+   Returns a list of all devices within a given organizer.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/devices/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "device_id": 1,
+            "unique_serial": "UOS3GNZ27O39V3QS",
+            "initialization_token": "frkso3m2w58zuw70",
+            "all_events": false,
+            "limit_events": [
+              "museum"
+            ],
+            "revoked": false,
+            "name": "Scanner",
+            "created": "2020-09-18T14:17:40.971519Z",
+            "initialized": "2020-09-18T14:17:44.190021Z",
+            "security_profile": "full",
+            "hardware_brand": "Zebra",
+            "hardware_model": "TC25",
+            "software_brand": "pretixSCAN",
+            "software_version": "1.5.1"
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:get:: /api/v1/organizers/(organizer)/devices/(device_id)/
+
+   Returns information on one device, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/devices/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "device_id": 1,
+        "unique_serial": "UOS3GNZ27O39V3QS",
+        "initialization_token": "frkso3m2w58zuw70",
+        "all_events": false,
+        "limit_events": [
+          "museum"
+        ],
+        "revoked": false,
+        "name": "Scanner",
+        "created": "2020-09-18T14:17:40.971519Z",
+        "initialized": "2020-09-18T14:17:44.190021Z",
+        "security_profile": "full",
+        "hardware_brand": "Zebra",
+        "hardware_model": "TC25",
+        "software_brand": "pretixSCAN",
+        "software_version": "1.5.1"
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param device_id: The ``device_id`` field of the device to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:post:: /api/v1/organizers/(organizer)/devices/
+
+   Creates a new device
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/devices/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "name": "Scanner",
+        "all_events": true,
+        "limit_events": [],
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "device_id": 1,
+        "unique_serial": "UOS3GNZ27O39V3QS",
+        "initialization_token": "frkso3m2w58zuw70",
+        "all_events": true,
+        "limit_events": [],
+        "revoked": false,
+        "name": "Scanner",
+        "created": "2020-09-18T14:17:40.971519Z",
+        "security_profile": "full",
+        "initialized": null
+        "hardware_brand": null,
+        "hardware_model": null,
+        "software_brand": null,
+        "software_version": null
+      }
+
+   :param organizer: The ``slug`` field of the organizer to create a device for
+   :statuscode 201: no error
+   :statuscode 400: The device could not be created due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to create this resource.
+
+.. http:patch:: /api/v1/organizers/(organizer)/devices/(device_id)/
+
+   Update a device.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/devices/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "name": "Foo"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "name": "Foo",
+        ...
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param device_id: The ``device_id`` field of the device to modify
+   :statuscode 200: no error
+   :statuscode 400: The device could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to change this resource.
+

doc/api/resources/events.rst

@@ -44,6 +44,9 @@ seat_category_mapping                 object                     An object mappi
                                                                  (strings) to items in the event (integers or ``null``).
 timezone                              string                     Event timezone name
 item_meta_properties                  object                     Item-specific meta data parameters and default values.
+valid_keys                            object                     Cryptographic keys for non-default signature schemes.
+                                                                 For performance reason, value is omitted in lists and
+                                                                 only contained in detail views. Value can be cached.
 ===================================== ========================== =======================================================
 
 
@@ -84,6 +87,10 @@ item_meta_properties                  object                     Item-specific m
 
    The attribute ``item_meta_properties`` has been added.
 
+.. versionchanged:: 3.12
+
+   The attribute ``valid_keys`` has been added.
+
 Endpoints
 ---------
 
@@ -144,7 +151,7 @@ Endpoints
               "pretix.plugins.stripe"
               "pretix.plugins.paypal"
               "pretix.plugins.ticketoutputpdf"
-            ]
+            ],
           }
         ]
       }
@@ -216,7 +223,12 @@ Endpoints
           "pretix.plugins.stripe"
           "pretix.plugins.paypal"
           "pretix.plugins.ticketoutputpdf"
-        ]
+        ],
+        "valid_keys": {
+          "pretix_sig1": [
+            "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUNvd0JRWURLMlZ3QXlFQTdBRDcvdkZBMzNFc1k0ejJQSHI3aVpQc1o4bjVkaDBhalA4Z3l6Tm1tSXM9Ci0tLS0tRU5EIFBVQkxJQyBLRVktLS0tLQo="
+          ]
+        }
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -472,7 +484,7 @@ Endpoints
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to create this resource.
 
 
-.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/items/(id)/
+.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/
 
    Delete an event. Note that events with orders cannot be deleted to ensure data integrity.
 
@@ -526,7 +538,7 @@ information about the properties.
 
    Get current values of event settings.
 
-   Permission required: "Can change event settings"
+   Permission required: "Can change event settings" (Exception: with device auth, *some* settings can always be *read*.)
 
    **Example request**:
 

doc/api/resources/exporters.rst

@@ -0,0 +1,215 @@
+.. spelling:: checkin
+
+Data exporters
+==============
+
+pretix and it's plugins include a number of data exporters that allow you to bulk download various data from pretix in
+different formats. This page shows you how to use these exporters through the API.
+
+.. versionchanged:: 3.13
+
+   This feature has been added to the API.
+
+.. warning::
+
+   While we consider the methods listed on this page to be a stable API, the availability and specific input field
+   requirements of individual exporters is **not considered a stable API**. Specific exporters and their input parameters
+   may change at any time without warning.
+
+Listing available exporters
+---------------------------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/exporters/
+
+   Returns a list of all exporters available for a given event. You will receive a list of export methods as well as their
+   supported input fields. Note that the exact type and validation requirements of the input fields are not given in the
+   response, and you might need to look into the pretix web interface to figure out the exact input required.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/exporters/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "identifier": "orderlist",
+            "verbose_name": "Order data",
+            "input_parameters": [
+              {
+                "name": "_format",
+                "required": true,
+                "choices": [
+                  "xlsx",
+                  "orders:default",
+                  "orders:excel",
+                  "orders:semicolon",
+                  "positions:default",
+                  "positions:excel",
+                  "positions:semicolon",
+                  "fees:default",
+                  "fees:excel",
+                  "fees:semicolon"
+                ]
+              },
+              {
+                "name": "paid_only",
+                "required": false
+              }
+            ]
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
+.. http:get:: /api/v1/organizers/(organizer)/exporters/
+
+   Returns a list of all cross-event exporters available for a given organizer. You will receive a list of export methods as well as their
+   supported input fields. Note that the exact type and validation requirements of the input fields are not given in the
+   response, and you might need to look into the pretix web interface to figure out the exact input required.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/exporters/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "identifier": "orderlist",
+            "verbose_name": "Order data",
+            "input_parameters": [
+              {
+                "name": "events",
+                "required": true
+              },
+              {
+                "name": "_format",
+                "required": true,
+                "choices": [
+                  "xlsx",
+                  "orders:default",
+                  "orders:excel",
+                  "orders:semicolon",
+                  "positions:default",
+                  "positions:excel",
+                  "positions:semicolon",
+                  "fees:default",
+                  "fees:excel",
+                  "fees:semicolon"
+                ]
+              },
+              {
+                "name": "paid_only",
+                "required": false
+              }
+            ]
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
+Running an export
+-----------------
+
+Since exports often include large data sets, they might take longer than the duration of an HTTP request. Therefore,
+creating an export is a two-step process. First you need to start an export task with one of the following to API
+endpoints:
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/exporters/(identifier)/run/
+
+   Starts an export task. If your input parameters validate correctly, a ``202 Accepted`` status code is returned.
+   The body points you to the download URL of the result.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/exporters/orderlist/run/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "_format": "xlsx"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "download": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderlist/download/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/"
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param identifier: The ``identifier`` field of the exporter to run
+   :statuscode 202: no error
+   :statuscode 400: Invalid input options
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
+.. http:post:: /api/v1/organizers/(organizer)/exporters/(identifier)/run/
+
+   The endpoint for organizer-level exports works just like event-level exports (see above).
+
+
+Downloading the result
+----------------------
+
+When starting an export, you receive a ``url`` for downloading the result. Running a ``GET`` request on that result will
+yield one of the following status codes:
+
+* ``200 OK`` – The export succeeded. The body will be your resulting file. Might be large!
+* ``409 Conflict`` – Your export is still running. The body will be JSON with the structure ``{"status": "running", "percentage": 40}``. ``percentage`` can be ``null`` if it is not known and ``status`` can be ``waiting`` before the task is actually being processed. Please retry, but wait at least one second before you do.
+* ``410 Gone`` – Running the export has failed permanently. The body will be JSON with the structure ``{"status": "failed", "message": "Error message"}``
+* ``404 Not Found`` – The export does not exist / is expired.
+
+.. warning::
+
+   Running exports puts a lot of stress on the system, we kindly ask you not to run more than two exports at the same time.
+

doc/api/resources/giftcards.rst

@@ -209,14 +209,15 @@ Endpoints
 
    .. sourcecode:: http
 
-      PATCH /api/v1/organizers/bigevents/giftcards/1/transact/ HTTP/1.1
+      POST /api/v1/organizers/bigevents/giftcards/1/transact/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
       Content-Type: application/json
-      Content-Length: 94
+      Content-Length: 79
 
       {
-        "value": "2.00"
+        "value": "2.00",
+        "text": "Optional value explaining the transaction"
       }
 
    **Example response**:

doc/api/resources/index.rst

@@ -24,7 +24,9 @@ Resources and endpoints
    giftcards
    carts
    teams
+   devices
    webhooks
    seatingplans
+   exporters
    billing_invoices
    billing_var

doc/api/resources/item_add-ons.rst

@@ -24,6 +24,7 @@ addon_category                        integer                    Internal ID of
 min_count                             integer                    The minimal number of add-ons that need to be chosen.
 max_count                             integer                    The maximal number of add-ons that can be chosen.
 position                              integer                    An integer, used for sorting
+multi_allowed                         boolean                    Adding the same item multiple times is allowed
 price_included                        boolean                    Adding this add-on to the item is free
 ===================================== ========================== =======================================================
 
@@ -65,6 +66,7 @@ Endpoints
             "min_count": 0,
             "max_count": 10,
             "position": 0,
+            "multi_allowed": false,
             "price_included": true
           },
           {
@@ -73,6 +75,7 @@ Endpoints
             "min_count": 0,
             "max_count": 10,
             "position": 1,
+            "multi_allowed": false,
             "price_included": true
           }
         ]
@@ -112,6 +115,7 @@ Endpoints
         "min_count": 0,
         "max_count": 10,
         "position": 1,
+        "multi_allowed": false,
         "price_included": true
       }
 
@@ -141,6 +145,7 @@ Endpoints
         "min_count": 0,
         "max_count": 10,
         "position": 1,
+        "multi_allowed": false,
         "price_included": true
       }
 
@@ -158,6 +163,7 @@ Endpoints
         "min_count": 0,
         "max_count": 10,
         "position": 1,
+        "multi_allowed": false,
         "price_included": true
       }
 
@@ -206,6 +212,7 @@ Endpoints
         "min_count": 0,
         "max_count": 10,
         "position": 1,
+        "multi_allowed": false,
         "price_included": true
       }
 

doc/api/resources/items.rst

@@ -104,6 +104,7 @@ addons                                list of objects            Definition of a
 ├ min_count                           integer                    The minimal number of add-ons that need to be chosen.
 ├ max_count                           integer                    The maximal number of add-ons that can be chosen.
 ├ position                            integer                    An integer, used for sorting
+├ multi_allowed                       boolean                    Adding the same item multiple times is allowed
 └ price_included                      boolean                    Adding this add-on to the item is free
 bundles                               list of objects            Definition of bundles that are included in this item.
                                                                  Only writable during creation,
@@ -159,6 +160,10 @@ meta_data                             object                     Values set for
 
    The attribute ``meta_data`` has been added.
 
+.. versionchanged:: 3.10
+
+   The attribute ``multi_allowed`` has been added to ``addons``.
+
 Notes
 -----
 

doc/api/resources/orders.rst

@@ -155,6 +155,18 @@ last_modified                         datetime                   Last modificati
 
    The ``reactivate`` operation has been added.
 
+.. versionchanged:: 3.10
+
+   The ``search`` query parameter has been added.
+
+.. versionchanged:: 3.11
+
+   The ``exclude`` and ``subevent_after`` query parameter has been added.
+
+.. versionchanged:: 3.13
+
+   The ``subevent_before`` query parameter has been added.
+
 
 .. _order-position-resource:
 
@@ -193,8 +205,10 @@ addon_to                              integer                    Internal ID of
 subevent                              integer                    ID of the date inside an event series this position belongs to (or ``null``).
 pseudonymization_id                   string                     A random ID, e.g. for use in lead scanning apps
 checkins                              list of objects            List of check-ins with this ticket
+├ id                                  integer                    Internal ID of the check-in event
 ├ list                                integer                    Internal ID of the check-in list
 ├ datetime                            datetime                   Time of check-in
+├ type                                string                     Type of scan (defaults to ``entry``)
 └ auto_checked_in                     boolean                    Indicates if this check-in been performed automatically by the system
 downloads                             list of objects            List of ticket download options
 ├ output                              string                     Ticket output provider (e.g. ``pdf``, ``passbook``)
@@ -251,6 +265,10 @@ pdf_data                              object                     Data object req
 
   The attributes ``company``, ``street``, ``zipcode``, ``city``, ``country``, and ``state`` have been added.
 
+.. versionchanged:: 3.9
+
+  The ``checkin.type`` attribute has been added.
+
 .. _order-payment-resource:
 
 Order payment resource
@@ -413,6 +431,7 @@ List of all orders
                 "checkins": [
                   {
                     "list": 44,
+                    "type": "entry",
                     "datetime": "2017-12-25T12:45:23Z",
                     "auto_checked_in": false
                   }
@@ -462,6 +481,7 @@ List of all orders
                            ``last_modified``, and ``status``. Default: ``datetime``
    :query string code: Only return orders that match the given order code
    :query string status: Only return orders in the given order status (see above)
+   :query string search: Only return orders matching a given search query
    :query boolean testmode: Only return orders with ``testmode`` set to ``true`` or ``false``
    :query boolean require_approval: If set to ``true`` or ``false``, only categories with this value for the field
                                     ``require_approval`` will be returned.
@@ -474,6 +494,9 @@ List of all orders
        recommend using this in combination with ``testmode=false``, since test mode orders can vanish at any time and
        you will not notice it using this method.
    :query datetime created_since: Only return orders that have been created since the given date.
+   :query datetime subevent_after: Only return orders that contain a ticket for a subevent taking place after the given date. This is an exclusive after, and it considers the **end** of the subevent (or its start, if the end is not set).
+   :query datetime subevent_before: Only return orders that contain a ticket for a subevent taking place after the given date. This is an exclusive before, and it considers the **start** of the subevent.
+   :query string exclude: Exclude a field from the output, e.g. ``fees`` or ``positions.downloads``. Can be used as a performance optimization. Can be passed multiple times.
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
    :resheader X-Page-Generated: The server time at the beginning of the operation. If you're using this API to fetch
@@ -575,6 +598,7 @@ Fetching individual orders
             "checkins": [
               {
                 "list": 44,
+                "type": "entry",
                 "datetime": "2017-12-25T12:45:23Z",
                 "auto_checked_in": false
               }
@@ -916,7 +940,8 @@ Creating orders
         during order generation and is not respected automatically when the order changes later.)
 
    * ``force`` (optional). If set to ``true``, quotas will be ignored.
-   * ``send_mail`` (optional). If set to ``true``, the same emails will be sent as for a regular order. Defaults to
+   * ``send_mail`` (optional). If set to ``true``, the same emails will be sent as for a regular order, regardless of
+     whether these emails are enabled for certain sales channels. Defaults to
      ``false``.
 
    If you want to use add-on products, you need to set the ``positionid`` fields of all positions manually
@@ -1010,6 +1035,10 @@ Creating orders
 Order state operations
 ----------------------
 
+.. versionchanged:: 3.12
+
+   The ``mark_paid`` operation now takes a ``send_email`` parameter.
+
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/mark_paid/
 
    Marks a pending or expired order as successfully paid.
@@ -1021,6 +1050,11 @@ Order state operations
       POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/mark_paid/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+          "send_email": true
+      }
 
    **Example response**:
 
@@ -1471,6 +1505,7 @@ List of all order positions
             "checkins": [
               {
                 "list": 44,
+                "type": "entry",
                 "datetime": "2017-12-25T12:45:23Z",
                 "auto_checked_in": false
               }
@@ -1576,6 +1611,7 @@ Fetching individual positions
         "checkins": [
           {
             "list": 44,
+            "type": "entry",
             "datetime": "2017-12-25T12:45:23Z",
             "auto_checked_in": false
           }
@@ -1701,6 +1737,10 @@ Order payment endpoints
 
    Payments can now be created through the API.
 
+.. versionchanged:: 3.12
+
+   The ``confirm`` operation now takes a ``send_email`` parameter.
+
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/payments/
 
    Returns a list of all payments for an order.
@@ -1801,7 +1841,10 @@ Order payment endpoints
       Accept: application/json, text/javascript
       Content-Type: application/json
 
-      {"force": false}
+      {
+          "send_email": true,
+          "force": false
+      }
 
    **Example response**:
 
@@ -2225,3 +2268,57 @@ Order refund endpoints
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
    :statuscode 404: The requested order or refund does not exist.
+
+Revoked ticket secrets
+----------------------
+
+With some non-default ticket secret generation methods, a list of revoked ticket secrets is required for proper validation.
+
+.. versionchanged:: 3.12
+
+   Added revocation lists.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/revokedsecrets/
+
+   Returns a list of all revoked secrets within a given event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/revokedsecrets/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+      X-Page-Generated: 2017-12-01T10:00:00Z
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "id": 1234,
+            "secret": "k24fiuwvu8kxz3y1",
+            "created": "2017-12-01T10:00:00Z",
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``secret`` and ``created``. Default: ``-created``
+   :query datetime created_since: Only return revocations that have been created since the given date.
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :resheader X-Page-Generated: The server time at the beginning of the operation. If you're using this API to fetch
+                                differences, this is the value you want to use as ``created_since`` in your next call.
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.

doc/api/resources/quotas.rst

@@ -26,6 +26,8 @@ close_when_sold_out                   boolean                    If ``true``, th
                                                                  again.
 closed                                boolean                    Whether the quota is currently closed (see above
                                                                  field).
+release_after_exit                    boolean                    Whether the quota regains capacity as soon as some tickets
+                                                                 have been scanned at an exit.
 ===================================== ========================== =======================================================
 
 .. versionchanged:: 1.10
@@ -36,6 +38,10 @@ closed                                boolean                    Whether the quo
 
    The attributes ``close_when_sold_out`` and ``closed`` have been added.
 
+.. versionchanged:: 3.10
+
+   The attribute ``release_after_exit`` has been added.
+
 
 Endpoints
 ---------
@@ -283,6 +289,7 @@ Endpoints
         "total_size": 1000,
         "pending_orders": 25,
         "paid_orders": 423,
+        "exited_orders": 0,
         "cart_positions": 7,
         "blocking_vouchers": 126,
         "waiting_list": 0

doc/api/resources/subevents.rst

@@ -39,16 +39,19 @@ geo_lon                               float                      Longitude of th
 item_price_overrides                  list of objects            List of items for which this sub-event overrides the
                                                                  default price
 ├ item                                integer                    The internal item ID
+├ disabled                            boolean                    If ``true``, item should not be available for this sub-event
 └ price                               money (string)             The price or ``null`` for the default price
 variation_price_overrides             list of objects            List of variations for which this sub-event overrides
                                                                  the default price
 ├ variation                           integer                    The internal variation ID
+├ disabled                            boolean                    If ``true``, variation should not be available for this sub-event
 └ price                               money (string)             The price or ``null`` for the default price
 meta_data                             object                     Values set for organizer-specific meta data parameters.
 seating_plan                          integer                    If reserved seating is in use, the ID of a seating
                                                                  plan. Otherwise ``null``.
 seat_category_mapping                 object                     An object mapping categories of the seating plan
                                                                  (strings) to items in the event (integers or ``null``).
+last_modified                         datetime                   Last modification of this object
 ===================================== ========================== =======================================================
 
 .. versionchanged:: 1.7
@@ -74,6 +77,14 @@ seat_category_mapping                 object                     An object mappi
 
    The attributes ``geo_lat`` and ``geo_lon`` have been added.
 
+.. versionchanged:: 3.10
+
+   The ``disabled`` attribute has been added to ``item_price_overrides`` and ``variation_price_overrides``.
+
+.. versionchanged:: 3.12
+
+   The ``last_modified`` attribute has been added.
+
 Endpoints
 ---------
 
@@ -125,6 +136,7 @@ Endpoints
             "item_price_overrides": [
               {
                 "item": 2,
+                "disabled": false,
                 "price": "12.00"
               }
             ],
@@ -141,6 +153,8 @@ Endpoints
    :query ends_after: If set to a date and time, only events that happen during of after the given time are returned.
    :param organizer: The ``slug`` field of a valid organizer
    :param event: The ``slug`` field of the main event
+   :query datetime modified_since: Only return objects that have changed since the given date. Be careful: This does not
+       allow you to know if a subevent was deleted.
    :query array attr[meta_data_key]: By providing the key and value of a meta data attribute, the list of sub-events
         will only contain the sub-events matching the set criteria. Providing ``?attr[Format]=Seminar`` would return
         only those sub-events having set their ``Format`` meta data to ``Seminar``, ``?attr[Format]=`` only those, that
@@ -182,6 +196,7 @@ Endpoints
         "item_price_overrides": [
           {
             "item": 2,
+            "disabled": false,
             "price": "12.00"
           }
         ],
@@ -216,6 +231,7 @@ Endpoints
         "item_price_overrides": [
           {
             "item": 2,
+            "disabled": false,
             "price": "12.00"
           }
         ],
@@ -271,6 +287,7 @@ Endpoints
         "item_price_overrides": [
           {
             "item": 2,
+            "disabled": false,
             "price": "12.00"
           }
         ],
@@ -307,6 +324,7 @@ Endpoints
         "item_price_overrides": [
           {
             "item": 2,
+            "disabled": false,
             "price": "23.42"
           }
         ],
@@ -339,6 +357,7 @@ Endpoints
         "item_price_overrides": [
           {
             "item": 2,
+            "disabled": false,
             "price": "23.42"
           }
         ],
@@ -427,6 +446,7 @@ Endpoints
             "item_price_overrides": [
               {
                 "item": 2,
+                "disabled": false,
                 "price": "12.00"
               }
             ],

doc/api/resources/webhooks.rst

@@ -31,8 +31,10 @@ action_types                          list of strings            A list of actio
 The following values for ``action_types`` are valid with pretix core:
 
     * ``pretix.event.order.placed``
+    * ``pretix.event.order.placed.require_approval``
     * ``pretix.event.order.paid``
     * ``pretix.event.order.canceled``
+    * ``pretix.event.order.reactivated``
     * ``pretix.event.order.expired``
     * ``pretix.event.order.modified``
     * ``pretix.event.order.contact.changed``
@@ -42,6 +44,12 @@ The following values for ``action_types`` are valid with pretix core:
     * ``pretix.event.order.denied``
     * ``pretix.event.checkin``
     * ``pretix.event.checkin.reverted``
+    * ``pretix.event.added``
+    * ``pretix.event.changed``
+    * ``pretix.event.deleted``
+    * ``pretix.subevent.added``
+    * ``pretix.subevent.changed``
+    * ``pretix.subevent.deleted``
 
 Installed plugins might register more valid values.
 

doc/api/webhooks.rst

@@ -70,6 +70,9 @@ and ``checkin_list``.
              only include the minimum amount of data necessary for you to fetch the changed objects from our
              :ref:`rest-api` in an authenticated way.
 
+.. warning:: In very rare cases, you could receive the same webhook notification twice. We try to avoid it, but we
+             prefer it over missing a notification.
+
 If you want to further prevent others from accessing your webhook URL, you can also use `Basic authentication`_ and
 supply the URL to us in the format of ``https://username:password@domain.com/path/``.
 We recommend that you use HTTPS for your webhook URL and might require it in the future. If HTTPS is used, we require

doc/conf.py

@@ -52,6 +52,7 @@ extensions = [
     'sphinx.ext.coverage',
     'sphinxcontrib.httpdomain',
     'sphinxcontrib.images',
+    'sphinxemoji.sphinxemoji',
 ]
 if HAS_PYENCHANT:
     extensions.append('sphinxcontrib.spelling')

doc/development/api/exporter.rst

@@ -29,6 +29,22 @@ that we'll provide in this plugin::
         from .exporter import MyExporter
         return MyExporter
 
+Some exporters might also prove to be useful, when provided on an organizer-level. In order to declare your
+exporter as capable of providing exports spanning multiple events, your plugin should listen for this signal
+and return the subclass of ``pretix.base.exporter.BaseExporter`` that we'll provide in this plugin::
+
+    from django.dispatch import receiver
+
+    from pretix.base.signals import register_multievent_data_exporters
+
+
+    @receiver(register_multievent_data_exporters, dispatch_uid="multieventexporter_myexporter")
+    def register_multievent_data_exporter(sender, **kwargs):
+        from .exporter import MyExporter
+        return MyExporter
+
+If your exporter supports both event-level and multi-event level exports, you will need to listen for both
+signals.
 
 The exporter class
 ------------------

doc/development/api/general.rst

@@ -12,7 +12,8 @@ Core
 
 .. automodule:: pretix.base.signals
    :members: periodic_task, event_live_issues, event_copy_data, email_filter, register_notification_types,
-      item_copy_data, register_sales_channels, register_global_settings, quota_availability, global_email_filter
+      item_copy_data, register_sales_channels, register_global_settings, quota_availability, global_email_filter,
+      register_ticket_secret_generators
 
 Order events
 """"""""""""
@@ -33,7 +34,7 @@ Frontend
 --------
 
 .. automodule:: pretix.presale.signals
-   :members: html_head, html_footer, footer_link, front_page_top, front_page_bottom, front_page_bottom_widget, fee_calculation_for_cart, contact_form_fields, question_form_fields, checkout_confirm_messages, checkout_confirm_page_content, checkout_all_optional, html_page_header, sass_preamble, sass_postamble, render_seating_plan, checkout_flow_steps, position_info, position_info_top, item_description
+   :members: html_head, html_footer, footer_link, front_page_top, front_page_bottom, front_page_bottom_widget, fee_calculation_for_cart, contact_form_fields, question_form_fields, contact_form_fields_overrides, question_form_fields_overrides, checkout_confirm_messages, checkout_confirm_page_content, checkout_all_optional, html_page_header, sass_preamble, sass_postamble, render_seating_plan, checkout_flow_steps, position_info, position_info_top, item_description, global_html_head, global_html_footer, global_html_page_header
 
 
 .. automodule:: pretix.presale.signals
@@ -57,7 +58,7 @@ Backend
 .. automodule:: pretix.control.signals
    :members: nav_event, html_head, html_page_start, quota_detail_html, nav_topbar, nav_global, nav_organizer, nav_event_settings,
              order_info, event_settings_widget, oauth_application_registered, order_position_buttons, subevent_forms,
-             item_formsets, order_search_filter_q
+             item_formsets, order_search_filter_q, order_search_forms
 
 .. automodule:: pretix.base.signals
    :members: logentry_display, logentry_object_link, requiredaction_display, timeline_events
@@ -66,19 +67,13 @@ Vouchers
 """"""""
 
 .. automodule:: pretix.control.signals
-   :members: item_forms
-
-Vouchers
-""""""""
-
-.. automodule:: pretix.control.signals
-   :members: voucher_form_class, voucher_form_html, voucher_form_validation
+   :members: item_forms, voucher_form_class, voucher_form_html, voucher_form_validation
 
 Dashboards
 """"""""""
 
 .. automodule:: pretix.control.signals
-   :members: event_dashboard_widgets, user_dashboard_widgets
+   :members: event_dashboard_widgets, user_dashboard_widgets, event_dashboard_top
 
 Ticket designs
 """"""""""""""

doc/development/api/payment.rst

@@ -126,6 +126,8 @@ The provider class
 
    .. autoattribute:: test_mode_message
 
+   .. autoattribute:: requires_invoice_immediately
+
 
 Additional views
 ----------------

doc/development/api/plugins.rst

@@ -136,7 +136,7 @@ in the ``installed`` method::
             pass  # Your code here
 
 
-Note that ``installed`` will *not* be called if the plugin in indirectly activated for an event
+Note that ``installed`` will *not* be called if the plugin is indirectly activated for an event
 because the event is created with settings copied from another event.
 
 Views
@@ -151,8 +151,8 @@ your Django app label.
    with checking that the calling user is logged in, has appropriate permissions,
    etc. We plan on providing native support for this in a later version.
 
-.. _Django app: https://docs.djangoproject.com/en/1.7/ref/applications/
-.. _signal dispatcher: https://docs.djangoproject.com/en/1.7/topics/signals/
-.. _namespace packages: http://legacy.python.org/dev/peps/pep-0420/
+.. _Django app: https://docs.djangoproject.com/en/3.0/ref/applications/
+.. _signal dispatcher: https://docs.djangoproject.com/en/3.0/topics/signals/
+.. _namespace packages: https://legacy.python.org/dev/peps/pep-0420/
 .. _entry point: https://setuptools.readthedocs.io/en/latest/pkg_resources.html#locating-plugins
 .. _cookiecutter: https://cookiecutter.readthedocs.io/en/latest/

doc/development/contribution/style.rst

@@ -7,7 +7,7 @@ Coding style and quality
   for more information. Use four spaces for indentation.
 
 * We sort our imports by a certain schema, but you don't have to do this by hand. Again, ``setup.cfg`` contains
-  some definitions that allow the command ``isort -rc <directory>`` to automatically sort the imports in your source
+  some definitions that allow the command ``isort <directory>`` to automatically sort the imports in your source
   files.
 
 * For templates and models, please take a look at the `Django Coding Style`_. We like Django's `class-based views`_ and

doc/development/setup.rst

@@ -98,7 +98,7 @@ pull request nevertheless and ask us for help, we are happy to assist you.
 Execute the following commands to check for code style errors::
 
     flake8 .
-    isort -c -rc .
+    isort -c .
     python manage.py check
 
 Execute the following command to run pretix' test suite (might take a couple of minutes)::
@@ -117,11 +117,11 @@ for example, to check for any errors in any staged files when committing::
     export GIT_WORK_TREE=../
     export GIT_DIR=../.git
     source ../env/bin/activate  # Adjust to however you activate your virtual environment
-    for file in $(git diff --cached --name-only | grep -E '\.py$' | grep -Ev "migrations|mt940\.py|pretix/settings\.py|make_testdata\.py|testutils/settings\.py|tests/settings\.py|pretix/base/models/__init__\.py")
+    for file in $(git diff --cached --name-only | grep -E '\.py$' | grep -Ev "migrations|mt940\.py|pretix/settings\.py|make_testdata\.py|testutils/settings\.py|tests/settings\.py|pretix/base/models/__init__\.py|.*_pb2\.py")
     do
       echo $file
       git show ":$file" | flake8 - --stdin-display-name="$file" || exit 1 # we only want to lint the staged changes, not any un-staged changes
-      git show ":$file" | isort -df --check-only - | grep ERROR && exit 1 || true
+      git show ":$file" | isort -c - | grep ERROR && exit 1 || true
     done
 
 

doc/plugins/banktransfer.rst

@@ -34,6 +34,8 @@ transactions                          list of objects            Transactions in
 ├ payer                               string                     Payment source
 ├ reference                           string                     Payment reference
 ├ amount                              string                     Payment amount
+├ iban                                string                     Payment IBAN
+├ bic                                 string                     Payment BIC
 ├ date                                string                     Payment date (in **user-inputted** format)
 ├ order                               string                     Associated order code (or ``null``)
 └ comment                             string                     Internal comment
@@ -83,6 +85,8 @@ Endpoints
                 "date": "26.06.2017",
                 "payer": "John Doe",
                 "order": null,
+                "iban": "",
+                "bic": "",
                 "checksum": "5de03a601644dfa63420dacfd285565f8375a8f2",
                 "reference": "GUTSCHRIFT\r\nSAMPLECONF-NAB12 EREF: SAMPLECONF-NAB12\r\nIBAN: DE1234556…",
                 "state": "nomatch",
@@ -132,6 +136,8 @@ Endpoints
             "comment": "",
             "date": "26.06.2017",
             "payer": "John Doe",
+            "iban": "",
+            "bic": "",
             "order": null,
             "checksum": "5de03a601644dfa63420dacfd285565f8375a8f2",
             "reference": "GUTSCHRIFT\r\nSAMPLECONF-NAB12 EREF: SAMPLECONF-NAB12\r\nIBAN: DE1234556…",

doc/plugins/digital.rst

@@ -1,12 +1,86 @@
 Digital content
 ===============
 
+URL interpolation and JWT authentication
+----------------------------------------
+
+In the simplest case, you can use the digital content module to point users to a specific piece of content on some
+platform after their ticket purchase, or show them an embedded video or live stream. However, the full power of the
+module can be utilized by passing additional information to the target system to automatically authenticate the user
+or pre-fill some fields with their data. For example, you could use an URL like this::
+
+    https://webinars.example.com/join?as={attendee_name}&userid={order_code}-{positionid}
+
+While this is already useful, it does not provide much security – anyone could guess a valid combination for that URL.
+Therefore, the module allows you to pass information as a `JSON Web Token`_, which isn't encrypted, but signed with a
+shared secret such that nobody can create their own tokens or modify the contents. To use a token, set up a URL like this::
+
+    https://webinars.example.com/join?with_token={token}
+
+Additionally, you will need to set a JWT secret and a token template, either through the pretix interface or through the
+API (see below). pretix currently only supports tokens signed with ``HMAC-SHA256`` (``HS256``). Your token template can contain
+whatever JSON you'd like to pass on based on the same variables, for example::
+
+    {
+        "iss": "pretix.eu",
+        "aud": "webinars.example.com",
+        "user": {
+            "id": "{order_code}-{positionid}",
+            "product": "{product_id}",
+            "variation": "{variation_id}",
+            "name": "{attendee_name}"
+        }
+    }
+
+Variables can only be used in strings inside the JSON structure.
+pretix will automatically add an ``iat`` claim with the current timestamp and an ``exp`` claim with an expiration timestamp
+based on your configuration.
+
+
+List of variables
+"""""""""""""""""
+
+The following variables are currently supported:
+
+.. rst-class:: rest-resource-table
+
+=================================== ====================================================================
+Variable                            Description
+=================================== ====================================================================
+``order_code``                      Order code (alphanumerical, unique per order, not per ticket)
+``positionid``                      ID of the ticket within the order (integer, starting at 1)
+``order_email``                     E-mail address of the ticket purchaser
+``product_id``                      Internal ID of the purchased product
+``product_variation``               Internal ID of the purchased product variation (or empty)
+``attendee_name``                   Full name of the ticket holder (or empty)
+``attendee_name_*``                 Name parts of the ticket holder, depending on configuration, e.g. ``attendee_name_given_name`` or ``attendee_name_family_name``
+``attendee_email``                  E-mail address of the ticket holder (or empty)
+``attendee_company``                Company of the ticket holder (or empty)
+``attendee_street``                 Street of the ticket holder's address (or empty)
+``attendee_zipcode``                ZIP code of the ticket holder's address (or empty)
+``attendee_city``                   City of the ticket holder's address (or empty)
+``attendee_country``                Country code of the ticket holder's address (or empty)
+``attendee_state``                  State of the ticket holder's address (or empty)
+``answer[XYZ]``                     Answer to the custom question with identifier ``XYZ``
+``invoice_name``                    Full name of the invoice address (or empty)
+``invoice_name_*``                  Name parts of the invoice address, depending on configuration, e.g. ``invoice_name_given_name`` or ``invoice_name_family_name``
+``invoice_company``                 Company of the invoice address (or empty)
+``invoice_street``                  Street of the invoice address (or empty)
+``invoice_zipcode``                 ZIP code of the invoice address (or empty)
+``invoice_city``                    City of the invoice address (or empty)
+``invoice_country``                 Country code of the invoice address (or empty)
+``invoice_state``                   State of the invoice address (or empty)
+``meta_XYZ``                        Value of the event's ``XYZ`` meta property
+``token``                           Signed JWT (only to be used in URLs, not in tokens)
+=================================== ====================================================================
+
+
+API Resource description
+-------------------------
+
 The digital content plugin provides a HTTP API that allows you to create new digital content for your ticket holders,
 such as live streams, videos, or material downloads.
 
-Resource description
---------------------
-
 The digital content resource contains the following public fields:
 
 .. rst-class:: rest-resource-table
@@ -28,10 +102,13 @@ all_products                          boolean                    If ``true``, th
 limit_products                        list of integers           List of product/item IDs. This content is only shown to buyers of these ticket types.
 position                              integer                    An integer, used for sorting
 subevent                              integer                    Date in an event series this content should be shown for. Should be ``null`` if this is not an event series or if this should be shown to all customers.
+jwt_template                          string                     Template for JWT token generation
+jwt_secret                            string                     Secret for JWT token generation
+jwt_validity                          integer                    JWT validity in days
 ===================================== ========================== =======================================================
 
-Endpoints
----------
+API Endpoints
+-------------
 
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/digitalcontents/
 
@@ -275,3 +352,5 @@ Endpoints
    :statuscode 204: no error
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event/content does not exist **or** you have no permission to change it
+
+.. _JSON Web Token: https://en.wikipedia.org/wiki/JSON_Web_Token

doc/plugins/index.rst

@@ -16,3 +16,4 @@ If you want to **create** a plugin, please go to the
    badges
    campaigns
    digital
+   webinar

doc/plugins/webinar.rst

@@ -0,0 +1,43 @@
+pretix Webinar
+==============
+
+Fetch host URLs
+---------------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/webinars/
+
+   Returns a list of all currently available webinar calls configured for an event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/webinars/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      [
+        {
+          "name": "Webinar B – Sept. 8th, 2020",
+          "hosturl": "http://pretix.eu/demo/museum/webinar/host/a9aded3d7bd4df60/30611a34f9fee5d3/"
+        },
+        {
+          "name": "Webinar A – Sept. 8, 2020",
+          "hosturl": "http://pretix.eu/demo/museum/webinar/host/e714x7d4a4a36a04/b9cc444665xxx757/"
+        }
+      ]
+
+   :query subevent: Limit the result to the webinar(s) for a specific subevent.
+   :param organizer: The ``slug`` field of a valid organizer
+   :param event: The ``slug`` field of the event to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer or event does not exist **or** you have no permission to view it.

doc/requirements.txt

@@ -3,7 +3,8 @@ sphinx==2.3.*
 sphinx-rtd-theme
 sphinxcontrib-httpdomain
 sphinxcontrib-images
-sphinxcontrib-spelling
+sphinxcontrib-spelling==4.*
+sphinxemoji
 pygments-markdown-lexer
 # See https://github.com/rfk/pyenchant/pull/130
 git+https://github.com/raphaelm/pyenchant.git@patch-1#egg=pyenchant

doc/spelling_wordlist.txt

@@ -10,7 +10,11 @@ availabilities
 backend
 backends
 banktransfer
+barcode
+barcodes
 Bcc
+bic
+BIC
 boolean
 booleans
 cancelled
@@ -47,13 +51,19 @@ gunicorn
 guid
 hardcoded
 hostname
+iban
+IBAN
+ics
 idempotency
 iframe
 incrementing
 inofficial
 invalidations
+iOS
 iterable
 Jimdo
+jwt
+JWT
 libpretixprint
 libsass
 linters
@@ -88,7 +98,9 @@ prepending
 preprocessor
 presale
 pretix
+pretixSCAN
 pretixdroid
+pretixPOS
 pretixpresale
 prometheus
 proxied

doc/user/events/email.rst

@@ -26,6 +26,9 @@ Sender address
     we strongly recommend to use the SMTP settings below as well, otherwise your e-mails might be detected as spam
     due to the `Sender Policy Framework`_ and similar mechanisms.
 
+Sender name
+    This is the name associated with the sender address. By default, this is your event name.
+
 Signature
     This text will be appended to all e-mails in form of a signature. This might be useful e.g. to add your contact
     details or any legal information that needs to be included with the e-mails.
@@ -33,6 +36,15 @@ Signature
 Bcc address
     This email address will receive a copy of every event-related email.
 
+Attach calendar files
+    With this option, every order confirmation mail will include an ics file with name, date and location of
+    your event. It can be imported into many digital calendars.
+
+Sales Channels for Checkout Emails
+    When you are using multiple sales channel, you may want to decide that mails for order and payment confirmation
+    are only to be sent for some sales channels. For orders created through the default online shop, these emails
+    must always be send. A similar option is available for ticket download reminders.
+
 E-mail design
 -------------
 

doc/user/events/giftcards.rst

@@ -3,6 +3,8 @@
    Warengutschein
    Wertgutschein
 
+.. _giftcards:
+
 Gift cards
 ==========
 

doc/user/events/guides/timeslots.rst

@@ -0,0 +1,94 @@
+.. _timeslots:
+
+Use case: Time slots
+====================
+
+A more advanced use case of pretix is using pretix for time-slot-based access to an area with a limited visitor
+capacity, such as a museum or other attraction. This guide will show you the quickest way to set up such an event
+with pretix.
+
+First of all, when creating your event, you need to select that your event represents an "event series":
+
+
+.. thumbnail:: ../../../screens/event/create_step1.png
+   :align: center
+   :class: screenshot
+
+You can click :ref:`here <subevents>` for a more general description of event series with pretix, but everything you
+need to know is in this chapter as well.
+
+General event setup
+-------------------
+
+Before you go further, set up your products that you want to sell for each time slot, such as different types of entry.
+
+Creating slots
+--------------
+
+To create the time slots, you need to create a number of "dates" in the event series. Select "Dates" in the navigation
+menu on the left side and click "Create many new dates". Then, first enter the pattern of your opening days. In the
+example, the museum is open week Tuesday to Sunday. We recommend to create the slots for a few weeks at a time, but not
+e.g. for a full year, since it will be more complicated to change things later.
+
+.. thumbnail:: ../../../screens/event/timeslots_create.png
+   :align: center
+   :class: screenshot
+
+Then, scroll to the times section and create your time slots. You can do any interval you like. If you have different
+opening times on different week days, you will need to go through the creation process multiple times.
+
+.. thumbnail:: ../../../screens/event/timeslots_create_2.png
+   :align: center
+   :class: screenshot
+
+Scroll further down and create one or multiple quotas that define how many people can book a ticket for that time slot.
+In this example, 50 people in total are allowed to enter within every slot:
+
+.. thumbnail:: ../../../screens/event/timeslots_create_3.png
+   :align: center
+   :class: screenshot
+
+Do **not** create a check-in list at this point. We will deal with this further below in the guide.
+Now, press "Save" to create your slots.
+
+.. warning:: If you create a lot of time slots at once, the server might need a few minutes to create them all in our
+             system. If you receive an error page because it took too long, please do not try again immediately but wait
+             for a few minutes. Most likely, the slots will be created successfully even though you saw an error.
+
+Event settings
+--------------
+
+We recommend that you navigate to "Settings" > "General" > "Display" and set the settings "Default overview style"
+to "Week calendar":
+
+.. thumbnail:: ../../../screens/event/timeslots_settings_1.png
+   :align: center
+   :class: screenshot
+
+Now, your ticket shop should give users a nice weekly overview over all time slots and their availability:
+
+.. thumbnail:: ../../../screens/event/timeslots_presale.png
+   :align: center
+   :class: screenshot
+
+Check-in
+--------
+
+If you want to scan people at the entrance of your event and only admit them at their designated time, we recommend
+the following setup: Go to "Check-in" in the main navigation on the left and create a new check-in list. Give it a name
+and do *not* choose a specific data. We will use one check-in list for all dates. Then, go to the "Advanced" tab at
+the top and set up two restrictions to make sure people can only get in during the time slot they registered for.
+You can create the rules exactly like shown in the following screenshot:
+
+.. thumbnail:: ../../../screens/event/timeslots_checkinlists.png
+   :align: center
+   :class: screenshot
+
+If you want, you can enter a tolerance of e.g. "10" if you want to be a little bit more relaxed and admit people up to
+10 minutes before or after their time slot.
+
+Now, download our `Android or Desktop app`_ and register it to your account. The app will ask you to select one the
+time slots, but it does not matter, you can select any one of them and then select your newly created check-in list.
+That's it, you're good to go!
+
+.. _Android or Desktop app: https://pretix.eu/about/en/scan

doc/user/events/structureguide.rst

@@ -292,6 +292,8 @@ Flexible group sizes
 
 If you want to give out discounted tickets to groups starting at a given size, but still billed per person, you can do so by creating a special **Group ticket** at the per-person price and set the **Minimum amount per order** option of the ticket to the minimal group size.
 
+For more complex use cases, you can also use add-on products that can be chosen multiple times.
+
 This way, your ticket can be bought an arbitrary number of times – but no less than the given minimal amount per order.
 
 Fixed group sizes
@@ -344,3 +346,13 @@ In addition to your normal conference quota, you need to create an unlimited quo
 Then, head to the **Bundled products** tab of the "conference ticket" and add the "conference food" as a bundled product with a **designated price** of € 150.
 
 Once a customer tries to buy the € 450 conference ticket, a sub-product will be added and the price will automatically be split into the two components, leading to a correct computation of taxes.
+
+You can find more use cases in these specialized guides:
+
+More use cases
+--------------
+
+.. toctree::
+   :maxdepth: 1
+
+   guides/timeslots

doc/user/events/ticket_secrets.rst

@@ -0,0 +1,93 @@
+Ticket secret generators
+========================
+
+pretix allows you to change the way in which ticket secrets (also known as "ticket codes", "barcodes", …)
+are generated. This affects the value of the QR code in any tickets issued by pretix, regardless of ticket
+format.
+
+.. note:: This is intended for highly advanced use cases, usually when huge numbers of tickets (> 25k per event)
+          are involved. **If you don't know whether you need this, you probably don't.**
+
+Default: Random secrets
+-----------------------
+
+By default, pretix generates a random code for every ticket, consisting of 32 lower case characters and
+numbers. The characters ``oO1il`` are avoided to reduce confusion when ticket codes are printed and need to
+be typed in manually.
+
+Choosing random codes has a number of advantages:
+
+* Ticket codes are short, which makes QR codes easier to scan. At the same time, it is absolutely impossible to
+  guess or forge a valid ticket code.
+
+* The code does not need to change if the ticket changes. For example, if an attendee is re-booked to a
+  different product or date, they can keep their ticket and it is just mapped to the new product in the
+  database.
+
+This approach works really well for 99 % or events running with pretix.
+The big caveat is that the scanner needs to access a database of all ticket codes in order to know whether a ticket
+code is valid and what kind of ticket it represents.
+
+When scanning online this is no problem at all, since the pretix server always has such a database. In case your local
+internet connection is interrupted or the pretix server goes down, though, there needs to be a database locally on the
+scanner.
+
+Therefore, our pretixSCAN apps by default download the database of all valid tickets onto the device itself. This makes
+it possible to seamlessly switch into offline mode when the connection is lost and continue scanning with the maximum
+possible feature set.
+
+There are a few situations in which this approach is not ideal:
+
+* When running a single event with 25k or more valid tickets, downloading all ticket data onto the scanner may just
+  take too much time and resources.
+
+* When the risk of losing sensible data by losing one of the scanner devices is not acceptable.
+
+* When offline mode needs to be used regularly and newly-purchased tickets need to be valid immediately after purchase,
+  without being able to tolerate a few minutes of delay.
+
+Signature schemes
+-----------------
+
+The alternative approach that is included with pretix is to choose a signature-based ticket code generation scheme.
+These secrets include the most important information that is required for verifying their validity and use modern
+cryptography to make sure they cannot be forged.
+
+Currently, pretix ships with one such scheme ("pretix signature scheme 1") which encodes the product, the product
+variation, and the date (if inside an event series) into the ticket code and signs the code with a `EdDSA`_ signature.
+This allows to verify whether a ticket is allowed to enter without any database or connection to the server, but has
+a few important drawbacks:
+
+* Whenever the product, variation or date of a ticket changes or the ticket is canceled, the ticket code needs to be
+  changed and the old code needs to be put on a revocation list. This revocation list again needs to be downloaded by
+  all scanning devices (but is usually much smaller than the ticket database). The main downside is that the attendee
+  needs to download their new ticket and can no longer use the old one.
+
+* Scanning in offline mode is much more limited, since the scanner has no information about previous usages of the
+  ticket, attendee names, seating information, etc.
+
+Comparison of scanning behavior
+-------------------------------
+
+=============================================== =================================== =================================== =================================== ================================= =====================================
+Scan mode                                       Online                                                                  Offline
+----------------------------------------------- ----------------------------------- -----------------------------------------------------------------------------------------------------------------------------------------------
+Synchronization setting                         any                                 Synchronize orders                                                      Don't synchronize orders
+----------------------------------------------- ----------------------------------- ----------------------------------------------------------------------- -----------------------------------------------------------------------
+Ticket secrets                                  any                                 Random                              Signed                              Random                            Signed
+=============================================== =================================== =================================== =================================== ================================= =====================================
+Scenario supported on platforms                 Android, Desktop, iOS               Android, Desktop, iOS               Android, Desktop                    Android, Desktop                  Android, Desktop
+Synchronization speed for large data sets                                           slow                                slow                                fast                              fast
+Tickets can be scanned                          yes                                 yes                                 yes                                 no                                yes
+Ticket is valid after sale                      immediately                         next sync (~5 minutes)              immediately                         never                             immediately
+Same ticket can be scanned multiple times       no                                  yes, before data is synced          yes, before data is synced          n/a                               yes, always
+Custom check-in rules                           yes                                 yes                                 yes (limited directly after sale)   n/a                               yes, but only based on product,
+                                                                                                                                                                                              variation and date, not on previous
+                                                                                                                                                                                              scans
+Name and seat visible on scanner                yes                                 yes                                 yes (except directly after sale)    n/a                               no
+Order-specific check-in attention flag          yes                                 yes                                 yes (except directly after sale)    n/a                               no
+Ticket search by order code or name             yes                                 yes                                 yes (except directly after sale)    no                                no
+Check-in statistics on scanner                  yes                                 yes                                 mostly accurate                     no                                no
+=============================================== =================================== =================================== =================================== ================================= =====================================
+
+.. _EdDSA: https://en.wikipedia.org/wiki/EdDSA#Ed25519

doc/user/events/tickets.rst

@@ -9,26 +9,33 @@ At "Settings" → "Tickets", you can configure the ticket download options that
 
 The top of this page shows a short list of options relevant for all download formats:
 
-Use feature
+Allow users to download tickets
   This can be used to completely enable or disable ticket downloads all over your ticket shop.
 
+Generate tickets for add-on products
+  By default, tickets can not be downloaded for order positions which are only an add-on to other order positions. If
+  you enable this, this behavior will be changed and add-on products will get their own tickets as well. If disabled,
+  you can still print a list of chosen add-ons e.g. on the PDF tickets.
+
+Generate tickets for all products
+  By default, tickets will only be generated for products that are marked as admission products. Enable this option to
+  generate tickets for all products instead.
+
+Generate tickets for pending orders
+  By default, ticket download is only possible for paid orders. If you run an event where people usually pay only after
+  the event, you can check this box to enable ticket download even before.
+
 Download date
   If you set a date here, no ticket download will be offered before this date. If no date is set, tickets can be
   downloaded immediately after the payment for an order has been received.
 
-Offer to download tickets separately for add-on products
-  By default, tickets can not be downloaded for order positions which are only an add-on to other order positions. If
-  you enable this, this behavior will be changed and add-on products will get their own tickets as well. If disabled,
-  you can still print a list of chosen add-ons e.g. on the PDF tickets.
-
-Generate tickets for non-admission products
-  By default, tickets will only be generated for products that are marked as admission products. Enable this option to
-  generate tickets for all products instead.
-
-Offer to download tickets even before an order is paid
-  By default, ticket download is only possible for paid orders. If you run an event where people usually pay only after
-  the event, you can check this box to enable ticket download even before.
-
 Below these settings, the detail settings for the various ticket file formats are offered. They differ from format to
 format and only share the common "Enable" setting that can be used to turn them on. By default, pretix ships with
-a PDF output plugin that you can configure through a visual design editor.
+a PDF output plugin that you can configure through a visual design editor.
+
+**Advanced topics:**
+
+.. toctree::
+   :maxdepth: 1
+
+   ticket_secrets

doc/user/events/widget.rst

@@ -1,3 +1,5 @@
+.. _widget:
+
 Embeddable Widget
 =================
 
@@ -136,10 +138,15 @@ If you want to include all your public events, you can just reference your organ
 
    <pretix-widget event="https://pretix.eu/demo/"></pretix-widget>
 
-There is an optional ``style`` parameter that let's you choose between a calendar view and a list view. If you do not set it, the choice will be taken from your organizer settings::
+There is an optional ``style`` parameter that let's you choose between a monthly calendar view, a week view and a list
+view. If you do not set it, the choice will be taken from your organizer settings::
 
    <pretix-widget event="https://pretix.eu/demo/series/" style="list"></pretix-widget>
    <pretix-widget event="https://pretix.eu/demo/series/" style="calendar"></pretix-widget>
+   <pretix-widget event="https://pretix.eu/demo/series/" style="week"></pretix-widget>
+
+If you have more than 100 events, the system might refuse to show a list view and always show a calendar for performance
+reasons instead.
 
 You can see an example here:
 

doc/user/faq.rst

@@ -58,28 +58,6 @@ method without creating a new order. If payment deadlines were dependent on the
 forth could either allow someone to extend their deadline forever, or render someones order invalid by moving the date
 back in the past.
 
-How can I revert a check-in?
-----------------------------
-
-Neither our apps nor our web interface can currently undo the check-in of a tickets. We know that this is
-inconvenient for some of you, but we have a good reason for it:
-
-Our Desktop and Android apps both support an asynchronous mode in which they can scan tickets while staying
-independent of their internet connection. When scanning with multiple devices, it can of course happen that two
-devices scan the same ticket without knowing of the other scan. As soon as one of the devices regains connectivity, it
-will upload its activity and the server marks the ticket as checked in -- regardless of the order in which the two
-scans were made and uploaded (which could be two different orders).
-
-If we'd provide a "check out" feature, it would not only be used to fix an accidental scan, but scan at entry and
-exit to count the current number of people inside etc. In this case, the order of operations matters very much for them
-to make sense and provide useful results. This makes implementing an asynchronous mode much more complicated.
-
-In this trade off, we chose offline-capabilities over the check out feature. We plan on solving this problem in the
-future, but we're not there yet.
-
-If you're just *testing* the check-in capabilities and want to clean out everything for the real process, you can just
-delete and re-create the check-in list.
-
 Why does pretix not support any 1D (linear) bar codes?
 ------------------------------------------------------
 

doc/user/glossary.rst

@@ -0,0 +1,181 @@
+Glossary
+========
+
+This page gives definitions of domain-specific terms that we use a lot inside pretix and that might be used slightly
+differently elsewhere, as well as their official translations to other languages. In some cases, things have a different
+name internally, which is noted with a |:wrench:| symbol. If you only use pretix, you'll never see these, but if you're
+going to develop around pretix, for example connect to pretix through our API, you need to know these as well.
+
+
+
+.. rst-class:: rest-resource-table
+
+.. list-table:: Glossary
+   :widths: 15 30
+   :header-rows: 1
+
+   * - Term
+     - Definition
+   * - | |:gb:| **Organizer**
+       | |:de:| Veranstalter
+     - An organizer represents the entity using pretix, usually the company or institution running one or multiple events.
+       In terms of navigation in the system, organizers are the "middle layer" between the system itself and the specific
+       events.
+       Multiple organizers on the same pretix system are fully separated from each other with very few exceptions.
+   * - | |:gb:| **Event**
+       | |:de:| Veranstaltung
+     - An event is the central entity in pretix that you and your customers interact with all the time. An event
+       represents one **shop** in which things like tickets can be bought. Since the introduction of event series (see
+       below), this might include multiple events in the real world.
+
+       Every purchase needs to be connected to an event, and most things are completely separate between different
+       events, i.e. most actions and configurations in pretix are done per-event.
+   * - | |:gb:| **Event series**
+       | |:de:| Veranstaltungsreihe
+     - An event series is one of two types of events. Unlike a non-series event, an event series groups together
+       multiple real-world events into one pretix shop. Examples are time-slot-based booking for a museum, a band on
+       tour, a theater group playing the same play multiple times, etc.
+   * - | |:gb:| **Date**
+       | |:de:| Termin
+       | |:wrench:| Subevent
+     - A date represents a single real-world event inside an event series. Dates can differ from each other in name,
+       date, time, location, pricing, capacity, and seating plans, but otherwise share the same configuration.
+   * - | |:gb:| **Product**
+       | |:de:| Produkt
+       | |:wrench:| Item
+     - A product is anything that can be sold, such as a specific type of ticket or merchandise.
+   * - | |:gb:| **Admission product**
+       | |:de:| Zutrittsprodukt
+     - A product is considered an **admission product** if its purchase represents a person being granted access to your
+       event. This applies to most ticketing products, but not e.g. to merchandise.
+   * - | |:gb:| **Variation**
+       | |:de:| Variante
+       | |:wrench:| Item variation
+     - Some products come in multiple variations that can differ in description, price and capacity. Examples would
+       include "Adult" and "Child" in case of a concert ticket, or "S", "M", "L", … in case of a t-shirt product.
+   * - | |:gb:| **Category**
+       | |:de:| Kategorie
+     - Products can be grouped together in categories. This is mostly to organize them cleanly in the frontend if you
+       have lots of them.
+   * - | |:gb:| **Quota**
+       | |:de:| Kontingent
+     - A quota is a capacity pool that defines how many times a product can be sold. A quota can be connected to multiple
+       products, in which case all of them are counted together. This is useful e.g. if you have full-price and reduced
+       tickets and only want to sell a certain number of tickets in total. The same way, multiple quotas can be connected
+       to the same product, in which case the ticket will be available as long as all of them have capacity left.
+   * - | |:gb:| **Add-on product**
+       | |:de:| Zusatzprodukt
+     - An add-on product is a product that is purchased as an upgrade or optional addition to a different product.
+       Examples would be include a conference ticket that optionally allows to buy a public transport ticket for the
+       same day, or a family ticket for 4 persons that allows you to add additional persons at a small cost, or a
+       "two workshops" package that allows you to select two of a larger number of workshops at a discounted price.
+       In all cases, there is a "main product" (the conference ticket, the family ticket) and a number of "add-on products"
+       that can be chosen from.
+   * - | |:gb:| **Bundled product**
+       | |:de:| Enthaltenes Produkt
+     - A bundled product is a product that is automatically put into the cart when another product is purchased. It's
+       similar to an add-on product, except that the customer has no choice between whether it is added or which of a
+       set of product is added.
+   * - | |:gb:| **Question**
+       | |:de:| Frage
+     - A question is a custom field that customers need to fill in when purchasing a specific product.
+   * - | |:gb:| **Voucher**
+       | |:de:| Gutschein
+     - A voucher is a code that can be used for multiple purposes: To grant a discount to specific customers, to only
+       show certain products to certain customers, or to keep a seat open for someone specific even though you are
+       sold out. If a voucher is used to apply a discount, the price of the purchased product is reduced by the
+       discounted amount. Vouchers are connected to a specific event.
+   * - | |:gb:| **Gift card**
+       | |:de:| Geschenkgutschein
+     - A :ref:`gift card <giftcards>` is a coupon representing an exact amount of money that can be used for purchases
+       of any kind. Gift cards can be sold, created manually, or used as a method to refund your customer without paying
+       them back directly.
+       Unlike a voucher, it does not reduce the price of the purchased products when redeemed, but instead works as a
+       payment method to lower the amount that needs to be paid through other methods. Gift cards are specific to an
+       organizer by default but can even by shared between organizers.
+   * - | |:gb:| **Cart**
+       | |:de:| Warenkorb
+     - A cart is a collection of products that are reserved by a customer who is currently completing the checkout
+       process, but has not yet finished it.
+   * - | |:gb:| **Order**
+       | |:de:| Bestellung
+     - An order is a purchase by a client, containing multiple different products. An order goes through various
+       states and can change during its lifetime.
+   * - | |:gb:| **Order code**
+       | |:de:| Bestellnummer
+     - An order code is the unique identifier of an order, usually consisting of 5 numbers and letters.
+   * - | |:gb:| **Order position**
+       | |:de:| Bestellposition
+     - An order position is a single line inside an order, representing the purchase of one specific product. If the
+       product is an admission product, this represents an attendee.
+   * - | |:gb:| **Attendees**
+       | |:de:| Teilnehmende
+     - An attendee is the person designated to use a specific order position to access the event.
+   * - | |:gb:| **Fee**
+       | |:de:| Gebühr
+     - A fee is an additional type of line inside an order that represents a cost that needs to be paid by the customer,
+       but is not related to a specific product. A typical example is a shipping fee.
+   * - | |:gb:| **Invoice** and **Cancellation**
+       | |:de:| Rechnung und Rechnungskorrektur
+     - An invoice refers to a legal document created to document a purchase for tax purposes. Invoices have individual
+       numbers and no longer change after they have been issued. Every invoice is connected to an order, but an order
+       can have multiple invoices: If an order changes, a cancellation document is created for the old invoice and a
+       new invoice is created.
+   * - | |:gb:| **Check-in**
+       | |:de:| Check-in
+     - A check-in is the event of someone being successfully scanned at an entry or exit of the event.
+   * - | |:gb:| **Check-in list**
+       | |:de:| Check-in-Liste
+     - A check-in list is used to configure who can be scanned at a specific entry or exit of the event. Check-in lists
+       are isolated from each other, so by default each ticket is valid once on every check-in list individually. They
+       are therefore often used to represent *parts* of an event, either time-wise (e.g. conference days) or space-wise
+       (e.g. rooms).
+   * - | |:gb:| **Plugin**
+       | |:de:| Erweiterung
+     - A plugin is an optional software module that contains additional functionality and can be turned on and off per
+       event. If you host pretix on your own server, most plugins need to be installed separately.
+   * - | |:gb:| **Tax rule**
+       | |:de:| Steuer-Regel
+     - A tax rule defines how sales taxes are calculated for a product, possibly depending on type and country of the
+       customer.
+   * - | |:gb:| **Ticket**
+       | |:de:| Ticket
+     - A ticket usually refers to the actual file presented to the customer to be used at check-in, i.e. the PDF or
+       Passbook file carrying the QR code. In some cases, "ticket" may also be used to refer to an order position,
+       especially in case of admission products.
+   * - | |:gb:| **Ticket secret**
+       | |:de:| Ticket-Code
+     - The ticket secret (sometimes "ticket code") is what's contained in the QR code on the ticket.
+   * - | |:gb:| **Badge**
+       | |:de:| Badge
+     - A badge refers to the file used as a name tag for an attendee of your event.
+   * - | |:gb:| **User**
+       | |:de:| Benutzer
+     - A user is anyone who can sign into the backend interface of pretix.
+   * - | |:gb:| **Team**
+       | |:de:| Team
+     - A :ref:`team <user-teams>` is a collection of users who are granted some level of access to a set of events.
+   * - | |:gb:| **Device**
+       | |:de:| Gerät
+     - A device is something that talks to pretix but does not run on a server. Usually a device refers to an
+       installation of pretixSCAN, pretixPOS or some compatible third-party app on one of your computing devices.
+   * - | |:gb:| **Gate**
+       | |:de:| Station
+     - A gate is a location at your event where people are being scanned, e.g. an entry or exit door. You can configure
+       gates in pretix to group multiple devices together that are used in the same location, mostly for statistical
+       purposes.
+   * - | |:gb:| **Widget**
+       | |:de:| Widget
+     - The :ref:`widget` is a JavaScript component that can be used to embed the shop of an event or a list of events
+       into a third-party web page.
+   * - | |:gb:| **Sales channel**
+       | |:de:| Verkaufskanal
+     - A sales channel refers to the type in which a purchase arrived in the system, e.g. through pretix' web shop itself,
+       or through other channels like box office or reseller sales.
+   * - | |:gb:| **Box office**
+       | |:de:| Abendkasse
+     - Box office purchases refer to all purchases made in-person from the organizer directly, through a point of sale
+       system like pretixPOS.
+   * - | |:gb:| **Reseller**
+       | |:de:| Vorverkaufsstelle
+     - Resellers are third-party entities offering in-person sales of events to customers.

doc/user/index.rst

@@ -15,3 +15,4 @@ wanting to use pretix to sell tickets.
    events/giftcards
    faq
    markdown
+   glossary

doc/user/payments/settings.rst

@@ -1,8 +1,8 @@
 General settings
 ================
 
-At "Settings" → "Payment", you can configure every aspect related to the payments you want to accept. The upper part
-of the page shows a number of general settings that affect all payment methods:
+At "Settings" → "Payment", you can configure every aspect related to the payments you want to accept. The "Deadline"
+and "Advanced" tabs of the page show a number of general settings that affect all payment methods:
 
 .. thumbnail:: ../../screens/event/settings_payment.png
    :align: center

src/MANIFEST.in

@@ -1,8 +1,10 @@
 include LICENSE
 include README.rst
+global-include *.proto
 recursive-include pretix/static *
 recursive-include pretix/static.dist *
 recursive-include pretix/locale *
+recursive-include pretix/helpers/locale *
 recursive-include pretix/base/templates *
 recursive-include pretix/control/templates *
 recursive-include pretix/presale/templates *

src/pretix/__init__.py

@@ -1 +1 @@
-__version__ = "3.9.0.dev0"
+__version__ = "3.13.0"

src/pretix/api/auth/device.py

@@ -3,6 +3,9 @@ from django_scopes import scopes_disabled
 from rest_framework import exceptions
 from rest_framework.authentication import TokenAuthentication
 
+from pretix.api.auth.devicesecurity import (
+    DEVICE_SECURITY_PROFILES, FullAccessSecurityProfile,
+)
 from pretix.base.models import Device
 
 
@@ -25,3 +28,11 @@ class DeviceTokenAuthentication(TokenAuthentication):
             raise exceptions.AuthenticationFailed('Device access has been revoked.')
 
         return AnonymousUser(), device
+
+    def authenticate(self, request):
+        r = super().authenticate(request)
+        if r and isinstance(r[1], Device):
+            profile = DEVICE_SECURITY_PROFILES.get(r[1].security_profile, FullAccessSecurityProfile)
+            if not profile.is_allowed(request):
+                raise exceptions.PermissionDenied('Request denied by device security profile.')
+        return r

src/pretix/api/auth/devicesecurity.py

@@ -0,0 +1,125 @@
+from django.utils.translation import ugettext_lazy as _
+
+
+class FullAccessSecurityProfile:
+    identifier = 'full'
+    verbose_name = _('Full device access (reading and changing orders and gift cards, reading of products and settings)')
+
+    def is_allowed(self, request):
+        return True
+
+
+class AllowListSecurityProfile:
+    allowlist = tuple()
+
+    def is_allowed(self, request):
+        key = (request.method, f"{request.resolver_match.namespace}:{request.resolver_match.url_name}")
+        return key in self.allowlist
+
+
+class PretixScanSecurityProfile(AllowListSecurityProfile):
+    identifier = 'pretixscan'
+    verbose_name = _('pretixSCAN')
+    allowlist = (
+        ('GET', 'api-v1:version'),
+        ('GET', 'api-v1:device.eventselection'),
+        ('POST', 'api-v1:device.update'),
+        ('POST', 'api-v1:device.revoke'),
+        ('POST', 'api-v1:device.roll'),
+        ('GET', 'api-v1:event-list'),
+        ('GET', 'api-v1:event-detail'),
+        ('GET', 'api-v1:subevent-list'),
+        ('GET', 'api-v1:subevent-detail'),
+        ('GET', 'api-v1:itemcategory-list'),
+        ('GET', 'api-v1:item-list'),
+        ('GET', 'api-v1:question-list'),
+        ('GET', 'api-v1:badgelayout-list'),
+        ('GET', 'api-v1:badgeitem-list'),
+        ('GET', 'api-v1:checkinlist-list'),
+        ('GET', 'api-v1:checkinlist-status'),
+        ('GET', 'api-v1:checkinlistpos-list'),
+        ('POST', 'api-v1:checkinlistpos-redeem'),
+        ('GET', 'api-v1:revokedsecrets-list'),
+        ('GET', 'api-v1:order-list'),
+        ('GET', 'api-v1:event.settings'),
+    )
+
+
+class PretixScanNoSyncSecurityProfile(AllowListSecurityProfile):
+    identifier = 'pretixscan_online_kiosk'
+    verbose_name = _('pretixSCAN (kiosk mode, online only)')
+    allowlist = (
+        ('GET', 'api-v1:version'),
+        ('GET', 'api-v1:device.eventselection'),
+        ('POST', 'api-v1:device.update'),
+        ('POST', 'api-v1:device.revoke'),
+        ('POST', 'api-v1:device.roll'),
+        ('GET', 'api-v1:event-list'),
+        ('GET', 'api-v1:event-detail'),
+        ('GET', 'api-v1:subevent-list'),
+        ('GET', 'api-v1:subevent-detail'),
+        ('GET', 'api-v1:itemcategory-list'),
+        ('GET', 'api-v1:item-list'),
+        ('GET', 'api-v1:question-list'),
+        ('GET', 'api-v1:badgelayout-list'),
+        ('GET', 'api-v1:badgeitem-list'),
+        ('GET', 'api-v1:checkinlist-list'),
+        ('GET', 'api-v1:checkinlist-status'),
+        ('POST', 'api-v1:checkinlistpos-redeem'),
+        ('GET', 'api-v1:revokedsecrets-list'),
+        ('GET', 'api-v1:event.settings'),
+    )
+
+
+class PretixPosSecurityProfile(AllowListSecurityProfile):
+    identifier = 'pretixpos'
+    verbose_name = _('pretixPOS')
+    allowlist = (
+        ('GET', 'api-v1:version'),
+        ('GET', 'api-v1:device.eventselection'),
+        ('POST', 'api-v1:device.update'),
+        ('POST', 'api-v1:device.revoke'),
+        ('POST', 'api-v1:device.roll'),
+        ('GET', 'api-v1:event-list'),
+        ('GET', 'api-v1:event-detail'),
+        ('GET', 'api-v1:subevent-list'),
+        ('GET', 'api-v1:subevent-detail'),
+        ('GET', 'api-v1:itemcategory-list'),
+        ('GET', 'api-v1:item-list'),
+        ('GET', 'api-v1:question-list'),
+        ('GET', 'api-v1:quota-list'),
+        ('GET', 'api-v1:taxrule-list'),
+        ('GET', 'api-v1:ticketlayout-list'),
+        ('GET', 'api-v1:ticketlayoutitem-list'),
+        ('GET', 'api-v1:order-list'),
+        ('POST', 'api-v1:order-list'),
+        ('GET', 'api-v1:order-detail'),
+        ('DELETE', 'api-v1:orderposition-detail'),
+        ('POST', 'api-v1:order-mark_canceled'),
+        ('POST', 'api-v1:orderrefund-list'),
+        ('POST', 'api-v1:orderrefund-done'),
+        ('POST', 'api-v1:cartposition-list'),
+        ('DELETE', 'api-v1:cartposition-detail'),
+        ('GET', 'api-v1:giftcard-list'),
+        ('POST', 'api-v1:giftcard-transact'),
+        ('POST', 'plugins:pretix_posbackend:posreceipt-list'),
+        ('POST', 'plugins:pretix_posbackend:posclosing-list'),
+        ('POST', 'plugins:pretix_posbackend:posdebugdump-list'),
+        ('POST', 'plugins:pretix_posbackend:stripeterminal.token'),
+        ('GET', 'api-v1:revokedsecrets-list'),
+        ('GET', 'api-v1:event.settings'),
+        ('GET', 'plugins:pretix_seating:event.event'),
+        ('GET', 'plugins:pretix_seating:event.event.subevent'),
+        ('GET', 'plugins:pretix_seating:event.plan'),
+        ('GET', 'plugins:pretix_seating:selection.simple'),
+    )
+
+
+DEVICE_SECURITY_PROFILES = {
+    k.identifier: k() for k in (
+        FullAccessSecurityProfile,
+        PretixScanSecurityProfile,
+        PretixScanNoSyncSecurityProfile,
+        PretixPosSecurityProfile,
+    )
+}

src/pretix/api/auth/permission.py

@@ -84,3 +84,15 @@ class EventCRUDPermission(EventPermission):
             return False
 
         return True
+
+
+class ProfilePermission(BasePermission):
+
+    def has_permission(self, request, view):
+        if not request.user.is_authenticated:
+            return False
+
+        if isinstance(request.auth, OAuthAccessToken):
+            if not (request.auth.allow_scopes(['read']) or request.auth.allow_scopes(['profile'])) and request.method in SAFE_METHODS:
+                return False
+        return True

src/pretix/api/oauth.py

@@ -9,7 +9,7 @@ from oauth2_provider.settings import oauth2_settings
 class Validator(OAuth2Validator):
 
     def save_authorization_code(self, client_id, code, request, *args, **kwargs):
-        if not getattr(request, 'organizers', None):
+        if not getattr(request, 'organizers', None) and request.scopes != ['profile']:
             raise FatalClientError('No organizers selected.')
 
         expires = timezone.now() + timedelta(
@@ -18,7 +18,8 @@ class Validator(OAuth2Validator):
                   expires=expires, redirect_uri=request.redirect_uri,
                   scope=" ".join(request.scopes))
         g.save()
-        g.organizers.add(*request.organizers.all())
+        if request.scopes != ['profile']:
+            g.organizers.add(*request.organizers.all())
 
     def validate_code(self, client_id, code, client, request, *args, **kwargs):
         try:
@@ -34,12 +35,14 @@ class Validator(OAuth2Validator):
             return False
 
     def _create_access_token(self, expires, request, token, source_refresh_token=None):
-        if not getattr(request, 'organizers', None) and not getattr(source_refresh_token, 'access_token'):
+        if not getattr(request, 'organizers', None) and not getattr(source_refresh_token, 'access_token', None) and token["scope"] != 'profile':
             raise FatalClientError('No organizers selected.')
-        if hasattr(request, 'organizers'):
-            orgs = list(request.organizers.all())
-        else:
-            orgs = list(source_refresh_token.access_token.organizers.all())
+        if token['scope'] != 'profile':
+            if hasattr(request, 'organizers'):
+                orgs = list(request.organizers.all())
+            else:
+                orgs = list(source_refresh_token.access_token.organizers.all())
         access_token = super()._create_access_token(expires, request, token, source_refresh_token=None)
-        access_token.organizers.add(*orgs)
+        if token['scope'] != 'profile':
+            access_token.organizers.add(*orgs)
         return access_token