pretix_original/src/pretix/base/media.py

#
# This file is part of pretix (Community Edition).
#
# Copyright (C) 2014-2020  Raphael Michel and contributors
# Copyright (C) 2020-today pretix GmbH and contributors
#
# This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General
# Public License as published by the Free Software Foundation in version 3 of the License.
#
# ADDITIONAL TERMS APPLY: Pursuant to Section 7 of the GNU Affero General Public License, additional terms are
# applicable granting you additional permissions and placing additional restrictions on your usage of this software.
# Please refer to the pretix LICENSE file to obtain the full terms applicable to this work. If you did not receive
# this file, see <https://pretix.eu/about/en/license>.
#
# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along with this program.  If not, see
# <https://www.gnu.org/licenses/>.
#
from django.db import transaction
from django.utils.crypto import get_random_string
from django.utils.translation import gettext_lazy as _


class BaseMediaType:
    medium_created_by_server = False
    medium_created_from_unknown_supported = False
    supports_orderposition = False
    supports_giftcard = False

    @property
    def identifier(self):
        raise NotImplementedError()

    @property
    def verbose_name(self):
        raise NotImplementedError()

    @property
    def icon(self):
        """
        This can be:

        - The name of a Font Awesome icon to represent this channel type.
        - The name of a SVG icon file that is resolvable through the static file system. We recommend to design for a size of 18x14 pixels.
        """
        return "circle"

    def generate_identifier(self, organizer):
        if self.medium_created_by_server:
            raise NotImplementedError()
        else:
            raise ValueError("Media type does not allow to generate identifier")

    def is_active(self, organizer):
        return organizer.settings.get(f'reusable_media_type_{self.identifier}', as_type=bool, default=False)

    def handle_unknown(self, organizer, identifier, user, auth, force_create=False):
        pass

    def handle_new(self, organizer, medium, user, auth):
        pass

    def __str__(self):
        return str(self.verbose_name)


class BarcodePlainMediaType(BaseMediaType):
    identifier = 'barcode'
    verbose_name = _('Barcode / QR-Code')
    icon = 'qrcode'
    medium_created_by_server = True
    supports_giftcard = False
    supports_orderposition = True

    def generate_identifier(self, organizer):
        return get_random_string(
            length=organizer.settings.reusable_media_type_barcode_identifier_length,
            # Exclude o,0,1,i to avoid confusion with bad fonts/printers
            # We use upper case to make collisions with ticket secrets less likely
            allowed_chars='ABCDEFGHJKLMNPQRSTUVWXYZ23456789'
        )


class NfcUidMediaType(BaseMediaType):
    identifier = 'nfc_uid'
    verbose_name = _('NFC UID-based')
    icon = 'pretixbase/img/media/nfc_uid.svg'
    medium_created_by_server = False
    medium_created_from_unknown_supported = True
    supports_giftcard = True
    supports_orderposition = True

    def handle_unknown(self, organizer, identifier, user, auth, force_create=False):
        from pretix.base.models import GiftCard, ReusableMedium

        create_giftcard = organizer.settings.get(f'reusable_media_type_{self.identifier}_autocreate_giftcard', as_type=bool)
        if create_giftcard or force_create:
            if identifier.startswith("08"):
                # Don't create gift cards for NFC UIDs that start with 08, which represents NFC cards that issue random
                # UIDs on every read, so they won't be useful.
                return
            with transaction.atomic():
                if create_giftcard:
                    gc = GiftCard.objects.create(
                        issuer=organizer,
                        expires=organizer.default_gift_card_expiry,
                        currency=organizer.settings.get(f'reusable_media_type_{self.identifier}_autocreate_giftcard_currency'),
                    )
                    gc.log_action(
                        'pretix.giftcards.created',
                        user=user, auth=auth,
                    )
                else:
                    gc = None
                m = ReusableMedium.objects.create(
                    type=self.identifier,
                    identifier=identifier,
                    organizer=organizer,
                    active=True,
                    linked_giftcard=gc
                )
                m.log_action(
                    'pretix.reusable_medium.created.auto',
                    user=user, auth=auth,
                )
                return m


class NfcMf0aesMediaType(BaseMediaType):
    identifier = 'nfc_mf0aes'
    verbose_name = 'NFC Mifare Ultralight AES'
    icon = 'pretixbase/img/media/nfc_secure.svg'
    medium_created_by_server = False
    supports_giftcard = True
    supports_orderposition = True

    def handle_new(self, organizer, medium, user, auth):
        from pretix.base.models import GiftCard

        if organizer.settings.get(f'reusable_media_type_{self.identifier}_autocreate_giftcard', as_type=bool):
            with transaction.atomic():
                gc = GiftCard.objects.create(
                    issuer=organizer,
                    expires=organizer.default_gift_card_expiry,
                    currency=organizer.settings.get(f'reusable_media_type_{self.identifier}_autocreate_giftcard_currency'),
                )
                medium.linked_giftcard = gc
                medium.save()
                medium.log_action(
                    'pretix.reusable_medium.linked_giftcard.changed',
                    user=user, auth=auth,
                    data={
                        'linked_giftcard': gc.pk
                    }
                )
                gc.log_action(
                    'pretix.giftcards.created',
                    user=user, auth=auth,
                )
                return medium


MEDIA_TYPES = {
    m.identifier: m for m in [
        BarcodePlainMediaType(),
        NfcUidMediaType(),
        NfcMf0aesMediaType(),
    ]
}