IFormFile

Pflicht-Upload (DocumentUploadRequired)

Ohne mindestens ein übertragenes Dokument ist das Formular ungültig. Geprüft wird die Id-Liste, nicht das Upload-Feld selbst.

@model IFormFilePflichtBeispielViewModel

@* Ohne hochgeladenes Dokument meldet der Server beim Absenden einen Fehler: DocumentUploadRequired
   prüft die Id-Liste, nicht die IFormFile-Eigenschaft. *@

<form asp-area="FileUpload" asp-controller="IFormFilePflichtBeispiel" asp-action="Index" method="post">
    <div asp-validation-summary="All" class="text-danger"></div>
    @Html.EditorFor(m => m.NachweisIds)
    @Html.EditorFor(m => m.Nachweis)
    @Html.Fmh(Fmh.Button()
        .Text("Absenden")
        .Size(ButtonSize.Sm)
        .Attributes(new { @class = "mt-3" }))
</form>
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using FMH.Komponente.Basis.Ui.Validation.DataAnnotation;
using FMH.Komponente.FileUpload.Ui.Validation.DataAnnotation;
using FMH.Komponente.Infrastruktur;
using Microsoft.AspNetCore.Http;

namespace FMH.Komponente.WebUI.Areas.FileUpload.Models
{
    public class IFormFilePflichtBeispielViewModel
    {
        [Display(Name = "Nachweis (mindestens ein Dokument)")]
        [UIHint("IFormFile")]
        [AdditionalMetadata(MvcConst.MetaDataUploadUrl, "/FileUpload/IFormFilePflichtBeispiel/Upload")]
        [DocumentUploadRequired]
        public IFormFile Nachweis { get; set; }

        // Die Prüfung von DocumentUploadRequired sucht genau diese Eigenschaft:
        // Name des Upload-Feldes + "Ids". Ist die Liste leer, ist das Formular ungültig.
        [UIHint("HiddenList")]
        public List<int> NachweisIds { get; set; } = new List<int>();
    }
}
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using FMH.Komponente.Basis.Erweiterungen;
using FMH.Komponente.Basis.Ui.Feedback.Alert;
using FMH.Komponente.WebUI.Areas.FileUpload.Models;
using Microsoft.AspNetCore.Mvc;

namespace FMH.Komponente.WebUI.Areas.FileUpload.Controllers.Beispiele
{
    // Ein Beispiel, ein Controller: Upload-Endpunkt, Ablage und Formular-Round-Trip stehen
    // vollständig in dieser Datei. Lerninhalt hier: [DocumentUploadRequired] prüft die Id-Liste,
    // deshalb entscheidet ModelState.IsValid darüber, ob überhaupt eine Datei da ist.
    [Area("FileUpload")]
    public class IFormFilePflichtBeispielController : Controller
    {
        // Ablage der Demo: In einem Projekt landen die Dateien in der Datenbank oder im
        // Dokumentenspeicher; hier genügt der Dateiname je vergebener Id, damit sich der
        // Round-Trip nachvollziehen lässt. Statisch, weil die Demo keine Sitzung kennt.
        private static readonly ConcurrentDictionary<int, string> Dokumente = new ConcurrentDictionary<int, string>();

        private static int letzteId;

        [HttpGet]
        public IActionResult Index()
        {
            return this.View(new IFormFilePflichtBeispielViewModel());
        }

        [HttpPost]
        [ValidateAntiForgeryToken]
        public IActionResult Index(IFormFilePflichtBeispielViewModel modell)
        {
            if (this.ModelState.IsValid)
            {
                // Gültig heisst hier: NachweisIds enthält mindestens einen Eintrag.
                // PRG-Pattern (Post-Redirect-Get): Meldung merken und per Redirect auf die GET-Action.
                this.AddAlert($"Formular übertragen – {this.BeschreibeUpload(modell.NachweisIds)}", AlertType.Success, autoHide: true);
                return this.RedirectToAction(nameof(this.Index));
            }

            // Ungültig: kein Dokument übertragen -> dieselbe View mit der Fehlermeldung.
            return this.View(modell);
        }

