Skip to content

Section admin

section.admin

PlaylistAdmin

Bases: InlineActionsModelAdminMixin, ModelAdmin

Source code in section/admin.py
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
class PlaylistAdmin(InlineActionsModelAdminMixin, admin.ModelAdmin):
    form = PlaylistAdminForm
    change_form_template = "change_form.html"
    list_display = ("name", "_section_count", "_block_count")
    search_fields = ["name", "section__song__artist", "section__song__name"]
    inline_actions = ["add_sections", "edit_sections", "export_csv"]

    def redirect_to_overview(self):
        return redirect(reverse("admin:section_playlist_changelist"))

    def save_model(self, request, obj, form, change):
        # store proces value
        process_csv = obj.process_csv

        # save playlist (so it sure has an id)
        super().save_model(request, obj, form, change)

        # process csv
        if process_csv:
            csv_result = obj._update_sections()

            # create message based on csv_result (CSV_ERROR or CSV_OK)
            if csv_result["status"] == Playlist.CSV_ERROR:
                messages.add_message(request, messages.ERROR, csv_result["message"])

            elif csv_result["status"] == Playlist.CSV_OK:
                messages.add_message(request, messages.INFO, csv_result["message"])

    def add_sections(self, request, obj, parent_obj=None):
        """Add multiple sections"""
        sections = Section.objects.filter(playlist=obj)
        form = AddSections()
        # Get the info for new sections
        if "_add" in request.POST:
            this_artist = request.POST.get("artist")
            this_name = request.POST.get("name")
            this_tag = request.POST.get("tag")
            this_group = request.POST.get("group")
            new_sections = request.FILES.getlist("files")
            # Create section object for each file
            for section in new_sections:
                new_section = Section.objects.create(
                    playlist=obj, tag=this_tag, group=this_group, filename=section
                )
                try:
                    new_section.clean_fields()
                except ValidationError as e:
                    new_section.delete()
                    file_errors = form.errors.get("file", [])
                    file_errors.append(
                        _("Cannot upload {}: {}").format(str(section), e.messages[0])
                    )
                    form.errors["file"] = file_errors
                    continue

                # Retrieve or create Song object
                song = None
                if this_artist or this_name:
                    song = get_or_create_song(this_artist, this_name)
                new_section.song = song

                file_path = join(settings.MEDIA_ROOT, str(new_section.filename))
                with audioread.audio_open(file_path) as f:
                    new_section.duration = f.duration
                new_section.save()

            obj.save()
            if not form.errors:
                return self.redirect_to_overview()
        # Go back to admin playlist overview
        if "_back" in request.POST:
            return self.redirect_to_overview()
        return render(
            request,
            "add-sections.html",
            context={"playlist": obj, "sections": sections, "form": form},
        )

    def edit_sections(self, request, obj, parent_obj=None):
        """Edit multiple section in a playlist"""
        sections = Section.objects.filter(playlist=obj)
        # Get form data for each section in the playlist
        if "_update" in request.POST:
            for section in sections:
                # Create pre fix to get the right section fields
                pre_fix = str(section.id)
                # Get data and update section
                this_artist = request.POST.get(pre_fix + "_artist")
                this_name = request.POST.get(pre_fix + "_name")

                # Retrieve or create Song object
                song = None
                if this_artist or this_name:
                    song = get_or_create_song(this_artist, this_name)
                section.song = song

                section.start_time = request.POST.get(pre_fix + "_start_time")
                section.duration = request.POST.get(pre_fix + "_duration")
                section.tag = request.POST.get(pre_fix + "_tag")
                section.group = request.POST.get(pre_fix + "_group")
                section.save()
            obj.process_csv = False
            obj.save()
            return self.redirect_to_overview()
        if "_back" in request.POST:
            return self.redirect_to_overview()
        return render(
            request,
            "edit-sections.html",
            context={"playlist": obj, "sections": sections},
        )

    def export_csv(self, request, obj, parent_obj=None):
        """Export playlist sections to csv, force download"""

        response = HttpResponse(content_type="text/csv")

        writer = csv.writer(response)
        for section in obj.section_set.all():
            writer.writerow(section._export_admin_csv())

        # force download attachment
        response["Content-Disposition"] = (
            'attachment; filename="playlist_' + str(obj.id) + '.csv"'
        )
        return response

    export_csv.short_description = "Export Sections CSV"

    def export_csv_view(self, request, pk):
        obj = self.get_object(request, pk)
        return self.export_csv(request, obj)

    def get_urls(self):
        urls = super().get_urls()
        custom_urls = [
            path(
                "<int:pk>/export_csv/",
                self.export_csv_view,
                name="section_playlist_export_csv",
            ),
        ]
        return custom_urls + urls

