django-oscar-availfiles

Wires django-availfiles into django-oscar: an Oscar dashboard section to upload/browse files, plus the pieces needed to let editors link to them from a TinyMCE "Insert Link" dialog in any dashboard wysiwyg field (a blog post body, a product description, ...).

What this package does, and doesn't, do

• An Oscar dashboard section under /dashboard/availfiles/: list/ upload/delete. Uploads are rejected if their content-type starts with image/ by default (configurable via OSCAR_AVAILFILES_REJECTED_CONTENT_TYPES) — images already have their own drag-and-drop-into-the-editor upload flow in a typical Oscar dashboard TinyMCE setup; this library is for everything else (PDFs, spec sheets, downloadable docs).
• A JSON listing endpoint (dashboard:availfiles-list-json, optionally filtered by ?q=<term> against label/filename) — read-only, meant to feed a TinyMCE file_picker_callback, not a general API.
• It does not upload new files from inside the TinyMCE dialog itself — the flow is: upload once via the dashboard, then link to it from anywhere via the picker. It also doesn't touch the image-upload flow at all; that's a separate, pre-existing concern in whatever project this is installed into.

Installation

uv add django-oscar-availfiles

INSTALLED_APPS = [
    ...,
    "availfiles",
    "oscar_availfiles.apps.OscarAvailFilesConfig",
    "oscar_availfiles.dashboard.apps.AvailFilesDashboardConfig",
]

Run manage.py migrate — availfiles ships the actual model migration; this package has none of its own.

Wiring the dashboard in

Same fork every dashboard extension in this family needs (Oscar's DashboardConfig.get_urls() is a hardcoded list) — see this package's own tests/dashboard.py for a worked example:

from django.apps import apps
from django.urls import include, path
from oscar.apps.dashboard.apps import DashboardConfig as OscarDashboardConfig


class DashboardConfig(OscarDashboardConfig):
    def ready(self):
        super().ready()
        self.availfiles_app = apps.get_app_config("availfiles_dashboard")

    def get_urls(self):
        urls = super().get_urls()
        urls.append(path("availfiles/", include(self.availfiles_app.urls[0])))
        return urls

Wiring the TinyMCE file picker in

This has to live in the host project's own dashboard layout override (templates/oscar/dashboard/layout.html's onbodyload block, where oscar.dashboard.init(options) is called) — the same place an image upload handler would be wired, if one exists. Add a file_picker_callback to tinyConfig that opens a small popup fed by the JSON endpoint above:

function availfilesPickerCallback(callback, value, meta) {
    if (meta.filetype !== 'file') {
        return;  // only handling the plain "link" picker, not image/media
    }
    fetch('{% url "dashboard:availfiles-list-json" %}')
        .then(function (response) { return response.json(); })
        .then(function (data) {
            var win = tinymce.activeEditor.windowManager.open({
                title: 'Choose a file',
                body: {
                    type: 'panel',
                    items: data.files.map(function (f) {
                        return { type: 'button', text: f.display_name, name: 'file_' + f.id };
                    })
                },
                buttons: [{ type: 'cancel', text: 'Close' }],
                onAction: function (dialogApi, details) {
                    var id = parseInt(details.name.replace('file_', ''), 10);
                    var chosen = data.files.find(function (f) { return f.id === id; });
                    if (chosen) {
                        callback(chosen.url, { text: chosen.display_name });
                        dialogApi.close();
                    }
                }
            });
        });
}

options.tinyConfig.file_picker_callback = availfilesPickerCallback;
options.tinyConfig.file_picker_types = 'file';

(file_picker_types = 'file' restricts the picker to the plain-link case — TinyMCE also offers image/media pickers, which this package doesn't handle; leave those to whatever already handles image uploads.)

Translations

The package ships a Spanish translation (src/oscar_availfiles/locale/es/). Both the .po source and the compiled .mo are committed, so the wheel includes the .mo and nothing needs compiling on install. After editing a .po, recompile before releasing:

msgfmt -o src/oscar_availfiles/locale/es/LC_MESSAGES/django.mo \
    src/oscar_availfiles/locale/es/LC_MESSAGES/django.po

New strings are extracted with django-admin makemessages -l es run from src/oscar_availfiles/. A project can override any single string in its own LOCALE_PATHS without copying the whole catalogue. The AvailFile model's own strings live in django-availfiles, which has its own catalogue.

Development

uv sync
uv run pytest

Requires django-availfiles, wired in pyproject.toml's [tool.uv.sources] as a local path dependency until it's published.