Feature-9059: Refactor download PDF request due to unable to receieve on frontend (#9060)

* fix issue user request check in not admin

* feature-9059: Refactor download PDF request due to unable to receieve on frontend

* update code

* fix pipeline

* fix pipeline

* update newest branch

* fix pipeline

* fix pipeline

* fix pipeline

* fix code review

* fix code review

* fix code review

* fix code review

* fix code review

* fix code review

Author: nnhathung

app/api/custom/badge_forms.py

@@ -1,9 +1,13 @@
-from flask import Blueprint, request
-from flask.helpers import send_from_directory
+from flask import Blueprint, jsonify, request
+from flask.helpers import send_from_directory, url_for
 from flask_jwt_extended import jwt_required
 
-from app.api.helpers.badge_forms import create_preivew_badge_pdf, create_print_badge_pdf
+from app.api.helpers.badge_forms import create_preivew_badge_pdf
 from app.api.helpers.errors import ForbiddenError, NotFoundError
+from app.api.helpers.export_helpers import (
+    comma_separated_params_to_list,
+    create_export_badge_job,
+)
 from app.api.helpers.permission_manager import has_access
 from app.models.badge_form import BadgeForms
 from app.models.ticket_holder import TicketHolder
@@ -27,26 +31,40 @@ def preivew_badge_pdf():
     return send_from_directory('../', file_path, as_attachment=True)
 
 
-@badge_forms_routes.route('/print-badge-pdf', methods=['POST'])
+@badge_forms_routes.route('/print-badge-pdf', methods=['GET'])
 @jwt_required
 def print_badge_pdf():
     """Print Badge Template PDF"""
-    attendee_id = request.json.get('attendee_id')
-    list_field_show = request.json.get('list_field_show')
-    ticketHolders = TicketHolder.query.filter_by(id=attendee_id).first()
-    if ticketHolders is None:
+    from ..helpers.tasks import create_print_badge_pdf
+
+    if not request.args.get('attendee_id', False):
+        raise NotFoundError(
+            {'parameter': 'attendee_id'}, "attendee_id is missing from your request."
+        )
+    if not request.args.get('list_field_show', False):
+        raise NotFoundError(
+            {'parameter': 'list_field_show'},
+            "list_field_show is missing from your request.",
+        )
+    attendee_id = request.args.get('attendee_id')
+    list_field_show = comma_separated_params_to_list(request.args.get('list_field_show'))
+
+    ticket_holder = TicketHolder.query.filter_by(id=attendee_id).first()
+    if ticket_holder is None:
         raise NotFoundError(
             {'source': ''}, 'This ticket holder is not associated with any ticket'
         )
-    badgeForms = BadgeForms.query.filter_by(
-        badge_id=ticketHolders.ticket.badge_id
+    badge_form = BadgeForms.query.filter_by(
+        badge_id=ticket_holder.ticket.badge_id
     ).first()
-    if badgeForms is None:
+    if badge_form is None:
         raise NotFoundError(
             {'source': ''}, 'This badge form is not associated with any ticket'
         )
-    if not has_access('is_coorganizer', event_id=badgeForms.event_id):
+    if not has_access('is_coorganizer', event_id=ticket_holder.event_id):
         raise ForbiddenError({'source': ''}, 'Unauthorized Access')
 
-    file_path = create_print_badge_pdf(badgeForms, ticketHolders, list_field_show)
-    return send_from_directory('../', file_path, as_attachment=True)
+    task = create_print_badge_pdf.delay(attendee_id, list_field_show)
+    create_export_badge_job(task.id, ticket_holder.event_id, attendee_id)
+
+    return jsonify(task_url=url_for('tasks.celery_task', task_id=task.id))

app/api/helpers/badge_forms.py

@@ -1,12 +1,9 @@
 import base64
 import io
-from datetime import datetime
 
 import qrcode
 from flask import render_template
-from sqlalchemy import asc
 
-from app.api.helpers.db import save_to_db
 from app.api.helpers.files import create_save_pdf
 from app.api.helpers.storage import UPLOAD_PATHS, generate_hash
 from app.api.helpers.utilities import to_snake_case
@@ -33,8 +30,8 @@ def create_preivew_badge_pdf(badgeForms):
         font_weight = []
         font_style = []
         text_decoration = []
-        if badge_field['font_weight']:
-            for item in badge_field['font_weight']:
+        if badge_field.get('font_weight'):
+            for item in badge_field.get('font_weight'):
                 if item.get('font_weight'):
                     font_weight.append(item.get('font_weight'))
                 if item.get('font_style'):
@@ -80,25 +77,32 @@ def get_value_from_qr_filed(field: BadgeFieldForms, ticket_holder: TicketHolder)
     """Get the value of a QR code field."""
     qr_value = {}
     custom_fields = []
-    for field_identifier in field.qr_custom_field:
-        value_ = ""
-        try:
-            snake_case_field_identifier = to_snake_case(field_identifier)
-            value_ = getattr(ticket_holder, snake_case_field_identifier)
-        except AttributeError:
+    if field.qr_custom_field is not None:
+        for field_identifier in field.qr_custom_field:
+            value_ = ""
             try:
-                value_ = ticket_holder.complex_field_values[field_identifier]
-                # Get the field description then Capitalize first letter and remove space.
-                custom_form = CustomForms.query.filter_by(
-                    field_identifier=field_identifier,
-                    form_id=ticket_holder.ticket.form_id,
-                ).first()
-                field_description = custom_form.description.title().replace(' ', '')
-                custom_fields.append({field_description: value_})
+                snake_case_field_identifier = to_snake_case(field_identifier)
+                value_ = getattr(ticket_holder, snake_case_field_identifier)
             except AttributeError:
-                print(field_identifier)
-
-        qr_value.update({field_identifier: str(value_)})
+                try:
+                    if ticket_holder.complex_field_values is not None:
+                        value_ = ticket_holder.complex_field_values[field_identifier]
+                        # Get the field description then
+                        # Capitalize first letter and remove space.
+                        custom_form = CustomForms.query.filter_by(
+                            field_identifier=field_identifier,
+                            form_id=ticket_holder.ticket.form_id,
+                        ).first()
+                        field_description = custom_form.description.title().replace(
+                            ' ', ''
+                        )
+                        custom_fields.append({field_description: value_})
+                except AttributeError:
+                    print(field_identifier)
+                except Exception:
+                    print(field_identifier)
+
+            qr_value.update({field_identifier: str(value_)})
     qr_value.update({'custom_fields': custom_fields, 'ticket_id': ticket_holder.id})
     return qr_value
 
@@ -118,67 +122,3 @@ def create_base64_img_qr(qr_code_data: str) -> str:
     img.save(io_buffer)
     qr_img_str = base64.b64encode(io_buffer.getvalue()).decode()
     return qr_img_str
-
-
-def create_print_badge_pdf(badge_form, ticket_holder, list_field_show):
-    """
-    Create tickets and invoices for the holders of an order.
-    :param badgeForms: The order for which to create tickets for.
-    """
-    badgeFieldForms = (
-        BadgeFieldForms.query.filter_by(badge_form_id=badge_form.id)
-        .filter_by(badge_id=badge_form.badge_id)
-        .order_by(asc("id"))
-        .all()
-    )
-    for field in badgeFieldForms:
-        if field.custom_field.lower() == 'qr':
-            qr_code_data = get_value_from_qr_filed(field, ticket_holder)
-            qr_rendered = render_template('cvf/badge_qr_template.cvf', **qr_code_data)
-
-            field.sample_text = create_base64_img_qr(qr_rendered)
-            continue
-        if list_field_show is None or field.field_identifier not in list_field_show:
-            field.sample_text = ' '
-            continue
-
-        get_value_from_field_indentifier(field, ticket_holder)
-
-    for badge_field in badgeFieldForms:
-        font_weight = []
-        font_style = []
-        text_decoration = []
-        badge_field.font_weight_tmp = badge_field.font_weight
-        if badge_field.font_weight:
-            for item in badge_field.font_weight:
-                if item.get('font_weight'):
-                    font_weight.append(item.get('font_weight'))
-                if item.get('font_style'):
-                    font_style.append(item.get('font_style'))
-                if item.get('text_decoration'):
-                    text_decoration.append(item.get('text_decoration'))
-        if not font_weight:
-            badge_field.font_weight = 'none'
-        else:
-            badge_field.font_weight = ','.join(font_weight)
-        if not font_style:
-            badge_field.font_style = 'none'
-        else:
-            badge_field.font_style = ','.join(font_style)
-        if not text_decoration:
-            badge_field.text_decoration = 'none'
-        else:
-            badge_field.text_decoration = ','.join(text_decoration)
-    create_save_pdf(
-        render_template(
-            'pdf/badge_forms.html', badgeForms=badge_form, badgeFieldForms=badgeFieldForms
-        ),
-        UPLOAD_PATHS['pdf']['badge_forms_pdf'].format(identifier=badge_form.badge_id),
-        identifier=badge_form.badge_id,
-    )
-    ticket_holder.is_badge_printed = True
-    ticket_holder.badge_printed_at = datetime.now()
-    for badge_field in badgeFieldForms:
-        badge_field.font_weight = badge_field.font_weight_tmp
-    save_to_db(ticket_holder, 'Ticket Holder saved')
-    return file_pdf_path(badge_form)

app/api/helpers/export_helpers.py

@@ -315,3 +315,37 @@ def handle_unserializable_data(obj):
     """
     if isinstance(obj, datetime):
         return obj.__str__()
+
+
+def create_export_badge_job(task_id, event_id, attendee_id):
+    """Create export job for an export that is going to start"""
+    export_job = ExportJob.query.filter_by(
+        event_id=event_id, attendee_id=attendee_id
+    ).first()
+    task_url = url_for('tasks.celery_task', task_id=task_id)
+    logged_user = get_current_user()
+
+    if export_job:
+
+        export_job.task = task_url
+        export_job.user_email = logged_user.email
+        export_job.attendee_id = attendee_id
+        export_job.event = Event.query.get(event_id)
+        export_job.starts_at = datetime.now(pytz.utc)
+    else:
+        export_job = ExportJob(
+            task=task_url,
+            user_email=logged_user.email,
+            attendee_id=attendee_id,
+            event=Event.query.get(event_id),
+        )
+    save_to_db(export_job, 'ExportJob saved')
+
+
+def comma_separated_params_to_list(param):
+    """
+    convert string to list separated by comma
+    @param param: string to be separates
+    @return: array string
+    """
+    return list(filter(lambda x: x and x is not None, param.split(',')))

app/api/helpers/tasks.py

@@ -55,14 +55,21 @@
 from app.models.user_follow_group import UserFollowGroup
 from app.settings import get_settings
 
+from ...models.badge_field_form import BadgeFieldForms
+from ...models.badge_form import BadgeForms
+from .badge_forms import (
+    create_base64_img_qr,
+    get_value_from_field_indentifier,
+    get_value_from_qr_filed,
+)
+from .errors import NotFoundError
 from .import_helpers import update_import_job
 
 """
 Define all API v2 celery tasks here
 This is done to resolve circular imports
 """
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -727,7 +734,6 @@ def export_admin_sales_csv_task(self, status='all'):
 
 @celery.task(base=RequestContextTask, name='export.speakers.csv', bind=True)
 def export_speakers_csv_task(self, event_id, status='all'):
-
     if status not in [
         'all',
         'pending',
@@ -833,7 +839,6 @@ def rename_chat_room(event_id):
 
 @celery.task(base=RequestContextTask, name='export.group.followers.csv', bind=True)
 def export_group_followers_csv_task(self, group_id):
-
     followers = UserFollowGroup.query.filter_by(group_id=group_id).all()
 
     try:
@@ -861,3 +866,97 @@ def export_group_followers_csv_task(self, group_id):
         logging.exception('Error in exporting group followers as CSV')
 
     return result
+
+
+@celery.task(base=RequestContextTask, name='export.badge.pdf', bind=True)
+def create_print_badge_pdf(self, attendee_id, list_field_show):
+    """
+    Create tickets and invoices for the holders of an order.
+    @param self: create_print_badge_pdf
+    @param attendee_id: attendee
+    @param list_field_show: field will be included in badge pdf
+    @return: create pdf file and return download link
+    """
+    try:
+        ticket_holder, badge_form, badge_field_forms = validate_badge_print(attendee_id)
+        for field in badge_field_forms:
+            field.sample_text_tmp = field.sample_text
+            if field.custom_field is not None and field.custom_field.lower() == 'qr':
+                qr_code_data = get_value_from_qr_filed(field, ticket_holder)
+                qr_rendered = render_template('cvf/badge_qr_template.cvf', **qr_code_data)
+                field.sample_text = create_base64_img_qr(qr_rendered)
+                continue
+            if list_field_show is None or field.field_identifier not in list_field_show:
+                field.sample_text = ' '
+                continue
+            get_value_from_field_indentifier(field, ticket_holder)
+            # Font style set up
+        for field in badge_field_forms:
+            font_weight = []
+            font_style = []
+            text_decoration = []
+            field.font_weight_tmp = field.font_weight
+            if field.font_weight is not None:
+                for item in field.font_weight:
+                    if item.get('font_weight', False):
+                        font_weight.append(item.get('font_weight'))
+                    if item.get('font_style', False):
+                        font_style.append(item.get('font_style'))
+                    if item.get('text_decoration', False):
+                        text_decoration.append(item.get('text_decoration'))
+            field.font_weight = 'none' if not font_weight else ','.join(font_weight)
+            field.font_style = 'none' if not font_style else ','.join(font_style)
+            field.text_decoration = (
+                'none' if not text_decoration else ','.join(text_decoration)
+            )
+        badge_url = create_save_pdf(
+            render_template(
+                'pdf/badge_forms.html',
+                badgeForms=badge_form,
+                badgeFieldForms=badge_field_forms,
+            ),
+            UPLOAD_PATHS['pdf']['badge_forms_pdf'].format(identifier=badge_form.badge_id),
+            identifier=badge_form.badge_id,
+        )
+        result = {'download_url': badge_url}
+        ticket_holder.is_badge_printed = True
+        ticket_holder.badge_printed_at = datetime.now()
+        for badge_field in badge_field_forms:
+            badge_field.font_weight = badge_field.font_weight_tmp
+            badge_field.sample_text = badge_field.sample_text_tmp
+        save_to_db(ticket_holder, 'Ticket Holder saved')
+    except AttributeError as e:
+        result = {'__error': True, 'result': str(e)}
+    except Exception:
+        logging.exception(
+            '%s: Error in exporting Badge as PDF', self.request.id.__str__()
+        )
+        result = {
+            '__error': True,
+            'result': 'Unexpected error when trying to print badge, please try again.',
+        }
+    return result
+
+
+def validate_badge_print(attendee_id):
+    """
+    Validate and get attendee, badge form and badge field
+    @param attendee_id: attendee
+    @return: ticket_holder, badge_form, badge_field_forms
+    """
+    ticket_holder = TicketHolder.query.filter_by(id=attendee_id).first()
+    if ticket_holder is None:
+        raise NotFoundError('This ticket holder is not associated with any ticket')
+    badge_form = BadgeForms.query.filter_by(
+        badge_id=ticket_holder.ticket.badge_id
+    ).first()
+    if badge_form is None:
+        raise NotFoundError('This badge form is not associated with any ticket')
+    badge_field_forms = (
+        BadgeFieldForms.query.filter_by(badge_form_id=badge_form.id)
+        .filter_by(badge_id=badge_form.badge_id)
+        .filter_by(is_deleted=False)
+        .order_by(asc("id"))
+        .all()
+    )
+    return ticket_holder, badge_form, badge_field_forms

app/models/export_job.py

@@ -17,6 +17,7 @@ class ExportJob(db.Model):
 
     event_id = db.Column(db.Integer, db.ForeignKey('events.id', ondelete='CASCADE'))
     event = db.relationship('Event', backref=backref('export_jobs'))
+    attendee_id = db.Column(db.Integer, nullable=True)
 
     def __repr__(self):
         return '<ExportJob %d for event %d>' % (self.id, self.event.id)