add_sections(request, obj, parent_obj=None)

Add multiple sections

Source code in section/admin.py
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
def add_sections(self, request, obj, parent_obj=None):
    """Add multiple sections"""
    sections = Section.objects.filter(playlist=obj)
    form = AddSections()
    # Get the info for new sections
    if "_add" in request.POST:
        this_artist = request.POST.get("artist")
        this_name = request.POST.get("name")
        this_tag = request.POST.get("tag")
        this_group = request.POST.get("group")
        new_sections = request.FILES.getlist("files")
        # Create section object for each file
        for section in new_sections:
            new_section = Section.objects.create(
                playlist=obj, tag=this_tag, group=this_group, filename=section
            )
            try:
                new_section.clean_fields()
            except ValidationError as e:
                new_section.delete()
                file_errors = form.errors.get("file", [])
                file_errors.append(
                    _("Cannot upload {}: {}").format(str(section), e.messages[0])
                )
                form.errors["file"] = file_errors
                continue

            # Retrieve or create Song object
            song = None
            if this_artist or this_name:
                song = get_or_create_song(this_artist, this_name)
            new_section.song = song

            file_path = join(settings.MEDIA_ROOT, str(new_section.filename))
            with audioread.audio_open(file_path) as f:
                new_section.duration = f.duration
            new_section.save()

        obj.save()
        if not form.errors:
            return self.redirect_to_overview()
    # Go back to admin playlist overview
    if "_back" in request.POST:
        return self.redirect_to_overview()
    return render(
        request,
        "add-sections.html",
        context={"playlist": obj, "sections": sections, "form": form},
    )

edit_sections(request, obj, parent_obj=None)

Edit multiple section in a playlist

Source code in section/admin.py
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
def edit_sections(self, request, obj, parent_obj=None):
    """Edit multiple section in a playlist"""
    sections = Section.objects.filter(playlist=obj)
    # Get form data for each section in the playlist
    if "_update" in request.POST:
        for section in sections:
            # Create pre fix to get the right section fields
            pre_fix = str(section.id)
            # Get data and update section
            this_artist = request.POST.get(pre_fix + "_artist")
            this_name = request.POST.get(pre_fix + "_name")

            # Retrieve or create Song object
            song = None
            if this_artist or this_name:
                song = get_or_create_song(this_artist, this_name)
            section.song = song

            section.start_time = request.POST.get(pre_fix + "_start_time")
            section.duration = request.POST.get(pre_fix + "_duration")
            section.tag = request.POST.get(pre_fix + "_tag")
            section.group = request.POST.get(pre_fix + "_group")
            section.save()
        obj.process_csv = False
        obj.save()
        return self.redirect_to_overview()
    if "_back" in request.POST:
        return self.redirect_to_overview()
    return render(
        request,
        "edit-sections.html",
        context={"playlist": obj, "sections": sections},
    )

export_csv(request, obj, parent_obj=None)

Export playlist sections to csv, force download

Source code in section/admin.py
166
167
168
169
170
171
172
173
174
175
176
177
178
179
def export_csv(self, request, obj, parent_obj=None):
    """Export playlist sections to csv, force download"""

    response = HttpResponse(content_type="text/csv")

    writer = csv.writer(response)
    for section in obj.section_set.all():
        writer.writerow(section._export_admin_csv())

    # force download attachment
    response["Content-Disposition"] = (
        'attachment; filename="playlist_' + str(obj.id) + '.csv"'
    )
    return response