        /// <summary>
        /// Der Upload-Endpunkt dieses Beispiels; seine Adresse steht als
        /// <see cref="FMH.Komponente.Infrastruktur.MvcConst.MetaDataUploadUrl" /> am ViewModel.
        /// Die Dropzone schickt jede Datei einzeln hierher, sobald der Dialog bestätigt wurde.
        /// Antwort muss ein Json mit der Eigenschaft <c>id</c> sein — das Template legt daraus ein
        /// verstecktes Feld <c>&lt;Feldname&gt;Ids</c> im Formular an. Fehlt die Id, lädt die Seite neu.
        /// </summary>
        /// <returns>Json mit der vergebenen Id.</returns>
        [HttpPost]
        public IActionResult Upload()
        {
            // Die Dropzone meldet sich mit diesem Kopfzeilen-Eintrag. In einem Projekt lässt sich
            // daran ein normaler Formular-Post von einem Dropzone-Upload unterscheiden.
            if (this.Request.Headers.ContainsKey("IsDropzoneRequest") == false || this.Request.Form.Files.Count == 0)
            {
                return this.Json(new { id = 0 });
            }

            var datei = this.Request.Form.Files[0];

            // Der im Dialog erfasste Dateiname kommt als eigenes Formularfeld mit, der Inhalt als Datei.
            var bezeichnung = this.Request.Form["DateiBezeichnung"].ToString();
            var name = string.IsNullOrWhiteSpace(bezeichnung) ? datei.FileName : bezeichnung;

            var id = Interlocked.Increment(ref letzteId);
            Dokumente[id] = name;

            return this.Json(new { id });
        }

        // Nur für die Rückmeldung: macht aus den Ids wieder die Dateinamen.
        private string BeschreibeUpload(IReadOnlyCollection<int> ids)
        {
            if (ids == null || ids.Count == 0)
            {
                return "Keine Dateien übertragen.";
            }

            var namen = ids.Select(id => Dokumente.TryGetValue(id, out var name) ? name : $"Id {id}");
            return $"{ids.Count} Datei(en): {string.Join(", ", namen)}";
        }
    }
}

Darstellung

attach_file

Drag files here or click here to upload.

report_problem

You can not upload any more files.

[DocumentUploadRequired] macht den Upload zur Pflicht. Geprüft wird nicht die IFormFile-Eigenschaft (die im POST immer leer ist), sondern die Id-Liste:

[Display(Name = "Nachweis (mindestens ein Dokument)")]
[UIHint("IFormFile")]
[DocumentUploadRequired]
public IFormFile Nachweis { get; set; }

[UIHint("HiddenList")]
public List<int> NachweisIds { get; set; } = new List<int>();

Wie die Prüfung arbeitet

  • Sie sucht die Eigenschaft <Feldname>Ids am Modell. Ist sie leer oder null, ist das Formular ungültig und die Meldung stammt aus den Ressourcen (Document_Required).
  • Zusätzlich wertet sie das versteckte Feld <Feldname>ExistingDocuments aus, das das Template immer mitrendert: Sind bereits Dokumente vorhanden (Bearbeitungsfall), gilt die Bedingung als erfüllt, auch wenn in diesem Durchgang nichts hochgeladen wurde. Dafür wird IHttpContextAccessor benötigt — in Program.cs mit AddHttpContextAccessor() registrieren.
  • Der Zähler dahinter kommt aus ExistingDocumentsProperty (Name einer Sammlung am ViewModel mit den bestehenden Dokumenten).

Was zu beachten ist

  • Die Prüfung läuft serverseitig. Das IFormFile-Template rendert keine unaufdringlichen Client-Attribute, die Meldung erscheint also nach dem Absenden — eine asp-validation-summary im Formular macht sie sichtbar.
  • Der Name der Id-Eigenschaft ist bindend: NachweisIds zu Nachweis. Ein Umbenennen des Upload-Feldes ohne die Id-Liste hebelt die Prüfung still aus.
  • Für eine bedingte Pflicht (nur, wenn ein anderes Feld einen bestimmten Wert hat) gibt es [DocumentUploadRequiredIf].