From aad23ca44951c27f0e15a1033c27c188147237d9 Mon Sep 17 00:00:00 2001 From: KoCoder Date: Thu, 19 Mar 2026 14:36:12 +0100 Subject: [PATCH 1/9] Update: Quellenverzeichnis --- Allgemein.md | 19 +- ...uch-individueller-teil-Adam-Gaiswinkler.md | 68 ++++--- ...uch-individueller-teil-Florian-Edlmayer.md | 159 ++++++++-------- ...dividueller-teil-Konstantin-Hintermayer.md | 91 +++------- bibliographie.md | 4 + sources.bib | 171 ++++++++++++++++++ 6 files changed, 336 insertions(+), 176 deletions(-) create mode 100644 bibliographie.md create mode 100644 sources.bib diff --git a/Allgemein.md b/Allgemein.md index a7e2812..97876af 100644 --- a/Allgemein.md +++ b/Allgemein.md @@ -12,8 +12,10 @@ Als wir im Oktober kurzfristig eine neue Produktionsumgebung benötigten, wurde Für den „frischen Wind“ und das sorgfältige Korrekturlesen der Arbeit bedanken wir uns herzlich bei Frau Prof. Gertrude Brindlmayer. Ihr geschulter Blick auf Details, die dem Team im Arbeitsprozess entgangen waren, stellte eine große Bereicherung für die finale Qualität dieser Arbeit dar. -# Projektmanagement mit Scrum -## Grundlagen der Scrum-Methode +## 2. Projektmanagement mit Scrum + +### 2.1 Grundlagen der Scrum-Methode + Für die Organisation und Umsetzung des Projekts wurde das agile Projektmanagement-Framework Scrum verwendet. Scrum ist ein weit verbreitetes Vorgehensmodell in der Softwareentwicklung, das besonders für Projekte geeignet ist, bei denen sich Anforderungen im Laufe der Entwicklung verändern können. Im Gegensatz zu klassischen Projektmanagementmethoden arbeitet Scrum nicht mit einer vollständig im Voraus geplanten Entwicklung, sondern mit kurzen, wiederkehrenden Entwicklungszyklen. Das zentrale Element von Scrum ist der sogenannte Sprint. Ein Sprint stellt einen fest definierten Zeitraum dar, in dem bestimmte Funktionen oder Anforderungen umgesetzt werden. In diesem Projekt betrug die Dauer eines Sprints zwei Wochen. Innerhalb dieses Zeitraums arbeitete das Entwicklungsteam daran, ausgewählte Aufgaben zu implementieren und am Ende des Sprints ein funktionsfähiges Ergebnis zu präsentieren. @@ -23,7 +25,7 @@ Die agile Arbeitsweise von Scrum basiert auf einer iterativen und inkrementellen Die grundlegende Struktur und der Ablauf eines Scrum-Projekts sind in Abbildung X dargestellt. ![Scrum-Framework](image-2.png) -*Abbildung X: Übersicht des Scrum-Frameworks mit Rollen, Artefakten und Ereignissen* +_Abbildung X: Übersicht des Scrum-Frameworks mit Rollen, Artefakten und Ereignissen_ Die Abbildung zeigt die wichtigsten Elemente des Scrum-Frameworks. Auf der linken Seite sind die Anforderungen des Projekts dargestellt, die im sogenannten Product Backlog gesammelt werden. Dieses Backlog enthält alle geplanten Funktionen, Verbesserungen und Aufgaben des Projekts. Diese Anforderungen stammen häufig von Stakeholdern oder zukünftigen Benutzern der Anwendung. @@ -39,7 +41,8 @@ Anschließend folgt die Sprint Retrospective, in der das Team den Ablauf des ver Durch diese strukturierte Vorgehensweise ermöglicht Scrum eine kontinuierliche Weiterentwicklung der Software sowie eine regelmäßige Überprüfung des Projektfortschritts. -## Rollenverteilung im Projektteam +### 2.2 Rollenverteilung im Projektteam + Das Scrum-Framework definiert drei zentrale Rollen, die jeweils unterschiedliche Aufgaben innerhalb des Projekts übernehmen. Diese Rollen tragen dazu bei, Verantwortlichkeiten klar zu strukturieren und den Entwicklungsprozess effizient zu gestalten. Der Product Owner ist für die inhaltliche Planung des Produkts verantwortlich. Zu seinen Aufgaben gehört die Verwaltung und Priorisierung des Product Backlogs. Er entscheidet, welche Funktionen oder Anforderungen für das Produkt am wichtigsten sind und sorgt dafür, dass das Entwicklungsteam stets an den relevantesten Aufgaben arbeitet. Außerdem fungiert der Product Owner als Verbindung zwischen Stakeholdern und Entwicklungsteam. @@ -50,7 +53,8 @@ Das Entwicklungsteam ist für die technische Umsetzung der Anforderungen verantw Durch diese klar definierten Rollen wird sichergestellt, dass organisatorische und technische Aufgaben effizient verteilt werden können und der Entwicklungsprozess strukturiert abläuft. -## Sprintplanung und Umsetzung +### 2.3 Sprintplanung und Umsetzung + Die Sprintplanung stellt einen wichtigen Bestandteil des Scrum-Prozesses dar. Zu Beginn jedes neuen Sprints trifft sich das Team, um gemeinsam zu entscheiden, welche Aufgaben innerhalb des kommenden Zeitraums umgesetzt werden sollen. Als Grundlage dient das Product Backlog, in dem alle bekannten Anforderungen des Projekts gesammelt werden. Während der Sprintplanung wählt das Team jene Aufgaben aus, die innerhalb der nächsten zwei Wochen realistisch umgesetzt werden können. Diese Aufgaben werden anschließend in das Sprint Backlog übernommen. @@ -67,7 +71,8 @@ Durch diese regelmäßige Abstimmung wird sichergestellt, dass alle Teammitglied Am Ende eines Sprints werden die entwickelten Funktionen im Sprint Review präsentiert. In diesem Meeting wird überprüft, welche Anforderungen erfolgreich umgesetzt wurden und ob weitere Anpassungen notwendig sind. Anschließend reflektiert das Team im Rahmen der Sprint Retrospective den Arbeitsprozess und identifiziert mögliche Verbesserungen für zukünftige Sprints. -## Vorteile von Scrum für die Webentwicklung +### 2.4 Vorteile von Scrum für die Webentwicklung + Die Verwendung von Scrum bietet insbesondere für Webentwicklungsprojekte zahlreiche Vorteile. Webanwendungen entwickeln sich häufig dynamisch weiter, da sich Anforderungen, Technologien oder Benutzerbedürfnisse im Laufe der Zeit verändern können. Durch die Aufteilung der Entwicklung in kurze Sprints kann das Projekt flexibel auf solche Veränderungen reagieren. Neue Anforderungen können einfach in zukünftige Sprints integriert werden, ohne den gesamten Projektplan neu strukturieren zu müssen. @@ -76,4 +81,4 @@ Ein weiterer Vorteil liegt in der kontinuierlichen Überprüfung der entwickelte Darüber hinaus fördert Scrum die Zusammenarbeit innerhalb des Teams. Regelmäßige Meetings und eine transparente Aufgabenverteilung sorgen dafür, dass alle Teammitglieder stets über den aktuellen Stand des Projekts informiert sind. -Insgesamt ermöglicht Scrum eine strukturierte, flexible und transparente Vorgehensweise bei der Entwicklung von Webanwendungen. Dadurch kann die Qualität der entwickelten Software verbessert und der Entwicklungsprozess effizienter gestaltet werden. \ No newline at end of file +Insgesamt ermöglicht Scrum eine strukturierte, flexible und transparente Vorgehensweise bei der Entwicklung von Webanwendungen. Dadurch kann die Qualität der entwickelten Software verbessert und der Entwicklungsprozess effizienter gestaltet werden. diff --git a/Diplomarbeitsbuch-individueller-teil-Adam-Gaiswinkler.md b/Diplomarbeitsbuch-individueller-teil-Adam-Gaiswinkler.md index 300460d..a72e458 100644 --- a/Diplomarbeitsbuch-individueller-teil-Adam-Gaiswinkler.md +++ b/Diplomarbeitsbuch-individueller-teil-Adam-Gaiswinkler.md @@ -1,6 +1,4 @@ -# Diplomarbeitsbuch – Individueller Teil - ---- +# Adam Gaiswinkler ## 1. Einleitung @@ -235,23 +233,23 @@ Das Modul verwendet zwei Entitäten, die in der Datenbank als Tabellen abgebilde Die zentrale Entität repräsentiert einen einzelnen Absolventeneintrag und wird in der Datenbanktabelle `SZUAbsolventenvereinHallOfFame` gespeichert. -| Spalte | Datentyp | Beschreibung | -|--------|----------|--------------| -| `HallOfFameId` | `int` (PK, Auto-Inkrement) | Primärschlüssel | -| `ModuleId` | `int` (FK → `Module`) | Fremdschlüssel zur Oqtane-Modulinstanz | -| `Name` | `string` | Name der Person | -| `Year` | `int` | Abschlussjahrgang | -| `Description` | `string` | Beschreibung bzw. Werdegang | -| `Image` | `string` | Relativer Pfad zum hochgeladenen Foto | -| `Link` | `string` | Optionaler externer Link | -| `Status` | `string` (max. 50) | Veröffentlichungsstatus: „Draft" oder „Published" | -| `UserId` | `int` | ID der Benutzerin bzw. des Benutzers, der den Eintrag erstellt hat | -| `IsReported` | `bool` | Kennzeichnung, ob der Eintrag gemeldet wurde | -| `ReportReason` | `string` | (Legacy) Ursprüngliches Feld für Meldegrund, abgelöst durch die Report-Tabelle | -| `CreatedBy` | `string` | Erstellt von (Audit) | -| `CreatedOn` | `DateTime` | Erstellzeitpunkt (Audit) | -| `ModifiedBy` | `string` | Zuletzt geändert von (Audit) | -| `ModifiedOn` | `DateTime` | Zeitpunkt der letzten Änderung (Audit) | +| Spalte | Datentyp | Beschreibung | +| -------------- | -------------------------- | ------------------------------------------------------------------------------ | +| `HallOfFameId` | `int` (PK, Auto-Inkrement) | Primärschlüssel | +| `ModuleId` | `int` (FK → `Module`) | Fremdschlüssel zur Oqtane-Modulinstanz | +| `Name` | `string` | Name der Person | +| `Year` | `int` | Abschlussjahrgang | +| `Description` | `string` | Beschreibung bzw. Werdegang | +| `Image` | `string` | Relativer Pfad zum hochgeladenen Foto | +| `Link` | `string` | Optionaler externer Link | +| `Status` | `string` (max. 50) | Veröffentlichungsstatus: „Draft" oder „Published" | +| `UserId` | `int` | ID der Benutzerin bzw. des Benutzers, der den Eintrag erstellt hat | +| `IsReported` | `bool` | Kennzeichnung, ob der Eintrag gemeldet wurde | +| `ReportReason` | `string` | (Legacy) Ursprüngliches Feld für Meldegrund, abgelöst durch die Report-Tabelle | +| `CreatedBy` | `string` | Erstellt von (Audit) | +| `CreatedOn` | `DateTime` | Erstellzeitpunkt (Audit) | +| `ModifiedBy` | `string` | Zuletzt geändert von (Audit) | +| `ModifiedOn` | `DateTime` | Zeitpunkt der letzten Änderung (Audit) | Die Entität implementiert das Oqtane-Interface `IAuditable`, wodurch die Audit-Felder automatisch vom Framework befüllt werden. Der Fremdschlüssel `ModuleId` verknüpft jeden Eintrag mit einer bestimmten Modulinstanz und ermöglicht so den Multi-Tenant-Betrieb. @@ -259,15 +257,15 @@ Die Entität implementiert das Oqtane-Interface `IAuditable`, wodurch die Audit- Die zweite Entität bildet einzelne Meldungen zu einem Eintrag ab und wird in der Tabelle `SZUAbsolventenvereinHallOfFameReport` gespeichert. -| Spalte | Datentyp | Beschreibung | -|--------|----------|--------------| -| `HallOfFameReportId` | `int` (PK, Auto-Inkrement) | Primärschlüssel | -| `HallOfFameId` | `int` (FK → `SZUAbsolventenvereinHallOfFame`) | Zugehöriger Eintrag | -| `Reason` | `string` | Meldegrund | -| `CreatedBy` | `string` | Erstellt von (Audit) | -| `CreatedOn` | `DateTime` | Erstellzeitpunkt (Audit) | -| `ModifiedBy` | `string` | Zuletzt geändert von (Audit) | -| `ModifiedOn` | `DateTime` | Zeitpunkt der letzten Änderung (Audit) | +| Spalte | Datentyp | Beschreibung | +| -------------------- | --------------------------------------------- | -------------------------------------- | +| `HallOfFameReportId` | `int` (PK, Auto-Inkrement) | Primärschlüssel | +| `HallOfFameId` | `int` (FK → `SZUAbsolventenvereinHallOfFame`) | Zugehöriger Eintrag | +| `Reason` | `string` | Meldegrund | +| `CreatedBy` | `string` | Erstellt von (Audit) | +| `CreatedOn` | `DateTime` | Erstellzeitpunkt (Audit) | +| `ModifiedBy` | `string` | Zuletzt geändert von (Audit) | +| `ModifiedOn` | `DateTime` | Zeitpunkt der letzten Änderung (Audit) | Der Fremdschlüssel zu `SZUAbsolventenvereinHallOfFame` ist mit kaskadierendem Löschen konfiguriert, sodass beim Löschen eines Eintrags automatisch alle zugehörigen Meldungen entfernt werden. Zwischen den beiden Entitäten besteht eine 1:n-Beziehung: Ein Eintrag kann beliebig viele Meldungen besitzen. @@ -275,13 +273,13 @@ Der Fremdschlüssel zu `SZUAbsolventenvereinHallOfFame` ist mit kaskadierendem L Die Datenbankstruktur wird über Entity Framework Core Migrationen versioniert verwaltet. -| Migration | Versionsnummer | Inhalt | -|-----------|----------------|--------| -| `InitializeModule` | `01.00.00.00` | Erstellt die Haupttabelle mit allen Grundspalten sowie den Audit-Spalten | -| `AddReportingColumns` | `01.00.00.02` | Erweitert die Haupttabelle um die Spalten `IsReported` und `ReportReason` | +| Migration | Versionsnummer | Inhalt | +| --------------------- | -------------- | ------------------------------------------------------------------------- | +| `InitializeModule` | `01.00.00.00` | Erstellt die Haupttabelle mit allen Grundspalten sowie den Audit-Spalten | +| `AddReportingColumns` | `01.00.00.02` | Erweitert die Haupttabelle um die Spalten `IsReported` und `ReportReason` | > **Hinweis:** Version `01.00.00.01` wurde im Entwicklungsprozess übersprungen, da eine fehlerhafte Migration erstellt und anschließend wieder gelöscht werden musste. -| `AddReportTable` | `01.00.00.03` | Erstellt die eigenständige Report-Tabelle mit Fremdschlüssel zur Haupttabelle | +> | `AddReportTable` | `01.00.00.03` | Erstellt die eigenständige Report-Tabelle mit Fremdschlüssel zur Haupttabelle | #### Implementierungsdetails und Problemlösungen @@ -395,8 +393,8 @@ Neben den technischen Tests wurde die Plattform auch von weiteren Personen – d Ein häufiges Feedback war, dass die Unterscheidung zwischen Zusage und Absage auf den ersten Blick nicht immer sofort klar war. Daraufhin wurden die Schaltflächen farblich deutlicher gestaltet – Grün für die Zusage, Rot für die Absage – und die Beschriftungen präzisiert. Solche Rückmeldungen aus echten Nutzertests sind wertvoll, weil Entwicklerinnen und Entwickler ihre eigene Anwendung oft anders wahrnehmen als Personen, die das System zum ersten Mal sehen. - --- + ## 7. Fazit und Ausblick ### 7.1 Zielerreichung diff --git a/Diplomarbeitsbuch-individueller-teil-Florian-Edlmayer.md b/Diplomarbeitsbuch-individueller-teil-Florian-Edlmayer.md index 9dcc898..4061725 100644 --- a/Diplomarbeitsbuch-individueller-teil-Florian-Edlmayer.md +++ b/Diplomarbeitsbuch-individueller-teil-Florian-Edlmayer.md @@ -1,32 +1,27 @@ ---- -include_toc: true -gitea: none ---- -# 1. Einleitung des individuellen Teils -## 1.1 Ausgangssituation -Der Absolventenverein der HTL Ungargasse hatte keine digitale Infrastruktur zur Vernetzung seiner Mitglieder. AlumniHub soll das ändern: eine zentrale Plattform für Mitgliederverwaltung, Veranstaltungen und Netzwerkfunktionen. +# Florian Edlmayer -## 1.2 Zielsetzung -Mein persönlicher Beitrag umfasst die DSGVO-konforme Datenschutzimplementierung, ein automatisiertes Backup- und Restore-System, die Anbindung von LinkedIn als externem Identitätsanbieter sowie den Premium-Bereich. +## 1. Einleitung des individuellen Teils + +In diesem Abschnitt wird meine persönliche Aufgabenstellung im Rahmen des Projektes (Alumnihub) beschrieben. + +### 1.1 Auftrag / persönliche Aufgabenstellungen ## 1.3 Nutzen für den Absolventenverein + Für den Verein bedeutet das: rechtskonforme Datenverarbeitung, gesicherte Datenverfügbarkeit und ein niedrigschwelliger Login für Absolventinnen und Absolventen mit bestehendem LinkedIn-Konto. +## 2. Anforderungen an das entwickelte Modul bzw. die Funktionalität -# 2. Anforderungen an das entwickelte Modul bzw. die Funktionalität -funktionale / nicht‑funktionale Anforderungen +### 2.1 Modulanforderungen / funktionale Anforderungen -Use Cases - -# 3. Individuelle Themenstellung & Zielsetzung -## 3.1 Themenstellung +### 2.2 Infrastrukturanforderungen / nicht‑funktionale Anforderungen ### Entwicklung eines CMS-Moduls • **Premiumbereich:** Ein Schwerpunkt der Arbeit ist die Entwicklung eines Oqtane-Moduls, das einen Premiumbereich bereitstellt. Dieser Bereich soll ausschließlich autorisierten Benutzerinnen und Benutzern zugänglich sein und spezielle Inhalte oder Funktionen anbieten wie zum Beispiel das hochladen und ansehen von Ingeneuranträgen als Vorlage oder das finden und Kontakt aufnehmen mit anderen Benutzern. Dabei werden grundlegende Konzepte wie Benutzerrollen, Zugriffsrechte und die Integration in das bestehende CMS eingebunden. -### Erstellung einer Datenschutzerklärung +#### Erstellung einer Datenschutzerklärung Eine weitere wichtige Aufgabe war die Erstellung einer gesetzeskonformen Datenschutzerklärung. Diese ist erforderlich, um die Nutzerinnen und Nutzer unserer Webanwendung transparent und verständlich darüber zu informieren, welche personenbezogenen Daten erhoben, verarbeitet und gespeichert werden, zu welchem Zweck dies geschieht und welche Rechte ihnen in Bezug auf ihre Daten zustehen. @@ -35,12 +30,15 @@ Eine weitere wichtige Aufgabe war die Erstellung einer gesetzeskonformen Datensc Zur Verbesserung der Benutzerfreundlichkeit und zur vereinfachten Anmeldung wird eine Anmeldung über LinkedIn mithilfe des OAuth-2.0-Protokolls implementiert. Diese ermöglicht es Benutzerinnen und Benutzern, sich mit einem bestehenden LinkedIn-Konto zu registrieren oder anzumelden. ### Datenbank-Backup und Restore + Abschließend wurde das Thema Datensicherung umfassend behandelt, da die Sicherstellung der Datenintegrität und Systemverfügbarkeit einen zentralen Bestandteil moderner Webanwendungen darstellt. In diesem Zusammenhang wurde ein Skript zur automatisierten Erstellung von Datenbank-Backups entwickelt, das in regelmäßigen Abständen Sicherungskopien der relevanten Daten erzeugt. Zusätzlich wurde ein weiteres Skript implementiert, das im Falle eines Datenverlusts oder Systemausfalls eine strukturierte und zuverlässige Wiederherstellung der gesicherten Daten ermöglicht. Ziel dieser Maßnahmen ist es, das Risiko von Datenverlusten zu minimieren und einen stabilen sowie sicheren Betrieb der Webanwendung zu gewährleisten. Die Backup- und Restore-Prozesse sollen automatisiert ablaufen, um menschliche Fehler zu reduzieren und eine kontinuierliche, regelmäßige Datensicherung sicherzustellen. Dadurch wird eine hohe Ausfallsicherheit sowie die langfristige Verfügbarkeit der gespeicherten Informationen gewährleistet. -## 3.2 Zielsetzung -### Technische Zielsetzung +### 3.2 Zielsetzung + +#### Technische Zielsetzung + Die technische Zielsetzung dieses Diplomarbeitsprojekts bestand darin, eine stabile und sichere Webplattform für Alumni zu entwickeln. Als technische Grundlage wurde das Content-Management-System Oqtane verwendet, welches auf modernen Webtechnologien basiert und eine modulare Erweiterung von Funktionen ermöglicht. Die Implementierung erfolgte innerhalb der von Oqtane bereitgestellten Architektur, wodurch verschiedene Funktionen effizient integriert werden konnten. Ein zentraler Bestandteil der technischen Umsetzung war die Integration einer externen Authentifizierung über LinkedIn mithilfe des Protokolls OAuth 2.0. Dadurch können sich Benutzer direkt mit ihrem LinkedIn-Konto auf der Plattform anmelden, ohne ein separates Benutzerkonto erstellen zu müssen. Dies vereinfacht den Registrierungsprozess und erhöht gleichzeitig die Sicherheit, da sensible Zugangsdaten ausschließlich beim externen Anbieter verbleiben. @@ -48,7 +46,8 @@ Ein zentraler Bestandteil der technischen Umsetzung war die Integration einer ex Zusätzlich wurde eine Datenbank auf Basis von PostgreSQL eingesetzt, um Benutzerinformationen, Inhalte sowie weitere Systemdaten zuverlässig zu speichern. Um die langfristige Verfügbarkeit dieser Daten sicherzustellen, wurde ein automatisiertes Backup-System implementiert. Dieses System erstellt regelmäßig Sicherungskopien der Datenbank sowie der wichtigsten Systemdateien. Ergänzend dazu wurde ein Restore-Skript entwickelt, mit dem gespeicherte Daten im Falle eines Systemfehlers oder Datenverlustes wiederhergestellt werden können. Ein weiterer wichtiger Aspekt der technischen Zielsetzung war die Einhaltung rechtlicher Anforderungen im Bereich Datenschutz. Daher wurde eine Datenschutzerklärung erstellt und die Plattform so konzipiert, dass personenbezogene Daten der Benutzer entsprechend den Vorgaben der Datenschutz-Grundverordnung verarbeitet werden. -### Funktionale Zielsetzung + +#### Funktionale Zielsetzung Die funktionale Zielsetzung des Projekts bestand darin, eine Onlineplattform zu entwickeln, die ehemaligen Schülerinnen und Schülern die Möglichkeit bietet, miteinander in Kontakt zu bleiben und sich über aktuelle Veranstaltungen zu informieren. Die Plattform dient somit als digitales Netzwerk für Alumni und soll den Austausch zwischen ehemaligen Mitgliedern der Bildungseinrichtung fördern. @@ -59,7 +58,8 @@ Darüber hinaus bietet die Plattform Funktionen zur Darstellung und Verwaltung v Zusätzlich wurde ein Premiumbereich entwickelt, der bestimmte Inhalte oder Funktionen exklusiv für berechtigte Benutzer bereitstellt. Dieser Bereich erweitert die Möglichkeiten der Plattform und ermöglicht es, spezielle Inhalte nur bestimmten Benutzergruppen zugänglich zu machen. Durch diese Funktionen entsteht eine Plattform, die nicht nur als Informationsquelle dient, sondern auch aktiv zur Vernetzung der Alumni beiträgt. -### Gestalterische Zielsetzung + +#### Gestalterische Zielsetzung Neben den technischen und funktionalen Anforderungen spielte auch die Gestaltung der Plattform eine wichtige Rolle. Ziel war es, eine übersichtliche und benutzerfreundliche Oberfläche zu entwickeln, die eine einfache Navigation und intuitive Bedienung ermöglicht. @@ -69,9 +69,10 @@ Darüber hinaus wurde darauf geachtet, dass die Plattform ein modernes Erscheinu Insgesamt verfolgt die gestalterische Zielsetzung das Ziel, eine Plattform zu schaffen, die sowohl funktional als auch optisch ansprechend ist und den Benutzern eine positive Nutzungserfahrung bietet. -# 4. Datenschutz und rechtliche Grundlagen +## 4. Datenschutz und rechtliche Grundlagen + +### 4.1 Bedeutung der Datenschutz-Grundverordnung (DSGVO) [@dsgvo] -## 4.1 Bedeutung der Datenschutz-Grundverordnung (DSGVO) [^1] Die Datenschutz-Grundverordnung (DSGVO) ist eine rechtsverbindliche Verordnung der Europäischen Union, die seit dem 25. Mai 2018 unmittelbar in allen EU-Mitgliedstaaten gilt und den Schutz personenbezogener Daten regelt. Sie wurde erlassen, um die Rechte natürlicher Personen bei der Verarbeitung ihrer Daten zu stärken und ein einheitliches Datenschutzniveau innerhalb der EU zu gewährleisten. Der Anwendungsbereich der DSGVO umfasst alle Verarbeitungen personenbezogener Daten, unabhängig davon, ob diese automatisiert oder in nicht-automatisierten Akten erfolgt. Personenbezogene Daten sind dabei definiert als alle Informationen, die sich auf eine identifizierte oder identifizierbare natürliche Person beziehen. @@ -91,7 +92,8 @@ Die DSGVO enthält dabei zentral die Grundsätze der Datenverarbeitung (Art. 5 D Die Einhaltung dieser Prinzipien ist für jede Organisation verpflichtend, die personenbezogene Daten verarbeitet – unabhängig von ihrer Größe oder Branche. Dies umfasst sowohl technische Aspekte der Datenverarbeitung als auch die Informationspflichten gegenüber Betroffenen, wie sie etwa in Datenschutzerklärungen umgesetzt werden müssen. -## 4.2 Umsetzung der Datenschutzanforderungen auf der Website [^2] +### 4.2 Umsetzung der Datenschutzanforderungen auf der Website [@ris] + Im Rahmen der Diplomarbeit wurde eine umfassende Analyse der Datenschutzanforderungen durchgeführt und entsprechende Maßnahmen zur Umsetzung auf der Website implementiert. Dabei wurden insbesondere die Vorgaben der DSGVO berücksichtigt, um sicherzustellen, dass die Website den geltenden Datenschutzbestimmungen entspricht. Ein zentrales Element der Umsetzung war die Erstellung einer gesetzeskonformen Datenschutzerklärung. Diese informiert die Nutzerinnen und Nutzer über: @@ -112,7 +114,8 @@ Neben der Informationspflicht wurden auch technische und organisatorische Maßna • Regelmäßige Sicherheitsupdates der eingesetzten Software • Minimierung der Datenerhebung auf das Notwendige: Es werden nur die Daten erhoben, die für die Funktion der Website unbedingt erforderlich sind. (Grundprinzip der Datenminimierung nach Art. 5 Abs. 1 lit. c DSGVO) -## 4.3 Schutz personenbezogener Daten der Benutzer [^3] +### 4.3 Schutz personenbezogener Daten der Benutzer [@dsb] + Der Schutz personenbezogener Daten der Benutzer stellt einen zentralen Bestandteil der Website des Absolventenvereins dar. Sämtliche Datenverarbeitungen erfolgen unter Berücksichtigung der Vorgaben der Datenschutz-Grundverordnung (DSGVO) sowie des österreichischen Datenschutzgesetzes (DSG). Gemäß Art. 5 Abs. 1 lit. c DSGVO gilt der Grundsatz der Datenminimierung, wonach nur jene personenbezogenen Daten erhoben werden dürfen, die für den jeweiligen Zweck erforderlich sind. Auf der Website werden daher ausschließlich solche Daten verarbeitet, die für die Verwaltung der Mitgliedschaft, die Organisation von Veranstaltungen sowie die Kommunikation mit Absolventinnen und Absolventen notwendig sind. @@ -129,22 +132,26 @@ Darüber hinaus besteht das Recht, sich bei der österreichischen Datenschutzbeh Durch die Kombination aus klar definierten Rechtsgrundlagen, transparenten Informationspflichten und technischen Schutzmaßnahmen wird ein hohes Datenschutzniveau gewährleistet und der verantwortungsvolle Umgang mit personenbezogenen Daten sichergestellt. -# 5. Automatisierung von Serverprozessen +## 5. Automatisierung von Serverprozessen -## 5.1 Notwendigkeit von Datensicherung [^4][^5] -Die Datensicherung ist ein wesentlicher Bestandteil der Website des Absolventenvereins. Sie dient dazu, die auf der Website gespeicherten Daten vor Verlust oder Beschädigung zu schützen. Digitale Daten bilden die Grundlage für die Funktion der Website und müssen daher regelmäßig gesichert werden. Ein Verlust oder eine Beschädigung der Daten kann zu erheblichen Problemen führen. +### 5.1 Notwendigkeit von Datensicherung [@bsi_datensicherung][@chatgpt_datensicherung] + +Die Datensicherung ist ein wesentlicher Bestandteil der Website des Absolventenvereins. Sie dient dazu, die auf der Website gespeicherten Daten vor Verlust oder Beschädigung zu schützen.Digitale Daten bilden die Grundlage für die Funktion der Website und müssen daher regelmäßig gesichert werden. Ein Verlust oder eine Beschädigung der Daten kann zu erheblichen Problemen führen. Mögliche Ursachen für einen Datenverlust sind unter anderem Hardwaredefekte, Softwarefehler, menschliches Versagen oder Cyberangriffe. Ohne geeignete Sicherheitsmaßnahmen besteht das Risiko, dass Daten unwiederbringlich verloren gehen oder nur mit erheblichen Kosten wiederhergestellt werden können. Neben der technischen besteht ebenfalls eine rechtliche und organisatorische Notwendigkeit der Datensicherung. Gemäß Art. 5 Abs. 1 lit. f DSGVO müssen personenbezogene Daten gesichert werden, um die Integrität und Vertraulichkeit der Daten zu gewährleisten. Dazu zählt auch der Schutz vor unbeabsichtigtem Verlust. Eine Backup-Sicherung ist daher ein notwendiger Schritt, um die Daten vor Verlust zu schützen. ## 5.2 Konzeption des Backup-Systems + Ziel des Backup-Systems war es im Falle eines Datenverlustes oder eines Systemausfalls die Daten wiederherstellen zu können. Es wurde eine Strategie entwickelt die es ermöglicht sowohl die Datenbank als auch die Dateien auf dem Server zu sichern. Der Umfang des Backups besteht aus zwei zentralen Komponenten: + 1. Die PostgreSQL-Datenbank 2. Der Ordner "oqtane.server" auf dem Server - + Damit wird eine vollständige Sicherung der Website ermöglicht, da bei einer reinen Datenbanksicherung wichtige Anwendungsdateien fehlen würden. + ```mermaid graph TD %% Styling @@ -154,7 +161,7 @@ graph TD Start((Start: Cronjob 02:30)) --> Init[Initialisierung: set -euo pipefail] Init --> Vars[Definiere Pfade & PG-Credentials] - + subgraph Sicherungsphase Dir[Erstelle Verzeichnis: /var/backups/UTC_TS] --> DB[pg_dump -Fc: Custom Format Dump] DB --> Files[tar -cvpzf: Komprimierung oqtane.server] @@ -178,6 +185,7 @@ graph TD class Init,Vars,Dir,DB,Files,Rotate,Delete,Finish process; class Mail critical; ``` + Alle Backups werden lokal auf dem Server gespeichert. Diese Backups sind alle zu finden unter: /var/backups Für jedes Backup wird in diesem Verzeichnis ein Unterordner erstellt, dessen Name einen UTC-Zeitstempel enthält. Das ermöglicht eine saubere Trennung der Sicherungsstände und einfache chronologische Zuordnung. @@ -243,7 +251,8 @@ Durch diesen Rotationsmechanismus wird verhindert, dass sich im Laufe der Zeit e Die gewählte Anzahl von 30 Sicherungen ermöglicht es, bei täglicher Ausführung des Backup-Skripts ungefähr einen Monat an Wiederherstellungspunkten vorzuhalten. Dadurch wird ein sinnvoller Kompromiss zwischen Datensicherheit und effizienter Speicherverwaltung erreicht. -## 5.3 Implementierung der Backup-Skripte +### 5.3 Implementierung der Backup-Skripte + Die Implementierung des Backup-Systems erfolgte mittels eines Bash-Skripts, das auf dem Linux-Server ausgeführt wird. Bash eignet sich besonders für administrative Aufgaben, da sie direkten Zugriff auf Systembefehle, Dateien und Prozesse bietet. Das Skript wurde so aufgebaut, dass es robust, automatisierbar und nachvollziehbar arbeitet. Zu Beginn des Skripts wird folgende Konfiguration gesetzt: @@ -300,7 +309,8 @@ Die Implementierung zeichnet sich durch folgende Eigenschaften aus: • automatische Speicherverwaltung durch Rotationsmechanismus Durch diese Umsetzung wurde ein zuverlässiges und wartbares Backup-System geschaffen, das den kontinuierlichen Betrieb der Webanwendung unterstützt und im Fehlerfall eine schnelle Wiederherstellung ermöglicht. -## 5.4 Wiederherstellung von Daten mittels Restore-Skripten + +### 5.4 Wiederherstellung von Daten mittels Restore-Skripten Neben der Datensicherung stellt die strukturierte Wiederherstellung der Daten einen zentralen Bestandteil des Backup-Systems dar. Zu diesem Zweck wurde ein eigenes Bash-Skript implementiert, das sowohl die PostgreSQL-Datenbank als auch die Anwendungsdateien aus einem gewählten Backup-Ordner wiederherstellt (Restore-Skript). Ziel war es, einen klar definierten und kontrollierten Prozess zu schaffen, der im Fehlerfall eine vollständige Rücksetzung des Systems ermöglicht. @@ -373,7 +383,7 @@ Der Parameter -x extrahiert das Archiv, -p stellt die ursprünglichen Dateiberec Zusammenfassend ermöglicht das Restore-Skript eine vollständige Rücksetzung der Webanwendung auf einen definierten Sicherungsstand. Durch die Kombination aus Sicherheitsabfrage, kontrollierter Datenbank-Neuerstellung und strukturiertem Dateirestore wird ein zuverlässiger und nachvollziehbarer Wiederherstellungsprozess gewährleistet. Das System ergänzt somit das Backup-Konzept um eine praxisnahe und technisch saubere Lösung für den Ernstfall. -## 5.5 Fazit zur Datensicherung +### 5.5 Fazit zur Datensicherung Durch die Implementierung eines automatisierten Backup- und Restore-Systems wurde eine zuverlässige Grundlage für die Datensicherheit der Webanwendung geschaffen. Das entwickelte System ermöglicht eine regelmäßige Sicherung sowohl der PostgreSQL-Datenbank als auch der vollständigen Anwendungsdateien. Durch die automatisierte Ausführung mittels Cronjob wird sichergestellt, dass die Backups ohne manuelles Eingreifen täglich erstellt werden. @@ -384,21 +394,24 @@ Neben der Datensicherung wurde auch ein Restore-Skript implementiert, das eine v Insgesamt stellt das entwickelte Backup-System eine robuste und praxisnahe Lösung dar, die den sicheren Betrieb der Webanwendung unterstützt und im Fehlerfall eine schnelle Wiederherstellung der Daten ermöglicht. # 6. Benutzerverwaltung und Authentifizierung per LinkedIn + ## 6.1 Authentifizierung mittels OAuth 2.0 + Zur Anmeldung auf der entwickelten Webplattform wurde eine Authentifizierung über das Business-Netzwerk LinkedIn implementiert. Dabei kommt das standardisierte Autorisierungsprotokoll OAuth 2.0 zum Einsatz [^6]. Dieses Verfahren ermöglicht es, Benutzer über externe Identitätsanbieter zu authentifizieren, ohne dass deren Zugangsdaten direkt an die Webanwendung übertragen werden müssen. OAuth 2.0 basiert auf dem Prinzip der delegierten Autorisierung. Dabei erlaubt ein Benutzer einer Anwendung, bestimmte Informationen seines Kontos bei einem externen Dienst zu verwenden. Die eigentlichen Zugangsdaten – beispielsweise das LinkedIn-Passwort – verbleiben dabei ausschließlich beim Identitätsanbieter. Der grundlegende Ablauf einer OAuth-Authentifizierung ist in Abbildung X dargestellt. Dabei wird der Benutzer zunächst zur Login-Seite des externen Anbieters weitergeleitet. Nach erfolgreicher Anmeldung bestätigt der Benutzer, dass die Anwendung Zugriff auf bestimmte Profildaten erhalten darf. ![OAuth-Authentifizierungsablauf](image.png) -*Abbildung: Ablauf der OAuth-Authentifizierung (Erstellt mit ChatGPT)* +_Abbildung: Ablauf der OAuth-Authentifizierung (Erstellt mit ChatGPT)_ Die Abbildung zeigt den Ablauf der OAuth-Authentifizierung. Zunächst erfolgt die Weiterleitung zur LinkedIn-Anmeldeseite, anschließend wird ein Autorisierungscode (Authorization Code) an die Webanwendung zurückgegeben, welcher gegen einen Zugriffstoken (Access Token) ausgetauscht wird. Nach der Autorisierung sendet LinkedIn einen solchen Autorisierungscode an die Webanwendung zurück. Dieser Code wird anschließend vom Server der Anwendung gegen ein Zugriffstoken ausgetauscht. Mit Hilfe dieses Tokens kann die Webanwendung anschließend die freigegebenen Benutzerdaten vom LinkedIn-Server abrufen. Der Vorteil dieses Verfahrens liegt darin, dass die Webanwendung zu keinem Zeitpunkt Zugriff auf das Passwort des Benutzers erhält. Dadurch wird ein höheres Sicherheitsniveau erreicht und gleichzeitig die Benutzerfreundlichkeit verbessert, da sich Benutzer mit ihrem bestehenden LinkedIn-Konto anmelden können. -## 6.2 Technische Umsetzung der LinkedIn-Anmeldung in Oqtane + +### 6.2 Technische Umsetzung der LinkedIn-Anmeldung in Oqtane Die technische Umsetzung der LinkedIn-Authentifizierung erfolgte über das integrierte External Login System [^8] des Content-Management-Systems Oqtane. Dieses System ermöglicht die Integration externer Identitätsanbieter über standardisierte Protokolle wie OAuth 2.0. @@ -430,7 +443,8 @@ In der Konfiguration wurde außerdem festgelegt, welche Benutzerdaten von Linked Diese Daten werden von Oqtane als sogenannte Claims verarbeitet und anschließend dem Benutzerkonto der Plattform zugeordnet. Darüber hinaus wurde in den Einstellungen aktiviert, dass bei der ersten Anmeldung automatisch ein neues Benutzerkonto erstellt werden kann. Dadurch können sich neue Nutzer direkt über ihr LinkedIn-Konto registrieren. -## 6.3 Ablauf des Anmeldeprozesses + +### 6.3 Ablauf des Anmeldeprozesses Der eigentliche Anmeldevorgang erfolgt in mehreren aufeinanderfolgenden Schritten. Zunächst wählt der Benutzer auf der Login-Seite der Webplattform die Option zur Anmeldung über LinkedIn aus. @@ -440,8 +454,10 @@ Nach erfolgreicher Authentifizierung sendet LinkedIn eine Antwort an die zuvor d Wie in Abschnitt 6.1 beschrieben, werden die abgerufenen Profildaten zur Identifikation oder Neuanlage des Benutzerkontos in der lokalen Datenbank verwendet. -# 7. Implementierung des Premium-Bereichs -## 7.1 Ziel und Zweck des Premium-Bereichs +## 7. Implementierung des Premium-Bereichs + +### 7.1 Ziel und Zweck des Premium-Bereichs + Der Premium-Bereich wurde mit dem Ziel entwickelt, den Mitgliedern des SZU Absolventenvereins einen klar abgegrenzten, exklusiven Bereich innerhalb der Vereinswebsite bereitzustellen. Das Premium-Bereich-Modul ist eine Erweiterung für das Content-Management-System Oqtane und bildet das Kernstück des digitalen Mitgliederbereichs. Es ermöglicht Mitgliedern, sich über das Hochladen eines Ingenieur-Antrags als PDF-Dokument für eine zeitlich begrenzte Premium-Mitgliedschaft zu qualifizieren. Premium-Mitglieder erhalten Zugang zu exklusiven Funktionen wie dem Einsehen genehmigter Anträge anderer Mitglieder sowie einer Mitgliedersuche mit integrierter Kontaktfunktion. Der zentrale Zweck besteht darin, einen Anreiz für aktives Engagement im Verein zu schaffen. Dadurch entsteht ein Kreislauf, in dem qualitativ hochwertige Anträge die Wissensbasis der Gemeinschaft bereichern und gleichzeitig den einreichenden Mitgliedern einen konkreten Gegenwert in Form von Premium-Funktionen bieten. Der Premium-Bereich dient darüber hinaus als digitales Netzwerk-Instrument. Durch die Kombination aus Antrags-Einsicht, Mitgliedersuche und Kontaktfunktion wird eine Plattform geschaffen, die den fachlichen Austausch zwischen Absolventen fördert und die Vernetzung innerhalb der Gemeinschaft stärkt. Die zeitliche Begrenzung der Premium-Mitgliedschaft auf 12 Monate sorgt dafür, dass Mitglieder regelmäßig aktiv bleiben und neue Inhalte beitragen, um ihren Premium-Status aufrechtzuerhalten. @@ -474,6 +490,7 @@ graph TD ``` ## 7.2 Funktionalität und Features des Premium-Bereichs + Der Premium-Bereich umfasst mehrere miteinander verknüpfte Funktionen, die gemeinsam ein geschlossenes System bilden. **Ingenieur-Antrags-Workflow** @@ -647,7 +664,8 @@ public class AddPremiumTables : MultiDatabaseMigration Insgesamt definieren vier Migrationen die Datenbankstruktur: Die erste erstellt die Basistabelle des Moduls, die zweite fügt die drei Tabellen für Ingenieur-Anträge, Premium-Status und Premium-Events hinzu, die dritte entfernt nicht mehr benötigte Spalten nach der Umstellung auf den Oqtane FileManager, und die vierte ergänzt die Felder für Titel und Kurzbeschreibung. Alle Migrationen werden bei der Modulinstallation automatisch ausgeführt. -## 7.3 Zugriffsbeschränkung und Benutzerrechte +### 7.3 Zugriffsbeschränkung und Benutzerrechte + Der Zugriff auf den Premium-Bereich wird durch ein mehrstufiges Berechtigungssystem gesteuert, das sowohl auf Server- als auch auf Client-Seite durchgesetzt wird. Die verfügbaren Berechtigungen werden in der `ModuleInfo`-Klasse registriert: ```C# @@ -697,22 +715,22 @@ private bool IsUserPremium(System.Security.Claims.ClaimsPrincipal user) ```mermaid flowchart TD Req([Anfrage auf Premium-Inhalt]) --> Auth{User.Identity.IsAuthenticated?} - + Auth -- Nein --> Guest[Login-Seite anzeigen] Auth -- Ja --> Admin{Ist Administrator?} - + Admin -- Ja --> Grant[Zugriff gewährt] Admin -- Nein --> Role{In Rolle 'Premium Member'?} - + Role -- Ja --> Grant Role -- Nein --> DB{Eintrag in SZUAbsolventenvereinUserPremium?} - + DB -- Nein --> Deny[Premium-Upgrade-Seite anzeigen] DB -- Ja --> Valid{Ablaufdatum > Heute?} - + Valid -- Ja --> Grant Valid -- Nein --> Deny - + style Grant fill:#c8e6c9,stroke:#2e7d32 style Deny fill:#ffcdd2,stroke:#c62828 ``` @@ -721,7 +739,8 @@ Zuerst wird die Oqtane-Rollenzugehörigkeit geprüft, anschließend der datenban Die Zugriffsbeschränkung wird konsequent auf beiden Seiten durchgesetzt: Clientseitig entscheidet die Blazor-Komponente anhand der Benutzerrolle, welche UI-Elemente angezeigt werden. Serverseitig prüft jeder Service-Aufruf die Berechtigung des anfragenden Benutzers über das `[Authorize]`-Attribut mit Policies wie `PolicyNames.ViewModule` und `PolicyNames.EditModule`, bevor Daten zurückgegeben oder Änderungen vorgenommen werden. Dadurch wird sichergestellt, dass selbst bei einer Manipulation der Client-Anfrage keine unberechtigten Zugriffe möglich sind. -## 7.4 Mehrwert für registrierte Mitglieder +### 7.4 Mehrwert für registrierte Mitglieder + Der Premium-Bereich schafft einen konkreten Mehrwert für registrierte Mitglieder auf mehreren Ebenen. Auf fachlicher Ebene entsteht durch die gesammelten Ingenieur-Anträge eine wachsende Wissensbasis, die allen Premium-Mitgliedern zugänglich ist. Absolventen können von den Arbeiten anderer Mitglieder lernen, sich inspirieren lassen und fachliche Ansätze vergleichen. Durch die Möglichkeit, Titel und Kurzbeschreibungen zu hinterlegen, können Mitglieder gezielt nach relevanten Themen suchen, ohne jedes PDF-Dokument einzeln öffnen zu müssen. Auf sozialer Ebene fördert der Premium-Bereich die Vernetzung innerhalb der Absolventengemeinschaft. Die Mitgliedersuche mit integrierter Kontaktfunktion ermöglicht es, gezielt nach ehemaligen Kommilitonen oder Fachkollegen zu suchen und direkt Kontakt aufzunehmen. Der duale Benachrichtigungsmechanismus — bestehend aus In-App-Nachricht und E-Mail — stellt sicher, dass Kontaktanfragen zuverlässig zugestellt werden und kein Mitglied eine Nachricht verpasst. @@ -730,9 +749,10 @@ Auf motivationaler Ebene bietet das zeitlich begrenzte Premium-System einen Anre Der Datenschutz wird dabei konsequent gewahrt. Die Mitgliedersuche gibt nur ausgewählte, nicht-sensible Informationen wie Anzeigenamen und Benutzernamen zurück. E-Mail-Adressen und andere persönliche Daten werden serverseitig herausgefiltert und sind für andere Mitglieder nicht einsehbar. Die Kontaktaufnahme erfolgt ausschließlich über das plattformeigene Benachrichtigungssystem, sodass kein Mitglied seine persönlichen Kontaktdaten preisgeben muss. -# 8. Technologien +## 8. Technologien + +### 8.1 ASP.NET und .NET -## 8.1 ASP.NET und .NET Für die Entwicklung der Webanwendung wurde das Framework ASP.NET in Kombination mit der Plattform .NET verwendet. .NET ist eine von Microsoft entwickelte Entwicklungsplattform zur Erstellung moderner Anwendungen für Web, Desktop, Cloud und mobile Systeme. ASP.NET stellt innerhalb der .NET-Plattform ein Framework dar, das speziell für die Entwicklung von Webanwendungen und Webservices konzipiert wurde. Es bietet eine Vielzahl an Funktionen zur Verarbeitung von HTTP-Anfragen, zur Verwaltung von Benutzersitzungen sowie zur Integration von Datenbanken und externen Diensten. @@ -751,7 +771,8 @@ Ein weiterer Vorteil von ASP.NET besteht in der klar strukturierten Architektur Diese Struktur erleichtert die Wartung und Erweiterung der Anwendung erheblich, da Änderungen gezielt innerhalb einzelner Komponenten vorgenommen werden können. -## 8.2 PostgreSQL-Datenbank +### 8.2 PostgreSQL-Datenbank + Zur Speicherung der Daten der Plattform wurde das relationale Datenbanksystem PostgreSQL eingesetzt. PostgreSQL gehört zu den leistungsfähigsten Open-Source-Datenbanken und wird weltweit in vielen professionellen Anwendungen verwendet. Eine relationale Datenbank speichert Informationen in Tabellen, die aus Zeilen und Spalten bestehen. Jede Tabelle repräsentiert eine bestimmte Art von Daten, beispielsweise Benutzer, Veranstaltungen oder Systeminformationen. Beziehungen zwischen Tabellen werden durch sogenannte Schlüssel definiert. @@ -774,10 +795,13 @@ Ein weiterer wichtiger Vorteil besteht darin, dass PostgreSQL sehr gut mit moder Da die Plattform personenbezogene Daten von Benutzern speichert, wurde zusätzlich ein Backup-System implementiert, das regelmäßige Sicherungen der Datenbank erstellt. Dadurch können Daten im Falle eines Fehlers oder eines Systemausfalls wiederhergestellt werden. ## 8.3 OAuth 2.0 + Für die sichere Anmeldung über externe Identitätsanbieter wurde das Protokoll OAuth 2.0 implementiert. OAuth 2.0 ist ein branchenweiter Standard für die Autorisierung, der es Benutzern ermöglicht, Anwendungen von Drittanbietern Zugriff auf ihre Daten zu gewähren, ohne ihre Passwörter für das jeweilige Portal preiszugeben. Im Rahmen dieses Projekts wurde OAuth 2.0 als Authentifizierungsverfahren mit LinkedIn gewählt, um den Registrierungsprozess der Benutzer signifikant zu vereinfachen, da bestehende LinkedIn-Accounts genutzt werden können. Gleichzeitig wird dadurch ein hohes Sicherheitsniveau sichergestellt. # 9. Learnings + ## 9.1 Technische und fachliche Erkenntnisse + Während der Umsetzung meiner Diplomarbeit konnte ich umfangreiche technische Erfahrungen in der Entwicklung moderner Webanwendungen sammeln. Ein zentraler Bestandteil der Arbeit war die Implementierung einer Alumni-Plattform, die ehemaligen Studierenden eine Möglichkeit bietet, sich zu vernetzen, Profile zu verwalten und sich für Veranstaltungen anzumelden. Ein wesentlicher Lernaspekt war die praktische Anwendung des Webframeworks ASP.NET auf Basis der Plattform .NET 8. Dabei konnte ich ein tieferes Verständnis für die Architektur moderner Webanwendungen entwickeln. Besonders wichtig war das Zusammenspiel zwischen Backend-Logik, Datenbankzugriff und Benutzeroberfläche. Durch die Entwicklung verschiedener Funktionen, wie beispielsweise Eventverwaltung, Benutzerprofile und Premiumbereiche, wurde deutlich, wie wichtig eine klare Strukturierung der Anwendung ist. @@ -789,7 +813,9 @@ Ein weiterer wichtiger Bestandteil der Arbeit war die Integration eines externen Zusätzlich wurden Funktionen im Bereich Datenschutz umgesetzt, die den Anforderungen der DSGVO entsprechen. Dazu zählen unter anderem Möglichkeiten zur Verwaltung personenbezogener Daten sowie automatisierte Löschmechanismen. Diese Aspekte haben mir gezeigt, wie wichtig Datenschutz und rechtliche Anforderungen bei der Entwicklung moderner Webanwendungen sind. Insgesamt konnte ich durch die praktische Umsetzung der Plattform ein deutlich tieferes Verständnis für Webtechnologien, Systemarchitekturen und Backend-Entwicklung gewinnen. -## 9.2 Agile Projektarbeit und Teamarbeit (Zeitmanagement) + +### 9.2 Agile Projektarbeit und Teamarbeit (Zeitmanagement) + Neben den technischen Aspekten konnte ich auch wichtige Erfahrungen im Bereich der agilen Projektarbeit sammeln. Für die Organisation des Projekts wurde das agile Framework Scrum eingesetzt. Die Arbeit wurde in Sprints von jeweils zwei Wochen unterteilt. Innerhalb eines Sprints wurden konkrete Aufgaben definiert, die bis zum Ende des Zeitraums umgesetzt werden sollten. Diese Struktur ermöglichte eine klare Planung der Arbeitsschritte und half dabei, größere Entwicklungsaufgaben in kleinere, überschaubare Teilaufgaben zu unterteilen. @@ -801,7 +827,9 @@ Auch das Zeitmanagement spielte eine zentrale Rolle. Da die Entwicklung der Plat Darüber hinaus zeigte sich, dass agile Methoden besonders gut für Softwareprojekte geeignet sind, da sie flexible Anpassungen während der Entwicklung ermöglichen. Neue Anforderungen oder Verbesserungen konnten relativ einfach in zukünftige Sprints integriert werden. Diese Erfahrungen haben mir ein besseres Verständnis für moderne Softwareentwicklungsprozesse vermittelt und gezeigt, wie wichtig strukturierte Planung und kontinuierliche Verbesserung in technischen Projekten sind. -## 9.3 Persönliche Weiterentwicklung + +### 9.3 Persönliche Weiterentwicklung + Neben den technischen und organisatorischen Erkenntnissen stellte die Diplomarbeit auch eine wichtige persönliche Weiterentwicklung dar. Die eigenständige Planung und Umsetzung eines komplexen Softwareprojekts erforderte ein hohes Maß an Selbstorganisation und Durchhaltevermögen. Während der Entwicklung der Alumni-Plattform musste ich regelmäßig neue Technologien und Konzepte erlernen. Dazu gehörten unter anderem Webframeworks, Datenbanksysteme, Authentifizierungsprotokolle sowie Aspekte der IT-Sicherheit und des Datenschutzes. Der Umgang mit diesen Technologien hat meine Fähigkeiten im Bereich der Softwareentwicklung deutlich erweitert. @@ -811,9 +839,11 @@ Darüber hinaus lernte ich, technische Probleme systematisch zu analysieren und Ein weiterer wichtiger Lernaspekt war die Verbesserung meiner Fähigkeiten im Bereich der Dokumentation. Die Erstellung eines Diplomarbeitsbuchs erfordert eine strukturierte und verständliche Beschreibung technischer Inhalte. Dadurch konnte ich lernen, komplexe technische Zusammenhänge klar und nachvollziehbar darzustellen. Zusammenfassend hat mir die Diplomarbeit nicht nur tiefere technische Kenntnisse vermittelt, sondern auch meine Fähigkeiten im Bereich Problemlösung, Selbstorganisation und Projektplanung gestärkt. Diese Kompetenzen stellen eine wichtige Grundlage für zukünftige berufliche Tätigkeiten im Bereich der Softwareentwicklung dar. -# 10. Fazit und Ausblick -## 10.1 Zusammenfassung der Arbeit +## 10. Fazit und Ausblick + +### 10.1 Zusammenfassung der Arbeit + Ziel dieser Diplomarbeit war die Konzeption und Entwicklung einer webbasierten Alumni-Plattform für den Absolventenverein. Die Plattform soll ehemaligen Studierenden ermöglichen, miteinander in Kontakt zu bleiben, Informationen auszutauschen und an Veranstaltungen des Vereins teilzunehmen. Dadurch wird die Kommunikation zwischen Absolventinnen und Absolventen sowie der Bildungseinrichtung langfristig gestärkt. Im Rahmen der Arbeit wurde eine moderne Webanwendung entwickelt, die auf dem Framework ASP.NET und der Plattform .NET 8 basiert. Die Speicherung der Daten erfolgt in der relationalen Datenbank PostgreSQL, welche eine strukturierte Verwaltung der Benutzerdaten, Eventinformationen und Systemdaten ermöglicht. @@ -825,7 +855,9 @@ Neben der Benutzerverwaltung wurden auch weitere Funktionen umgesetzt. Dazu zäh Die Entwicklung der Plattform erfolgte nach agilen Prinzipien mithilfe des Scrum-Frameworks. Die Arbeit wurde in mehrere zweiwöchige Sprints unterteilt, wodurch eine strukturierte und iterative Entwicklung der einzelnen Funktionen möglich war. Zusammenfassend konnte mit der Diplomarbeit eine funktionale und erweiterbare Plattform entwickelt werden, die eine moderne Grundlage für die digitale Vernetzung von Alumni darstellt. -## 10.2 Mögliche Erweiterungen der Website + +### 10.2 Mögliche Erweiterungen der Website + Obwohl bereits viele grundlegende Funktionen implementiert wurden, bietet die Plattform weiteres Potenzial für zukünftige Erweiterungen und Verbesserungen. Eine mögliche Erweiterung wäre beispielsweise die Integration eines internen Nachrichtensystems. Dadurch könnten Alumni direkt über die Plattform miteinander kommunizieren und Kontakte einfacher pflegen. Ebenso wäre die Implementierung eines Forums oder einer Diskussionsplattform denkbar, in der Mitglieder Erfahrungen austauschen oder berufliche Themen diskutieren können. @@ -845,7 +877,9 @@ Integration weiterer Social-Media-Plattformen erweiterte Such- und Filterfunktionen für Alumni-Profile Durch diese Erweiterungen könnte die Plattform langfristig noch attraktiver und vielseitiger gestaltet werden. -## 10.3 Zukunftspotenzial für den Absolventenverein + +### 10.3 Zukunftspotenzial für den Absolventenverein + Die entwickelte Alumni-Plattform bietet dem Absolventenverein eine moderne digitale Infrastruktur zur Verwaltung und Vernetzung seiner Mitglieder. Durch die zentrale Plattform können Informationen, Veranstaltungen und Kontakte effizient organisiert werden. Ein wesentlicher Vorteil besteht darin, dass der Verein seine Mitglieder dauerhaft an die Institution binden kann. Ehemalige Studierende haben die Möglichkeit, weiterhin mit ihrer Ausbildungsstätte und anderen Absolventinnen und Absolventen in Verbindung zu bleiben. Dies stärkt das Netzwerk des Vereins und kann langfristig auch neue Kooperationen oder berufliche Kontakte ermöglichen. @@ -855,20 +889,3 @@ Darüber hinaus kann die Plattform auch zur Organisation von Veranstaltungen gen Langfristig kann die Plattform zu einem zentralen digitalen Treffpunkt für Absolventinnen und Absolventen werden. Besonders im beruflichen Umfeld kann ein starkes Alumni-Netzwerk einen großen Mehrwert bieten, beispielsweise durch den Austausch von Erfahrungen oder beruflichen Möglichkeiten. Insgesamt besitzt die entwickelte Plattform ein großes Zukunftspotenzial. Durch kontinuierliche Erweiterungen und die aktive Nutzung durch die Mitglieder kann sie zu einem wichtigen Instrument für die Vernetzung und Weiterentwicklung des Absolventenvereins werden. -# 11. Quellenverzeichnis - -[^1]: DSGVO – Datenschutz-Grundverordnung: https://eur-lex.europa.eu/eli/reg/2016/679/ [Zugriff: 19.03.2026] - -[^2]: RIS – Rechtsinformationssystem des Bundes: https://www.ris.bka.gv.at/ [Zugriff: 19.03.2026] - -[^3]: DSB – Österreichische Datenschutzbehörde: https://dsb.gv.at/ [Zugriff: 19.03.2026] - -[^4]: Datensicherung und Datenverlust: https://www.bsi.bund.de/DE/Themen/Verbraucherinnen-und-Verbraucher/Informationen-und-Empfehlungen/Cyber-Sicherheitsempfehlungen/Daten-sichern-verschluesseln-und-loeschen/Datensicherung-und-Datenverlust/Datensicherung-wie-geht-das/datensicherung-wie-geht-das_node.html [Zugriff: 19.03.2026] - -[^5]: BSI – Bundesamt für Sicherheit in der Informationstechnik: *IT-Grundschutz-Kompendium – CON.3: Datensicherungskonzept.* URL: https://www.bsi.bund.de/SharedDocs/Downloads/DE/BSI/Grundschutz/Kompendium/IT_Grundschutz_Kompendium_Edition2023.pdf [Zugriff: 19.03.2026] - -[^6]: IETF RFC 6749 – The OAuth 2.0 Authorization Framework: https://datatracker.ietf.org/doc/html/rfc6749 [Zugriff: 19.03.2026] - -[^7]: LinkedIn Developer Documentation – Authorization Code Flow: https://learn.microsoft.com/en-us/linkedin/shared/authentication/authorization-code-flow [Zugriff: 19.03.2026] - -[^8]: Oqtane Framework – External Login: https://docs.oqtane.org/ [Zugriff: 19.03.2026] diff --git a/Diplomarbeitsbuch-individueller-teil-Konstantin-Hintermayer.md b/Diplomarbeitsbuch-individueller-teil-Konstantin-Hintermayer.md index 789f679..3d54653 100644 --- a/Diplomarbeitsbuch-individueller-teil-Konstantin-Hintermayer.md +++ b/Diplomarbeitsbuch-individueller-teil-Konstantin-Hintermayer.md @@ -1,7 +1,4 @@ ---- -include_toc: true -gitea: none ---- +# Konstantin Hintermayer ## 1. Einleitung des individuellen Teils @@ -67,11 +64,11 @@ Es war von Anfang an klar, dass es ein SQL-basiertes System wird, da wir im Team ### 3.2 Beschreibung und Architektur von Oqtane -Oqtane ist ein Framework und CMS zur Entwicklung von Webseiten mithilfe von ASP.NET und Blazor. [^5] Ein Oqtane-System besteht aus mehreren Komponenten. +Oqtane ist ein Framework und CMS zur Entwicklung von Webseiten mithilfe von ASP.NET und Blazor. [@oqtane_about] Ein Oqtane-System besteht aus mehreren Komponenten. -In dieser Diplomarbeit fokussieren wir uns hauptsächlich auf `Themes` und `Modules`, aber es gibt auch `Language Packs` und `Pure Extensions`. [^6] +In dieser Diplomarbeit fokussieren wir uns hauptsächlich auf `Themes` und `Modules`, aber es gibt auch `Language Packs` und `Pure Extensions`. [@oqtane_docs_extensions] -Ein `Module` (Modul) soll neue Funktionalitäten in das CMS hinzufügen und ein `Theme` soll die ganze Gestaltung der Webseite (die Shell) festlegen. [^6] +Ein `Module` (Modul) soll neue Funktionalitäten in das CMS hinzufügen und ein `Theme` soll die ganze Gestaltung der Webseite (die Shell) festlegen. [@oqtane_docs_extensions] #### 3.2.1 Architektur eines Moduls @@ -118,7 +115,7 @@ Die VPN basierten Zugänge sind tendenziell schwieriger zu finden und auszunutze ### 3.4 Entwicklung mit ASP.NET -#### 3.4.1 Blazor [^7] +#### 3.4.1 Blazor [@wikipedia_blazor] Blazor ist ein kostenloses und quelloffenes Web-Framework, welches es möglich macht Benutzeroberflächen für Web-Browser, basierend auf C# und HTML, zu erstellen. Es wird von Microsoft als teil des ASP.NET Core Frameworks entwickelt. @@ -169,18 +166,18 @@ Wie Front- und Backend miteinander interagieren hängt hauptsächlich vom Render Dependency Injection ist ein Entwurfsmuster, bei dem die Abhängigkeiten eines Objekts nicht von diesem selbst erzeugt, sondern von außen „injiziert“ werden. -Wie der Software-Architekt Martin Fowler, der den Begriff im Jahr 2004 maßgeblich prägte, beschreibt, geht es im Kern darum, die Erzeugung von Objekten von deren Nutzung zu trennen [^9]. Anstatt dass eine Klasse ihre Hilfsobjekte mittels des new-Operators selbst instanziiert, werden ihr diese meist über den Konstruktor zur Verfügung gestellt. +Wie der Software-Architekt Martin Fowler, der den Begriff im Jahr 2004 maßgeblich prägte, beschreibt, geht es im Kern darum, die Erzeugung von Objekten von deren Nutzung zu trennen [@fowler_dependency_injection]. Anstatt dass eine Klasse ihre Hilfsobjekte mittels des new-Operators selbst instanziiert, werden ihr diese meist über den Konstruktor zur Verfügung gestellt. In den folgenden beiden Kapiteln wird das Dependency Inversion Principle und das Microsoft Dependency Injection Framework genauer vorgestellt. -#### 3.5.1 Dependency Inversion Principle [^1] +#### 3.5.1 Dependency Inversion Principle [@ms_dependency_inversion][@logrocket_dependency_inversion] Das Dependency-Inversion-Principle (DIP / auf Deutsch: Abhängigkeits-Umkehr-Prinzip) ist eines von den fünf `SOLID` Prinzipien in der Softwareentwicklung. Das DIP unterscheidet zwischen high-level und low-level Modulen. -- Die High-Level-Module beschreiben die Applikations- / Businesslogik, ohne direkt mit den Low-Level-Modulen zu interagieren, sondern lediglich auf Abstraktionen. [^3] -- Die Abstraktionen sollen nicht von Implementierungsdetails abhängig sein, sondern die Low-Level-Implementierung sollen gemäß der Abstraktionsschicht implementiert werden. [^3] +- Die High-Level-Module beschreiben die Applikations- / Businesslogik, ohne direkt mit den Low-Level-Modulen zu interagieren, sondern lediglich auf Abstraktionen. [@oodesign_dependency_inversion] +- Die Abstraktionen sollen nicht von Implementierungsdetails abhängig sein, sondern die Low-Level-Implementierung sollen gemäß der Abstraktionsschicht implementiert werden. [@oodesign_dependency_inversion] Ausgangslage ist eine Softwarearchitektur im Direct-Dependency-Graph-Modell. @@ -209,13 +206,13 @@ Das High-Level-Modul ruft lediglich eine Abstraktion eines Low-Level-Moduls auf, #### 3.5.2 Microsoft Dependency Injection Framework -Dependency Injection ist in .NET genau so wie Konfiguration, Protokollierung und das Optionsmuster ins Framework integriert. [^4] +Dependency Injection ist in .NET genau so wie Konfiguration, Protokollierung und das Optionsmuster ins Framework integriert. [@ms_di_overview] -Alle Dependencies werden in einem `Service-Container` zur Verwaltung registriert. .NET hat einen eingebauten `Service-Container` (eine Implementierung des `IServiceProvider`). [^4] +Alle Dependencies werden in einem `Service-Container` zur Verwaltung registriert. .NET hat einen eingebauten `Service-Container` (eine Implementierung des `IServiceProvider`). [@ms_di_overview] -Das Dependency Injection Framework verwaltet alle Instanzen. Nach Bedarf werden Instanzen erstellt, oder wieder entsorgt (sofern das Service nicht mehr gebraucht wird). Beim Instanziieren einer Klasse werden alle im Konstruktor erwarteten Dependencies bereitgestellt, bzw. selbst instanziiert und danach bereitgestellt. [^4] +Das Dependency Injection Framework verwaltet alle Instanzen. Nach Bedarf werden Instanzen erstellt, oder wieder entsorgt (sofern das Service nicht mehr gebraucht wird). Beim Instanziieren einer Klasse werden alle im Konstruktor erwarteten Dependencies bereitgestellt, bzw. selbst instanziiert und danach bereitgestellt. [@ms_di_overview] -Hier ein Beispiel aus der Dokumentation von Microsoft: [^4] +Hier ein Beispiel aus der Dokumentation von Microsoft: [@ms_di_overview] ```c# HostApplicationBuilder builder = Host.CreateApplicationBuilder(args); @@ -268,7 +265,9 @@ architecture-beta service ib(mdi:car-clutch)[IMessageWriter] a:R --> L:ib + ib:R <-- L:b + ``` ### 3.6 Continuous Integration @@ -321,31 +320,31 @@ Für die Sicherung und Zusammenarbeit wurde im Rahmen dieser Arbeit Remote-Repos ### 4.4 Gitea -Als schlanke und selbst gehostete Open-Source-Alternative zu Plattformen wie GitHub oder GitLab wurde für die Verwaltung der Repositories Gitea eingesetzt. Hauptgrund für die Benutzung von Gitea war meine bereits aufgesetzte Instanz, welche schon mehrere Jahre in Verwendung war und mit der es im Team auch schon Erfahrungen gab. Gitea bietet neben der reinen Git-Verwaltung essenzielle Werkzeuge für den Software-Lebenszyklus, wie ein integriertes Issue-Tracking, Code-Reviews über Pull-Requests sowie eine Benutzerverwaltung, und unterstützt somit die strukturierte Umsetzung der Diplomarbeit im Team.[^12] +Als schlanke und selbst gehostete Open-Source-Alternative zu Plattformen wie GitHub oder GitLab wurde für die Verwaltung der Repositories Gitea eingesetzt. Hauptgrund für die Benutzung von Gitea war meine bereits aufgesetzte Instanz, welche schon mehrere Jahre in Verwendung war und mit der es im Team auch schon Erfahrungen gab. Gitea bietet neben der reinen Git-Verwaltung essenzielle Werkzeuge für den Software-Lebenszyklus, wie ein integriertes Issue-Tracking, Code-Reviews über Pull-Requests sowie eine Benutzerverwaltung, und unterstützt somit die strukturierte Umsetzung der Diplomarbeit im Team.[@gitea_docs] #### 4.4.1 Repositories -Ein Repository bildet den zentralen Speicherort für einen Projektteil. In Gitea wurden separate Repositories für die einzelnen Module und Themes, das Oqtane Framework, Skripte, die Dokumentation angelegt. Ein zusätzliches Repository bindet alle übrigen Quellcode-Repositories als Submodule ein, das macht die Einrichtung einer neuen Entwicklungsumgebung sehr kompfortabel. Dies ermöglichte eine saubere Trennung der verschiedenen Projektkomponenten. [^12] +Ein Repository bildet den zentralen Speicherort für einen Projektteil. In Gitea wurden separate Repositories für die einzelnen Module und Themes, das Oqtane Framework, Skripte, die Dokumentation angelegt. Ein zusätzliches Repository bindet alle übrigen Quellcode-Repositories als Submodule ein, das macht die Einrichtung einer neuen Entwicklungsumgebung sehr kompfortabel. Dies ermöglichte eine saubere Trennung der verschiedenen Projektkomponenten. [@gitea_docs] #### 4.4.2 Issues -Zur Aufgabenplanung und Fehlerverfolgung wurde das integrierte Issue-System genutzt. Jede anstehende Aufgabe oder entdeckte Schwachstelle wurde als „Issue“ erfasst, einem Verantwortlichen zugewiesen und mit Labels (z. B. „Bug“, „Feature“ oder „Dokumentation“) versehen. Dies half dabei, den Überblick über den Projektfortschritt zu behalten und die Anforderungen aus dem Lastenheft strukturiert abzuarbeiten. [^12][^13] +Zur Aufgabenplanung und Fehlerverfolgung wurde das integrierte Issue-System genutzt. Jede anstehende Aufgabe oder entdeckte Schwachstelle wurde als „Issue“ erfasst, einem Verantwortlichen zugewiesen und mit Labels (z. B. „Bug“, „Feature“ oder „Dokumentation“) versehen. Dies half dabei, den Überblick über den Projektfortschritt zu behalten und die Anforderungen aus dem Lastenheft strukturiert abzuarbeiten. [@gitea_docs][@gitea_issue_tracker] #### 4.4.3 Pull Requests -Um die Qualität des Codes zu sichern, wurden Änderungen nicht direkt in den Hauptzweig eingespielt, sondern über Pull Requests eingereicht. Ein Teammitglied konnte so die Änderungen eines anderen sichten, kommentieren und bei Bedarf Korrekturen anfordern. Erst nach einer erfolgreichen Überprüfung wurde der Code in den main-Branch gemergt. [^12][^14] +Um die Qualität des Codes zu sichern, wurden Änderungen nicht direkt in den Hauptzweig eingespielt, sondern über Pull Requests eingereicht. Ein Teammitglied konnte so die Änderungen eines anderen sichten, kommentieren und bei Bedarf Korrekturen anfordern. Erst nach einer erfolgreichen Überprüfung wurde der Code in den main-Branch gemergt. [@gitea_docs][@gitea_pull_requests] #### 4.4.4 Actions -Gitea Actions wurden eingesetzt, um CI/CD-Pipelines (Continuous Integration / Continuous Deployment) zu realisieren. Bei jedem Push oder Pull Request wurden automatisierte Skripte ausgeführt, die das Projekt bauten. Dies reduzierte manuelle Fehlerquellen erheblich. Außerdem konnten wir mithilfe von CI/CD den Release Prozess einmalig festlegen und automatisieren, ohne bei jedem Update manuell den selben Prozess wiederholt durchgehen zu müssen. Das APT-Package Projekt enthält die CI/CD Konfiguration für das bauen von Oqtane, der Module und Themes, sowie das verpacken in ein APT Paket und dem veröffentlichen aller Pakete als eingenes Gitea Release. [^12][^15] +Gitea Actions wurden eingesetzt, um CI/CD-Pipelines (Continuous Integration / Continuous Deployment) zu realisieren. Bei jedem Push oder Pull Request wurden automatisierte Skripte ausgeführt, die das Projekt bauten. Dies reduzierte manuelle Fehlerquellen erheblich. Außerdem konnten wir mithilfe von CI/CD den Release Prozess einmalig festlegen und automatisieren, ohne bei jedem Update manuell den selben Prozess wiederholt durchgehen zu müssen. Das APT-Package Projekt enthält die CI/CD Konfiguration für das bauen von Oqtane, der Module und Themes, sowie das verpacken in ein APT Paket und dem veröffentlichen aller Pakete als eingenes Gitea Release. [@gitea_docs][@gitea_actions] #### 4.4.5 Releases -Über die Release-Funktion wurden wichtige Meilensteine der Diplomarbeit festgeschrieben. Hierbei wird ein spezifischer Git-Tag mit einer Versionsnummer versehen und die dazugehörigen Binärdateien, Pakete und Dokumente archiviert. So lässt sich jederzeit auf einen stabilen, abgabebereiten Stand des Projekts zugreifen. [^12] +Über die Release-Funktion wurden wichtige Meilensteine der Diplomarbeit festgeschrieben. Hierbei wird ein spezifischer Git-Tag mit einer Versionsnummer versehen und die dazugehörigen Binärdateien, Pakete und Dokumente archiviert. So lässt sich jederzeit auf einen stabilen, abgabebereiten Stand des Projekts zugreifen. [@gitea_docs] #### 4.4.6 Package Repositories -Gitea fungierte zusätzlich als Register für Pakete und Container-Images. Selbst erstellte Artefakte, wie das Debian Paket für die Bereitstellung der Anwendung, wurden direkt in der Gitea-Instanz versioniert gespeichert. Dadurch waren alle notwendigen Komponenten für das Deployment an einem zentralen Ort verfügbar und abrufbar. Gitea selbst unterstützt verschiedenste Pakettypen. Darunter fallen unteranderem NuGet- und Debianpakete. Für beide haben wir in dieser Arbeit verwendung gefunden. [^12][^16] +Gitea fungierte zusätzlich als Register für Pakete und Container-Images. Selbst erstellte Artefakte, wie das Debian Paket für die Bereitstellung der Anwendung, wurden direkt in der Gitea-Instanz versioniert gespeichert. Dadurch waren alle notwendigen Komponenten für das Deployment an einem zentralen Ort verfügbar und abrufbar. Gitea selbst unterstützt verschiedenste Pakettypen. Darunter fallen unteranderem NuGet- und Debianpakete. Für beide haben wir in dieser Arbeit verwendung gefunden. [@gitea_docs][@gitea_packages] ### 4.5 Kommunikation @@ -369,12 +368,12 @@ Für den tatsächlichen Versand der E-Mails nutzen wir den Cloud-Dienst Brevo. D Das Token Lifetime Modul wurde geschrieben, um die Token-Lebenszeit konfigurierbar zu machen. Notwendig war das, um die Passwort Reset Links im initialen Mail versand länger gültig sein zu lassen. Durch das `Batch Processing` war es möglich, dass eine Mail erst Tage nach erstellen des Links hinaus geschickt wird und bei einer Standard Ablaufdauer von 2 Tagen sind manche Links schon ungültig, bis sie den Mail Server erreichen. Ziel war es, die Änderung der Lebenszeit für Administratoren im User Interface im Admin Bereich möglich zu machen. -Technisch bedeutet das, dass die standardmäßig vorkonfigurierten `DataProtectionTokenProviderOptions` explizit konfiguriert werden müssen. [^10] Der ASP.NET Core `UserManager`, welcher das generieren der Tokens übernimmt, verwendet einen `DataProtectorTokenProvider` und dieser wiederum kann mithilfe der `DataProtectionTokenProviderOptions` konfiguriert werden. +Technisch bedeutet das, dass die standardmäßig vorkonfigurierten `DataProtectionTokenProviderOptions` explizit konfiguriert werden müssen. [@andrewlock_token_lifetime] Der ASP.NET Core `UserManager`, welcher das generieren der Tokens übernimmt, verwendet einen `DataProtectorTokenProvider` und dieser wiederum kann mithilfe der `DataProtectionTokenProviderOptions` konfiguriert werden. Es gibt 2 Möglichkeiten, wie man dieses Problem Lösen kann: -- `der Workaround`: Ein eigenes Modul, welches in seiner `Server/Startup.cs` die benötigten Werte korrekt setzt. Das hat den Vorteil, dass wir keine Änderungen im CMS selbst haben, sondern nur unsere eigene Erweiterung dafür schreiben. Andererseits könnte durch die undeterministische Ladereihenfolge eine `race-condition` auftreten. [^11] Darüber hinaus besteht kein gleichzeitiger Zugriff auf die appsettings.json und den IServiceProvider, in dem die Konfiguration gesetzt werden muss. => Nachdem wir in der Konfigurationsphase auch noch keinen Datenbankzugriff haben, können die Werte nicht aus der Datenbank geladen werden, sondern wir müssen auf eine Textdatei zurückgreifen. -- `die saubere Lösung`: Eine Änderung im Kern von Oqtane. Also wird in unserem Fork von Oqtane die Konfigurationslogik für die Tokenlifetime implementiert. In diesem Fall könnte die Konfigurationslogik direkt in `OqtaneServiceCollectionExtensions.cs` hinzugefügt werden, da hier auch alle anderen Oqtane Spezifischen Konfigurationen gesetzt werden. Das hat den Vorteil, dass der Code aufgeräumter und sauberer ist und die `race-condition` verhindert werden kann. [^11] Der initiale Grund dagegen ist, dass wir ein weiteres Git Repository zum warten haben (den Fork vom Oqtane.Framework), welches jetzt nicht mehr mit Upstream Commit-gleich ist. +- `der Workaround`: Ein eigenes Modul, welches in seiner `Server/Startup.cs` die benötigten Werte korrekt setzt. Das hat den Vorteil, dass wir keine Änderungen im CMS selbst haben, sondern nur unsere eigene Erweiterung dafür schreiben. Andererseits könnte durch die undeterministische Ladereihenfolge eine `race-condition` auftreten. [@race_conditions_pdf] Darüber hinaus besteht kein gleichzeitiger Zugriff auf die appsettings.json und den IServiceProvider, in dem die Konfiguration gesetzt werden muss. => Nachdem wir in der Konfigurationsphase auch noch keinen Datenbankzugriff haben, können die Werte nicht aus der Datenbank geladen werden, sondern wir müssen auf eine Textdatei zurückgreifen. +- `die saubere Lösung`: Eine Änderung im Kern von Oqtane. Also wird in unserem Fork von Oqtane die Konfigurationslogik für die Tokenlifetime implementiert. In diesem Fall könnte die Konfigurationslogik direkt in `OqtaneServiceCollectionExtensions.cs` hinzugefügt werden, da hier auch alle anderen Oqtane Spezifischen Konfigurationen gesetzt werden. Das hat den Vorteil, dass der Code aufgeräumter und sauberer ist und die `race-condition` verhindert werden kann. [@race_conditions_pdf] Der initiale Grund dagegen ist, dass wir ein weiteres Git Repository zum warten haben (den Fork vom Oqtane.Framework), welches jetzt nicht mehr mit Upstream Commit-gleich ist. `Der Workaround` ist die Möglichkeit für die wir uns entschieden haben, allerdings ist das nicht die schönste Lösung. Eine eventuell nachfolgende Diplomarbeit kann an dieser Stelle ansetzen und `die saubere Lösung` implementieren. @@ -477,7 +476,7 @@ Auf der Serverseite folgt das Modul dem etablierten Muster mit einem `BlackBoard ### 6.1 Produktion != Staging -Ein Learning, welches doch relativ schnell aufkam ist im Bereich der IT eigentlich kein unbekanntes. Wir hatten dieses Learning relativ bald, im Frühling 2025, als die ersten Probleme mit dem Deployment von Oqtane aufkamen. Oqtane war zwar in unserer Entwicklungsumgebung sehr einfach zum einrichten gewesen, das Deployment in der Cloud vom Hetzner war jedoch geplagt von Problemen. Im Zeitraum von Mai bis Okober hatten wir keine laufende Produktivumgebung. Dadurch sind wir mit dieser Diplomarbeit auch in [Zeitverzug](#Arbeitszeiteinschätzung-und-verzug) gekommen. Hätte ich mich vor dem Start der Diplomarbeit mit dem Deployment von Oqtane auseinander gesetzt, dann wäre das in [Probleme mit Oqtane](#Probleme mit Oqtane) beschriebene Problem früher aufgekommen und der Zeitverzug wäre nicht so groß, oder noch ganz vermeidbar gewesen. +Ein Learning, welches doch relativ schnell aufkam ist im Bereich der IT eigentlich kein unbekanntes. Wir hatten dieses Learning relativ bald, im Frühling 2025, als die ersten Probleme mit dem Deployment von Oqtane aufkamen. Oqtane war zwar in unserer Entwicklungsumgebung sehr einfach zum einrichten gewesen, das Deployment in der Cloud vom Hetzner war jedoch geplagt von Problemen. Im Zeitraum von Mai bis Okober hatten wir keine laufende Produktivumgebung. Dadurch sind wir mit dieser Diplomarbeit auch in [Zeitverzug](#arbeitszeiteinschätzung-zeitverzug) gekommen. Hätte ich mich vor dem Start der Diplomarbeit mit dem Deployment von Oqtane auseinander gesetzt, dann wäre das in [Probleme mit Oqtane](#fehlende-oder-nur-schlechte-dokumentation-von-oqtane) beschriebene Problem früher aufgekommen und der Zeitverzug wäre nicht so groß, oder noch ganz vermeidbar gewesen. ### 6.2 Teamleitung (Motivation / Downsizing) @@ -501,7 +500,7 @@ Um das Projektziel dennoch zu erreichen, wurde der Zeitplan im Herbst 2025 massi `90% fertig, oder fertig?`: Es gibt einige "Regeln", wie: das `Paretoprinzip`, `Hofstadter’s Law` und die `90-90 Regel`. Letztere wurde im Jahr 1985 von Jon Bentley in einer Kolumne "Programming pearls" veröffentlicht. Ausgeschrieben lautet sie: > [Rule of Credibility] The first 90 percent of the code accounts for the first 90 percent of the development time. The remaining 10 percent of the code accounts for the other 90 percent of the development time. -> (Jon Bentley. 1985. Programmimg pearls. Commun. ACM 28, 9 (Sept. 1985), 896–901. https://doi.org/10.1145/4284.315122) [^8] +> (Jon Bentley. 1985. Programmimg pearls. Commun. ACM 28, 9 (Sept. 1985), 896–901. https://doi.org/10.1145/4284.315122) [@bentley1985programming] > Diese Diplomarbeit liefert weitere Evidenz, dass diese Faustregel stimmt. ### 6.4 Sprints und Meetings (in Zukunft ja asynchron) @@ -514,40 +513,6 @@ Ein zentrales Problem in unserer ursprünglichen Arbeitsweise war die Kopplung v Lösungsansatz: Meetings und Besprechungen asynchron zueinander setzen. -- Asynchrone Daily-Updates: Statusberichte erfolgen schriftlich (z. B. in Gitea Issues oder YouTrack), nicht mehr in stundenlangen Call-Marathons. Das nimmt den zeitlichen Druck vom einzelnen Entwickler. Oder zumindest in kurzen Commitnachrichten, welche am Ende des Tages automatisch an alle Teammitglieder zum Überblick gesendet werden (eventuell mit @username tagging, um eine Person nochmal genau anzusprechen) +- Asynchrone Daily-Updates: Statusberichte erfolgen schriftlich (z. B. in Gitea Issues oder YouTrack), nicht mehr in stundenlangen Call-Marathons. Das nimmt den zeitlichen Druck vom einzelnen Entwickler. Oder zumindest in kurzen Commitnachrichten, welche am Ende des Tages automatisch an alle Teammitglieder zum Überblick gesendet werden (eventuell mit \@username tagging, um eine Person nochmal genau anzusprechen) - Review-First-Policy: Ein Feature gilt erst dann als „fertig“, wenn es einen asynchronen Code-Review-Prozess durchlaufen hat. Das Meeting dient nur noch der Klärung von Blockern, nicht der Präsentation von Code. Das war eigentlich schon von Anfang an in unserer `Definition of Done` festgelegt worden. - Entkoppelung von Meeting und Deadline: Meetings sollten der Synchronisation dienen, während die Abgabe von Arbeitspaketen kontinuierlich (Continuous Integration) erfolgen muss, um Lastspitzen (in der [Gitea Actions](#Continuous Integration) Pipeline) am Tag der Besprechung zu vermeiden. - -# Quellen - -[^1]: https://learn.microsoft.com/en-us/dotnet/architecture/modern-web-apps-azure/architectural-principles#dependency-inversion - -[^2]: https://blog.logrocket.com/dependency-inversion-principle/ - -[^3]: https://www.oodesign.com/dependency-inversion-principle - -[^4]: https://learn.microsoft.com/en-us/dotnet/core/extensions/dependency-injection/overview - -[^5]: https://www.oqtane.org/#about - -[^6]: https://docs.oqtane.org/dev/extensions/index.html - -[^7]: https://en.wikipedia.org/wiki/Blazor - -[^8]: https://dl.acm.org/doi/10.1145/4284.315122 - -[^9]: https://martinfowler.com/articles/injection.html - -[^10]: https://andrewlock.net/implementing-custom-token-providers-for-passwordless-authentication-in-asp-net-core-identity/#changing-the-default-token-lifetime - -[^11]: https://www.cs.umd.edu/projects/syschat/raceConditions.pdf - -[^12]: https://docs.gitea.com/ - -[^13]: https://docs.gitea.com/installation/comparison#issue-tracker - -[^14]: https://docs.gitea.com/usage/pull-request - -[^15]: https://docs.gitea.com/usage/actions/overview - -[^16]: https://docs.gitea.com/usage/packages/overview diff --git a/bibliographie.md b/bibliographie.md new file mode 100644 index 0000000..85ba6bb --- /dev/null +++ b/bibliographie.md @@ -0,0 +1,4 @@ +# Quellenverzeichnis + +::: {#refs} +::: diff --git a/sources.bib b/sources.bib new file mode 100644 index 0000000..5bd4557 --- /dev/null +++ b/sources.bib @@ -0,0 +1,171 @@ +@online{ms_dependency_inversion, + title = {Dependency Inversion}, + url = {https://learn.microsoft.com/en-us/dotnet/architecture/modern-web-apps-azure/architectural-principles#dependency-inversion}, + author = {Microsoft}, + year = {2024}, + urldate = {2026-03-19} +} + +@online{logrocket_dependency_inversion, + title = {Dependency Inversion Principle}, + url = {https://blog.logrocket.com/dependency-inversion-principle/}, + author = {LogRocket}, + year = {2024}, + urldate = {2026-03-19} +} + +@online{oodesign_dependency_inversion, + title = {Dependency Inversion Principle}, + url = {https://www.oodesign.com/dependency-inversion-principle}, + author = {OO Design}, + year = {2024}, + urldate = {2026-03-19} +} + +@online{ms_di_overview, + title = {Dependency Injection Overview}, + url = {https://learn.microsoft.com/en-us/dotnet/core/extensions/dependency-injection/overview}, + author = {Microsoft}, + year = {2024}, + urldate = {2026-03-19} +} + +@online{oqtane_about, + title = {About Oqtane}, + url = {https://www.oqtane.org/#about}, + author = {Oqtane Foundation}, + year = {2024}, + urldate = {2026-03-19} +} + +@online{oqtane_docs_extensions, + title = {Oqtane Extensions}, + url = {https://docs.oqtane.org/dev/extensions/index.html}, + author = {Oqtane Foundation}, + year = {2024}, + urldate = {2026-03-19} +} + +@online{wikipedia_blazor, + title = {Blazor}, + url = {https://en.wikipedia.org/wiki/Blazor}, + author = {Wikipedia}, + year = {2024}, + urldate = {2026-03-19} +} + +@article{bentley1985programming, + title = {Programming pearls}, + author = {Jon Bentley}, + journal = {Communications of the ACM}, + volume = {28}, + number = {9}, + pages = {896--901}, + year = {1985}, + publisher = {ACM}, + doi = {10.1145/4284.315122} +} + +@online{fowler_dependency_injection, + title = {Inversion of Control Containers and the Dependency Injection pattern}, + url = {https://martinfowler.com/articles/injection.html}, + author = {Martin Fowler}, + year = {2004}, + urldate = {2026-03-19} +} + +@online{andrewlock_token_lifetime, + title = {Implementing custom token providers for passwordless authentication in ASP.NET Core Identity}, + url = {https://andrewlock.net/implementing-custom-token-providers-for-passwordless-authentication-in-asp-net-core-identity/#changing-the-default-token-lifetime}, + author = {Andrew Lock}, + year = {2024}, + urldate = {2026-03-19} +} + +@online{race_conditions_pdf, + title = {Race Conditions}, + url = {https://www.cs.umd.edu/projects/syschat/raceConditions.pdf}, + author = {University of Maryland}, + year = {2024}, + urldate = {2026-03-19} +} + +@online{gitea_docs, + title = {Gitea Documentation}, + url = {https://docs.gitea.com/}, + author = {Gitea}, + year = {2024}, + urldate = {2026-03-19} +} + +@online{gitea_issue_tracker, + title = {Gitea Issue Tracker Comparison}, + url = {https://docs.gitea.com/installation/comparison#issue-tracker}, + author = {Gitea}, + year = {2024}, + urldate = {2026-03-19} +} + +@online{gitea_pull_requests, + title = {Gitea Pull Requests}, + url = {https://docs.gitea.com/usage/pull-request}, + author = {Gitea}, + year = {2024}, + urldate = {2026-03-19} +} + +@online{gitea_actions, + title = {Gitea Actions Overview}, + url = {https://docs.gitea.com/usage/actions/overview}, + author = {Gitea}, + year = {2024}, + urldate = {2026-03-19} +} + +@online{gitea_packages, + title = {Gitea Packages Overview}, + url = {https://docs.gitea.com/usage/packages/overview}, + author = {Gitea}, + year = {2024}, + urldate = {2026-03-19} +} + +@online{dsgvo, + title = {Datenschutz-Grundverordnung (DSGVO)}, + url = {https://eur-lex.europa.eu/eli/reg/2016/679/}, + author = {Europäische Union}, + year = {2016}, + urldate = {2026-03-19} +} + +@online{ris, + title = {Rechtsinformationssystem des Bundes (RIS)}, + url = {https://www.ris.bka.gv.at/}, + author = {Bundeskanzleramt Österreich}, + year = {2024}, + urldate = {2026-03-19} +} + +@online{dsb, + title = {Österreichische Datenschutzbehörde (DSB)}, + url = {https://dsb.gv.at/}, + author = {Datenschutzbehörde}, + year = {2024}, + urldate = {2026-03-19} +} + +@online{bsi_datensicherung, + title = {Datensicherung und Datenverlust}, + url = {https://www.bsi.bund.de/DE/Themen/Verbraucherinnen-und-Verbraucher/Informationen-und-Empfehlungen/Cyber-Sicherheitsempfehlungen/Daten-sichern-verschluesseln-und-loeschen/Datensicherung-und-Datenverlust/Datensicherung-wie-geht-das/datensicherung-wie-geht-das_node.html}, + author = {Bundesamt für Sicherheit in der Informationstechnik (BSI)}, + year = {2024}, + urldate = {2026-03-19} +} + +@online{chatgpt_datensicherung, + title = {Notwendigkeit der Datensicherung}, + url = {https://chatgpt.com/c/69a06632-e4fc-8384-bd6c-a543d7bbd00d}, + author = {OpenAI (ChatGPT)}, + year = {2024}, + urldate = {2026-03-19} +} From b103ea97e546b60d7d90218ab57686dfabfd44d0 Mon Sep 17 00:00:00 2001 From: KoCoder Date: Thu, 19 Mar 2026 14:52:30 +0100 Subject: [PATCH 2/9] New: .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..294b427 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +diplomarbeitsbuch.pdf \ No newline at end of file From e8180d0cb4473f92d5016f93723305ac0ec2f5d9 Mon Sep 17 00:00:00 2001 From: KoCoder Date: Thu, 19 Mar 2026 15:06:33 +0100 Subject: [PATCH 3/9] Umstellung automatische Nummerierung --- Allgemein.md | 12 ++-- ...uch-individueller-teil-Adam-Gaiswinkler.md | 62 ++++++++-------- ...uch-individueller-teil-Florian-Edlmayer.md | 60 ++++++++-------- ...dividueller-teil-Konstantin-Hintermayer.md | 72 +++++++++---------- 4 files changed, 104 insertions(+), 102 deletions(-) diff --git a/Allgemein.md b/Allgemein.md index 97876af..0b979a5 100644 --- a/Allgemein.md +++ b/Allgemein.md @@ -1,3 +1,5 @@ +# Allgemeines + ## Danksagung Obwohl die Umsetzung dieses Projektes durch das Projektteam selbst erfolgte, gab es eine Reihe an Personen, die uns tatkräftig unterstützt haben. @@ -12,9 +14,9 @@ Als wir im Oktober kurzfristig eine neue Produktionsumgebung benötigten, wurde Für den „frischen Wind“ und das sorgfältige Korrekturlesen der Arbeit bedanken wir uns herzlich bei Frau Prof. Gertrude Brindlmayer. Ihr geschulter Blick auf Details, die dem Team im Arbeitsprozess entgangen waren, stellte eine große Bereicherung für die finale Qualität dieser Arbeit dar. -## 2. Projektmanagement mit Scrum +## Projektmanagement mit Scrum -### 2.1 Grundlagen der Scrum-Methode +### Grundlagen der Scrum-Methode Für die Organisation und Umsetzung des Projekts wurde das agile Projektmanagement-Framework Scrum verwendet. Scrum ist ein weit verbreitetes Vorgehensmodell in der Softwareentwicklung, das besonders für Projekte geeignet ist, bei denen sich Anforderungen im Laufe der Entwicklung verändern können. Im Gegensatz zu klassischen Projektmanagementmethoden arbeitet Scrum nicht mit einer vollständig im Voraus geplanten Entwicklung, sondern mit kurzen, wiederkehrenden Entwicklungszyklen. @@ -41,7 +43,7 @@ Anschließend folgt die Sprint Retrospective, in der das Team den Ablauf des ver Durch diese strukturierte Vorgehensweise ermöglicht Scrum eine kontinuierliche Weiterentwicklung der Software sowie eine regelmäßige Überprüfung des Projektfortschritts. -### 2.2 Rollenverteilung im Projektteam +### Rollenverteilung im Projektteam Das Scrum-Framework definiert drei zentrale Rollen, die jeweils unterschiedliche Aufgaben innerhalb des Projekts übernehmen. Diese Rollen tragen dazu bei, Verantwortlichkeiten klar zu strukturieren und den Entwicklungsprozess effizient zu gestalten. @@ -53,7 +55,7 @@ Das Entwicklungsteam ist für die technische Umsetzung der Anforderungen verantw Durch diese klar definierten Rollen wird sichergestellt, dass organisatorische und technische Aufgaben effizient verteilt werden können und der Entwicklungsprozess strukturiert abläuft. -### 2.3 Sprintplanung und Umsetzung +### Sprintplanung und Umsetzung Die Sprintplanung stellt einen wichtigen Bestandteil des Scrum-Prozesses dar. Zu Beginn jedes neuen Sprints trifft sich das Team, um gemeinsam zu entscheiden, welche Aufgaben innerhalb des kommenden Zeitraums umgesetzt werden sollen. @@ -71,7 +73,7 @@ Durch diese regelmäßige Abstimmung wird sichergestellt, dass alle Teammitglied Am Ende eines Sprints werden die entwickelten Funktionen im Sprint Review präsentiert. In diesem Meeting wird überprüft, welche Anforderungen erfolgreich umgesetzt wurden und ob weitere Anpassungen notwendig sind. Anschließend reflektiert das Team im Rahmen der Sprint Retrospective den Arbeitsprozess und identifiziert mögliche Verbesserungen für zukünftige Sprints. -### 2.4 Vorteile von Scrum für die Webentwicklung +### Vorteile von Scrum für die Webentwicklung Die Verwendung von Scrum bietet insbesondere für Webentwicklungsprojekte zahlreiche Vorteile. Webanwendungen entwickeln sich häufig dynamisch weiter, da sich Anforderungen, Technologien oder Benutzerbedürfnisse im Laufe der Zeit verändern können. diff --git a/Diplomarbeitsbuch-individueller-teil-Adam-Gaiswinkler.md b/Diplomarbeitsbuch-individueller-teil-Adam-Gaiswinkler.md index a72e458..d7b4ee9 100644 --- a/Diplomarbeitsbuch-individueller-teil-Adam-Gaiswinkler.md +++ b/Diplomarbeitsbuch-individueller-teil-Adam-Gaiswinkler.md @@ -1,6 +1,6 @@ # Adam Gaiswinkler -## 1. Einleitung +## Einleitung ### Motivation @@ -34,49 +34,49 @@ Das Datenbankdesign sowie die Infrastruktur und das Server-Setup waren nicht Tei --- -## 2. Technologischer Überblick +## Technologischer Überblick In diesem Kapitel werden die Technologien und Werkzeuge vorgestellt, die für die Entwicklung des Anmeldetools, des Hall-of-Fame-Moduls und des Oqtane-Themes eingesetzt wurden. Die Beschreibungen sind dabei so gestaltet, dass sie auch für Leserinnen und Leser ohne technischen Hintergrund verständlich sind. -### 2.1 C# und ASP.NET Core +### C# und ASP.NET Core C# ist eine moderne Programmiersprache von Microsoft, die besonders für die Entwicklung von Webanwendungen und Softwaresystemen geeignet ist. Sie ist klar strukturiert, gut lesbar und weit verbreitet in der professionellen Softwareentwicklung. ASP.NET Core ist ein Framework – also eine Art Werkzeugkasten – das auf C# aufbaut und die Entwicklung von Webseiten und Webanwendungen vereinfacht. Es stellt vorgefertigte Bausteine bereit, sodass man nicht alles von Grund auf neu programmieren muss. Für AlumniHub bildete ASP.NET Core die technische Grundlage aller entwickelten Module. -### 2.2 Blazor +### Blazor Blazor ist ein Framework, das es ermöglicht, interaktive Weboberflächen direkt in C# zu entwickeln. Normalerweise werden solche Oberflächen – also alles, was der Benutzer auf dem Bildschirm sieht und mit dem er interagiert – mit einer anderen Programmiersprache namens JavaScript umgesetzt. Blazor erlaubt es, dasselbe in C# zu schreiben, was die Entwicklung vereinheitlicht und übersichtlicher macht. Konkret bedeutet das: Wenn ein Benutzer beispielsweise auf den „Zusagen"-Button klickt, reagiert die Seite sofort und aktualisiert sich automatisch – ohne dass die gesamte Seite neu geladen werden muss. -### 2.3 Oqtane +### Oqtane Oqtane ist ein Content-Management-System (CMS) – also eine Software, mit der Webseiten und deren Inhalte verwaltet werden können, ähnlich wie WordPress oder Typo3. Das Besondere an Oqtane ist, dass es vollständig auf Blazor und C# aufbaut und eine modulare Architektur besitzt: Man kann eigene Erweiterungen – sogenannte Module – entwickeln und in das System einbinden, ohne den Kern der Software verändern zu müssen. Für AlumniHub wurde Oqtane als Grundlage gewählt, weil es Benutzerverwaltung, Seitenstruktur und viele weitere Standardfunktionen bereits mitbringt und somit viel Entwicklungsaufwand spart. -### 2.4 Bootstrap und CSS +### Bootstrap und CSS CSS (Cascading Style Sheets) ist die Sprache, mit der das Aussehen einer Webseite festgelegt wird – also Farben, Schriftarten, Abstände und das Layout. Bootstrap ist eine fertige Sammlung von CSS-Regeln und Hilfsmitteln, die von Twitter entwickelt wurde und kostenlos verfügbar ist. Der große Vorteil von Bootstrap ist, dass es sogenanntes Responsive Design einfach umsetzbar macht: Die Webseite passt sich automatisch an verschiedene Bildschirmgrößen an – egal ob Desktop, Tablet oder Smartphone. Für AlumniHub wurde Bootstrap als Basis verwendet, ergänzt durch eigenes CSS für das individuelle Erscheinungsbild der Plattform. -### 2.5 QuestPDF +### QuestPDF QuestPDF ist eine kostenlose Open-Source-Bibliothek – also eine fertige Programmsammlung – die es ermöglicht, PDF-Dokumente direkt aus C#-Code heraus zu erstellen. Anstatt ein PDF manuell zu gestalten, beschreibt man im Code wie das Dokument aussehen soll, und QuestPDF generiert daraus automatisch eine fertige PDF-Datei. Im Hall-of-Fame-Modul wurde QuestPDF eingesetzt, um jedem Absolventen zu ermöglichen, sein eigenes Profil als visuell ansprechendes PDF herunterzuladen. -### 2.6 Gitea +### Gitea Wenn mehrere Personen gemeinsam an einem Softwareprojekt arbeiten, braucht man ein System, das alle Änderungen am Code nachverfolgt und verhindert, dass sich Änderungen verschiedener Personen gegenseitig überschreiben. Dieses Konzept nennt sich Versionskontrolle. Gitea ist eine selbst gehostete Plattform für genau diesen Zweck – ähnlich wie GitHub, aber auf einem eigenen Server betrieben. Jede Änderung am Code wird als sogenannter „Commit" gespeichert, sodass man jederzeit nachvollziehen kann, wer wann was geändert hat, und bei Bedarf auf eine ältere Version zurückwechseln kann. -### 2.7 Entwicklungsumgebung +### Entwicklungsumgebung Eine Entwicklungsumgebung – auch IDE (Integrated Development Environment) genannt – ist ein Programm, das Entwicklerinnen und Entwickler beim Schreiben von Code unterstützt. Sie bietet unter anderem Funktionen wie automatische Vervollständigung, Fehlererkennung und integrierte Debugging-Werkzeuge, die das Auffinden und Beheben von Fehlern im Code erleichtern. Zu Beginn des Projekts wurde Visual Studio 2022 auf Windows verwendet. Visual Studio 2022 ist die führende Entwicklungsumgebung von Microsoft für .NET-Projekte und bietet eine umfangreiche Unterstützung für ASP.NET Core und Blazor. Im Laufe des Projekts erfolgte jedoch ein Wechsel von Windows auf macOS. Da Visual Studio 2022 auf Mac nicht mehr verfügbar ist – Microsoft hat die Mac-Version eingestellt – wurde als Ersatz JetBrains Rider eingesetzt. JetBrains Rider ist eine next-generation IDE von Google, die plattformübergreifend funktioniert und eine moderne Entwicklungsumgebung für .NET-Projekte auf macOS bietet. Der Umstieg auf JetBrains Rider ermöglichte es, die Entwicklung auf dem neuen System ohne größere Unterbrechungen fortzusetzen. -### 2.8 Plattformwechsel: Windows zu macOS +### Plattformwechsel: Windows zu macOS Ein besonderer Aspekt der Entwicklung war der Wechsel von Windows auf macOS während des Projektverlaufs. Unter Plattform versteht man in der Softwareentwicklung das Betriebssystem, auf dem eine Anwendung läuft – also etwa Windows, macOS oder Linux. Dieser Wechsel brachte spezifische Herausforderungen mit sich, da Oqtane primär für Windows entwickelt wurde. Obwohl Oqtane grundsätzlich auch auf macOS und Linux lauffähig ist, ist die Unterstützung für diese Plattformen veraltet und nicht vollständig angepasst. In der Praxis bedeutete das: Der Code ließ sich teilweise nicht fehlerfrei kompilieren – also in ein lauffähiges Programm umwandeln – und Oqtane startete zunächst nur mit Fehlermeldungen. Durch den Einsatz von JetBrains Rider als IDE konnten diese Probleme weitgehend gelöst werden, da JetBrains Rider eine bessere plattformübergreifende Integration bietet als die ursprünglich verwendete Entwicklungsumgebung. --- -## 3. Entwicklung des Oqtane Themes +## Entwicklung des Oqtane Themes -### 3.1 Ziel des Themes +### Ziel des Themes Im Rahmen des Projekts AlumniHub wurde ein eigenes Theme für das Content-Management-System Oqtane entwickelt. Ziel dieser Entwicklung war es, das Standarddesign von Oqtane vollständig durch eine projektspezifische Benutzeroberfläche zu ersetzen, die den Anforderungen des Absolventenvereins der HTL Ungargasse entspricht. Das Standardtheme von Oqtane ist funktional, jedoch generisch gehalten und bietet keinen Bezug zur Schule oder zum Projekt. Aus diesem Grund wurde frühzeitig die Entscheidung getroffen, ein vollständig eigenes Theme zu entwickeln, das sowohl optisch als auch technisch auf die Bedürfnisse der Plattform zugeschnitten ist. @@ -84,7 +84,7 @@ Das visuelle Design orientiert sich dabei am bestehenden Erscheinungsbild der of Neben der visuellen Gestaltung standen auch technische Anforderungen im Mittelpunkt. Das Theme sollte auf unterschiedlichen Endgeräten – sowohl auf Desktop-Computern als auch auf Smartphones und Tablets – zuverlässig und benutzerfreundlich funktionieren. Responsive Design war daher von Anfang an eine zentrale Anforderung. Darüber hinaus sollte das Theme vollständig in die Oqtane-Architektur integriert sein, sodass alle Standardfunktionen des CMS wie Benutzerverwaltung, Seitenverwaltung und Modulintegration weiterhin ohne Einschränkungen genutzt werden können. -### 3.2 Technische Umsetzung +### Technische Umsetzung Als technische Grundlage diente die Theme-Architektur von Oqtane. Das Layout wurde in einer zentralen Razor-Datei (`Theme.razor`) definiert, welche von der Basisklasse `ThemeBase` erbt. Durch diese Vererbung stehen im Theme automatisch zentrale Funktionen des Frameworks zur Verfügung, darunter der Seitenzustand (`PageState`), Navigationsdaten, Systemeinstellungen sowie Informationen über den aktuell angemeldeten Benutzer. Dies ermöglicht eine tiefe Integration des Themes in das CMS, ohne dass zusätzliche Schnittstellen oder externe Datenzugriffe notwendig sind. @@ -133,41 +133,41 @@ Neben Navigation und Layout wurden weitere Funktionen in das Theme integriert. D Darüber hinaus wurde das ControlPanel von Oqtane integriert, das Administratorinnen und Administratoren direkten Zugriff auf Verwaltungsfunktionen bietet. Login- und Registrierungsoptionen werden über den `SettingService` aus den Site-Einstellungen geladen, sodass diese Funktionen ohne Anpassungen am Code aktiviert oder deaktiviert werden können. -### 3.3 Herausforderungen +### Herausforderungen Die eigene Implementierung der Navigation über `PageState.Pages` und eine LINQ-basierte Filterlogik erwies sich als die richtige Entscheidung. Sie löste nicht nur das Problem der fehlenden Anpassbarkeit der Standardkomponente, sondern brachte gleichzeitig einen wesentlichen Mehrwert: Die Navigation ist vollständig wartungsfrei. Werden im CMS neue Seiten angelegt, erscheinen diese automatisch im Menü – ohne dass eine einzige Zeile Code angepasst werden muss. Zudem ermöglichte dieser Ansatz die vollständige Kontrolle über das Erscheinungsbild des Burger-Menüs, was mit der Standardkomponente nicht möglich gewesen wäre. --- -## 4. Umsetzung der Module +## Umsetzung der Module -### 4.1 Anmeldetool +### Anmeldetool -#### 4.1.1 Ziel des Moduls +#### Ziel des Moduls Das Anmeldetool wurde entwickelt, um Mitgliedern des Absolventenvereins eine einfache und strukturierte Möglichkeit zu bieten, sich zu Veranstaltungen und Treffen an- oder abzumelden. Ziel des Moduls ist es, den organisatorischen Aufwand bei der Planung und Verwaltung von Treffen deutlich zu reduzieren und gleichzeitig eine benutzerfreundliche Oberfläche für alle Beteiligten bereitzustellen. Das Modul wurde als zusätzliche Funktionserweiterung in das bestehende Content-Management-System integriert. Es ermöglicht sowohl die Verwaltung der Veranstaltungen auf Seiten der Organisatoren als auch eine intuitive Interaktion für die Teilnehmerinnen und Teilnehmer. Durch den Einsatz moderner Webtechnologien konnte dabei eine reaktionsschnelle und geräteübergreifend nutzbare Lösung geschaffen werden. -#### 4.1.2 Frontend (Eingabemaske) +#### Frontend (Eingabemaske) Die Benutzeroberfläche des Anmeldetools wurde mithilfe von Blazor realisiert, einem Framework der ASP.NET-Technologieplattform, das die Entwicklung interaktiver Weboberflächen in C# ermöglicht. Die Eingabemaske wurde als eigenständige Blazor-Komponente implementiert, die flexibel in verschiedene Seiten der Anwendung eingebettet werden kann. Beim Aufruf der Seite wird dem Benutzer zunächst eine kurze Beschreibung der jeweiligen Veranstaltung angezeigt. Im Anschluss stehen zwei klar gekennzeichnete Schaltflächen zur Verfügung: Zusagen zur Bestätigung der Teilnahme sowie Absagen zur Ablehnung. Die Schaltflächen wurden farblich differenziert gestaltet – eine grüne Hervorhebung signalisiert die Zusage, eine rote Darstellung steht für die Absage. Diese Gestaltung orientiert sich an etablierten Designkonventionen moderner Webanwendungen und verbessert die intuitive Bedienbarkeit erheblich. Darüber hinaus wurde besonderer Wert auf eine responsive Darstellung gelegt, damit das Tool sowohl auf Desktop-Geräten als auch auf Smartphones und Tablets problemlos genutzt werden kann. -#### 4.1.3 API-Schnittstelle +#### API-Schnittstelle Die Anbindung des Anmeldetools an das bestehende CMS erfolgt über klar definierte Schnittstellen innerhalb der ASP.NET-Architektur. Die Komponente kommuniziert mit dem Backend, um Veranstaltungsdaten abzurufen sowie Anmelde- und Absagestatus der Teilnehmenden zu übermitteln und zu persistieren. Die Datenübertragung erfolgt nach dem Prinzip der sauberen Komponentenarchitektur: Die Blazor-Komponente ist als eigenständige Einheit konzipiert, die über Parameter und Rückruffunktionen mit übergeordneten Seitenkomponenten kommuniziert. Diese Struktur gewährleistet eine klare Trennung zwischen Darstellungslogik und Datenzugriff und erleichtert zukünftige Erweiterungen der Schnittstelle erheblich. -#### 4.1.4 Datenauswertung +#### Datenauswertung Die im Anmeldetool erfassten Daten bilden die Grundlage für die Verwaltung und Auswertung von Veranstaltungsteilnahmen. Organisatoren können auf Basis der gespeicherten An- und Abmeldungen die Teilnehmerzahlen einsehen und die Planung entsprechend anpassen. Die Architektur des Moduls ist bereits auf zukünftige Erweiterungen ausgelegt. Geplante Erweiterungen umfassen eine übersichtliche Teilnehmerliste mit Namen und Anmeldestatus, die Möglichkeit, eine maximale Teilnehmeranzahl je Veranstaltung festzulegen sowie eine direkte Speicherung und Auswertung der Anmeldedaten in einer Datenbank. Durch diese Erweiterungen soll das Anmeldetool künftig nicht nur als Interaktionselement für Teilnehmer, sondern auch als vollwertiges Verwaltungswerkzeug für Veranstaltungsorganisatoren dienen. -#### 4.1.5 UX-Überlegungen (User Experience) +#### UX-Überlegungen (User Experience) Ein zentraler Aspekt bei der Entwicklung des Anmeldetools war die Benutzerfreundlichkeit der Oberfläche. UX (User Experience) bezeichnet dabei die Gesamtheit aller Erfahrungen, die ein Benutzer bei der Interaktion mit einer Anwendung macht – von der visuellen Gestaltung über die Bedienbarkeit bis hin zur allgemeinen Zufriedenheit mit dem System. Die Module wurden so gestaltet, dass Benutzerinnen und Benutzer die Funktionen ohne zusätzliche Schulung verwenden können. Eine klare Struktur, eine intuitive Bedienung sowie ein konsistentes Erscheinungsbild innerhalb des bestehenden Systems standen dabei im Vordergrund. @@ -175,7 +175,7 @@ Während der Testphase wurden mehrere visuelle Darstellungsprobleme identifizier Diese Maßnahmen stellen einen ersten Schritt in der kontinuierlichen Verbesserung der mobilen Benutzeroberfläche dar. Weitere Feinabstimmungen sind geplant, um das Anmeldetool langfristig als stabile, benutzerfreundliche und geräteübergreifend konsistente Lösung zu etablieren. -### 4.2 Hall of Fame +### Hall of Fame Das Hall-of-Fame-Modul ist ein zentrales Modul der AlumniHub-Plattform. Es dient dazu, ehemalige Absolventinnen und Absolventen der HTL Ungargasse sichtbar zu machen und ihre beruflichen Werdegänge zu präsentieren. Das Modul wurde als eigenständiges, wiederverwendbares Oqtane-Modul entwickelt und ermöglicht es registrierten Benutzerinnen und Benutzern, sich selbst mit einem persönlichen Profil einzutragen. @@ -303,9 +303,9 @@ Die ursprünglich fest codierten Sortierrichtungen wurden durch einen Toggle-But --- -## 5. Übergangslösung, Probleme & Learnings +### Übergangslösung, Probleme & Learnings -### 5.1 Übergangslösung (Sommer 2025) +### Übergangslösung (Sommer 2025) #### Gründe & Technische Umsetzung @@ -327,7 +327,7 @@ Es gab keine Benutzerkonten und keine Authentifizierung. Jede Person, die die Se Diese bewusste Reduktion auf das Wesentliche war jedoch kein Nachteil, sondern eine pragmatische Entscheidung: Die Lösung musste schnell funktionieren und zuverlässig sein – und das war sie. Nach dem Absolvententreffen wurde die Seite nicht einfach abgeschaltet, sondern zu einer reinen Feedback-Seite für das Diplomprojekt umfunktioniert. Über diese Seite konnten Interessierte – darunter Lehrkräfte, Mitschülerinnen und Mitschüler sowie externe Besucher der Präsentation – weiterhin direktes Feedback zum Projekt abgeben. Die Seite blieb so lange in Betrieb, bis die vollständig entwickelte AlumniHub-Plattform diese Funktion nativ übernahm. -### 5.2 Probleme +### Probleme #### Technische Probleme @@ -353,7 +353,7 @@ Neben den technischen Herausforderungen gab es auch auf organisatorischer Ebene Diese Situation führte zu einer deutlichen Ungleichverteilung der Arbeitsbelastung. Wenige Personen mussten in dieser Zeit deutlich mehr Verantwortung übernehmen als ursprünglich geplant, was zu Frustration und Verzögerungen führte. Im Nachhinein zeigt sich, dass klarere Absprachen und verbindlichere Vereinbarungen zu Beginn des Sommers dazu beigetragen hätten, diese Situation zu vermeiden oder zumindest abzumildern. -### 5.3 Learnings +### Learnings #### Technisch @@ -375,7 +375,7 @@ Auf persönlicher Ebene war die wichtigste Erkenntnis aus diesem Projekt die Bed --- -## 6. Testen & Qualitätssicherung +### Testen & Qualitätssicherung ### Funktionstests der Module @@ -395,9 +395,9 @@ Ein häufiges Feedback war, dass die Unterscheidung zwischen Zusage und Absage a --- -## 7. Fazit und Ausblick +### Fazit und Ausblick -### 7.1 Zielerreichung +### Zielerreichung Rückblickend auf das Projekt AlumniHub lässt sich festhalten, dass die zentralen Ziele meines individuellen Aufgabenbereichs erfolgreich umgesetzt wurden. @@ -409,7 +409,7 @@ Das **Theme** wurde von einem anderen Teammitglied entwickelt und ist ebenfalls Insgesamt bin ich mit dem erreichten Stand zufrieden – insbesondere angesichts der Herausforderungen durch die Teamverkleinerung, den Plattformwechsel von Windows auf macOS und die technischen Probleme mit dem ursprünglichen Hosting. -### 7.2 Ausblick +### Ausblick Für die Weiterentwicklung der Plattform gibt es mehrere sinnvolle nächste Schritte. Im Bereich des Anmeldetools wäre die Implementierung einer vollständigen Teilnehmerliste mit direkter Datenbankanbindung der wichtigste nächste Schritt. Ergänzend dazu sollte die Möglichkeit geschaffen werden, maximale Teilnehmerzahlen pro Veranstaltung festzulegen, sodass Organisatoren die Kapazität von Treffen besser steuern können. @@ -419,7 +419,7 @@ AlumniHub bietet als Plattform eine solide Grundlage, die in den kommenden Jahre --- -## 8. Quellen +### Quellen Microsoft: ASP.NET Core Documentation. https://learn.microsoft.com/en-us/aspnet/core/ [Zugriff: 17.03.2026] diff --git a/Diplomarbeitsbuch-individueller-teil-Florian-Edlmayer.md b/Diplomarbeitsbuch-individueller-teil-Florian-Edlmayer.md index 4061725..3a5908e 100644 --- a/Diplomarbeitsbuch-individueller-teil-Florian-Edlmayer.md +++ b/Diplomarbeitsbuch-individueller-teil-Florian-Edlmayer.md @@ -1,20 +1,20 @@ # Florian Edlmayer -## 1. Einleitung des individuellen Teils +## Einleitung des individuellen Teils In diesem Abschnitt wird meine persönliche Aufgabenstellung im Rahmen des Projektes (Alumnihub) beschrieben. -### 1.1 Auftrag / persönliche Aufgabenstellungen +### Auftrag / persönliche Aufgabenstellungen ## 1.3 Nutzen für den Absolventenverein Für den Verein bedeutet das: rechtskonforme Datenverarbeitung, gesicherte Datenverfügbarkeit und ein niedrigschwelliger Login für Absolventinnen und Absolventen mit bestehendem LinkedIn-Konto. -## 2. Anforderungen an das entwickelte Modul bzw. die Funktionalität +## Anforderungen an das entwickelte Modul bzw. die Funktionalität -### 2.1 Modulanforderungen / funktionale Anforderungen +### Modulanforderungen / funktionale Anforderungen -### 2.2 Infrastrukturanforderungen / nicht‑funktionale Anforderungen +### Infrastrukturanforderungen / nicht‑funktionale Anforderungen ### Entwicklung eines CMS-Moduls @@ -35,7 +35,7 @@ Abschließend wurde das Thema Datensicherung umfassend behandelt, da die Sichers Ziel dieser Maßnahmen ist es, das Risiko von Datenverlusten zu minimieren und einen stabilen sowie sicheren Betrieb der Webanwendung zu gewährleisten. Die Backup- und Restore-Prozesse sollen automatisiert ablaufen, um menschliche Fehler zu reduzieren und eine kontinuierliche, regelmäßige Datensicherung sicherzustellen. Dadurch wird eine hohe Ausfallsicherheit sowie die langfristige Verfügbarkeit der gespeicherten Informationen gewährleistet. -### 3.2 Zielsetzung +### Zielsetzung #### Technische Zielsetzung @@ -69,9 +69,9 @@ Darüber hinaus wurde darauf geachtet, dass die Plattform ein modernes Erscheinu Insgesamt verfolgt die gestalterische Zielsetzung das Ziel, eine Plattform zu schaffen, die sowohl funktional als auch optisch ansprechend ist und den Benutzern eine positive Nutzungserfahrung bietet. -## 4. Datenschutz und rechtliche Grundlagen +## Datenschutz und rechtliche Grundlagen -### 4.1 Bedeutung der Datenschutz-Grundverordnung (DSGVO) [@dsgvo] +### Bedeutung der Datenschutz-Grundverordnung (DSGVO) [@dsgvo] Die Datenschutz-Grundverordnung (DSGVO) ist eine rechtsverbindliche Verordnung der Europäischen Union, die seit dem 25. Mai 2018 unmittelbar in allen EU-Mitgliedstaaten gilt und den Schutz personenbezogener Daten regelt. Sie wurde erlassen, um die Rechte natürlicher Personen bei der Verarbeitung ihrer Daten zu stärken und ein einheitliches Datenschutzniveau innerhalb der EU zu gewährleisten. @@ -92,7 +92,7 @@ Die DSGVO enthält dabei zentral die Grundsätze der Datenverarbeitung (Art. 5 D Die Einhaltung dieser Prinzipien ist für jede Organisation verpflichtend, die personenbezogene Daten verarbeitet – unabhängig von ihrer Größe oder Branche. Dies umfasst sowohl technische Aspekte der Datenverarbeitung als auch die Informationspflichten gegenüber Betroffenen, wie sie etwa in Datenschutzerklärungen umgesetzt werden müssen. -### 4.2 Umsetzung der Datenschutzanforderungen auf der Website [@ris] +### Umsetzung der Datenschutzanforderungen auf der Website [@ris] Im Rahmen der Diplomarbeit wurde eine umfassende Analyse der Datenschutzanforderungen durchgeführt und entsprechende Maßnahmen zur Umsetzung auf der Website implementiert. Dabei wurden insbesondere die Vorgaben der DSGVO berücksichtigt, um sicherzustellen, dass die Website den geltenden Datenschutzbestimmungen entspricht. @@ -114,7 +114,7 @@ Neben der Informationspflicht wurden auch technische und organisatorische Maßna • Regelmäßige Sicherheitsupdates der eingesetzten Software • Minimierung der Datenerhebung auf das Notwendige: Es werden nur die Daten erhoben, die für die Funktion der Website unbedingt erforderlich sind. (Grundprinzip der Datenminimierung nach Art. 5 Abs. 1 lit. c DSGVO) -### 4.3 Schutz personenbezogener Daten der Benutzer [@dsb] +### Schutz personenbezogener Daten der Benutzer [@dsb] Der Schutz personenbezogener Daten der Benutzer stellt einen zentralen Bestandteil der Website des Absolventenvereins dar. Sämtliche Datenverarbeitungen erfolgen unter Berücksichtigung der Vorgaben der Datenschutz-Grundverordnung (DSGVO) sowie des österreichischen Datenschutzgesetzes (DSG). @@ -132,9 +132,9 @@ Darüber hinaus besteht das Recht, sich bei der österreichischen Datenschutzbeh Durch die Kombination aus klar definierten Rechtsgrundlagen, transparenten Informationspflichten und technischen Schutzmaßnahmen wird ein hohes Datenschutzniveau gewährleistet und der verantwortungsvolle Umgang mit personenbezogenen Daten sichergestellt. -## 5. Automatisierung von Serverprozessen +## Automatisierung von Serverprozessen -### 5.1 Notwendigkeit von Datensicherung [@bsi_datensicherung][@chatgpt_datensicherung] +### Notwendigkeit von Datensicherung [@bsi_datensicherung][@chatgpt_datensicherung] Die Datensicherung ist ein wesentlicher Bestandteil der Website des Absolventenvereins. Sie dient dazu, die auf der Website gespeicherten Daten vor Verlust oder Beschädigung zu schützen.Digitale Daten bilden die Grundlage für die Funktion der Website und müssen daher regelmäßig gesichert werden. Ein Verlust oder eine Beschädigung der Daten kann zu erheblichen Problemen führen. @@ -251,7 +251,7 @@ Durch diesen Rotationsmechanismus wird verhindert, dass sich im Laufe der Zeit e Die gewählte Anzahl von 30 Sicherungen ermöglicht es, bei täglicher Ausführung des Backup-Skripts ungefähr einen Monat an Wiederherstellungspunkten vorzuhalten. Dadurch wird ein sinnvoller Kompromiss zwischen Datensicherheit und effizienter Speicherverwaltung erreicht. -### 5.3 Implementierung der Backup-Skripte +### Implementierung der Backup-Skripte Die Implementierung des Backup-Systems erfolgte mittels eines Bash-Skripts, das auf dem Linux-Server ausgeführt wird. Bash eignet sich besonders für administrative Aufgaben, da sie direkten Zugriff auf Systembefehle, Dateien und Prozesse bietet. Das Skript wurde so aufgebaut, dass es robust, automatisierbar und nachvollziehbar arbeitet. @@ -310,7 +310,7 @@ Die Implementierung zeichnet sich durch folgende Eigenschaften aus: Durch diese Umsetzung wurde ein zuverlässiges und wartbares Backup-System geschaffen, das den kontinuierlichen Betrieb der Webanwendung unterstützt und im Fehlerfall eine schnelle Wiederherstellung ermöglicht. -### 5.4 Wiederherstellung von Daten mittels Restore-Skripten +### Wiederherstellung von Daten mittels Restore-Skripten Neben der Datensicherung stellt die strukturierte Wiederherstellung der Daten einen zentralen Bestandteil des Backup-Systems dar. Zu diesem Zweck wurde ein eigenes Bash-Skript implementiert, das sowohl die PostgreSQL-Datenbank als auch die Anwendungsdateien aus einem gewählten Backup-Ordner wiederherstellt (Restore-Skript). Ziel war es, einen klar definierten und kontrollierten Prozess zu schaffen, der im Fehlerfall eine vollständige Rücksetzung des Systems ermöglicht. @@ -383,7 +383,7 @@ Der Parameter -x extrahiert das Archiv, -p stellt die ursprünglichen Dateiberec Zusammenfassend ermöglicht das Restore-Skript eine vollständige Rücksetzung der Webanwendung auf einen definierten Sicherungsstand. Durch die Kombination aus Sicherheitsabfrage, kontrollierter Datenbank-Neuerstellung und strukturiertem Dateirestore wird ein zuverlässiger und nachvollziehbarer Wiederherstellungsprozess gewährleistet. Das System ergänzt somit das Backup-Konzept um eine praxisnahe und technisch saubere Lösung für den Ernstfall. -### 5.5 Fazit zur Datensicherung +### Fazit zur Datensicherung Durch die Implementierung eines automatisierten Backup- und Restore-Systems wurde eine zuverlässige Grundlage für die Datensicherheit der Webanwendung geschaffen. Das entwickelte System ermöglicht eine regelmäßige Sicherung sowohl der PostgreSQL-Datenbank als auch der vollständigen Anwendungsdateien. Durch die automatisierte Ausführung mittels Cronjob wird sichergestellt, dass die Backups ohne manuelles Eingreifen täglich erstellt werden. @@ -411,7 +411,7 @@ Nach der Autorisierung sendet LinkedIn einen solchen Autorisierungscode an die W Der Vorteil dieses Verfahrens liegt darin, dass die Webanwendung zu keinem Zeitpunkt Zugriff auf das Passwort des Benutzers erhält. Dadurch wird ein höheres Sicherheitsniveau erreicht und gleichzeitig die Benutzerfreundlichkeit verbessert, da sich Benutzer mit ihrem bestehenden LinkedIn-Konto anmelden können. -### 6.2 Technische Umsetzung der LinkedIn-Anmeldung in Oqtane +### Technische Umsetzung der LinkedIn-Anmeldung in Oqtane Die technische Umsetzung der LinkedIn-Authentifizierung erfolgte über das integrierte External Login System [^8] des Content-Management-Systems Oqtane. Dieses System ermöglicht die Integration externer Identitätsanbieter über standardisierte Protokolle wie OAuth 2.0. @@ -444,7 +444,7 @@ Diese Daten werden von Oqtane als sogenannte Claims verarbeitet und anschließen Darüber hinaus wurde in den Einstellungen aktiviert, dass bei der ersten Anmeldung automatisch ein neues Benutzerkonto erstellt werden kann. Dadurch können sich neue Nutzer direkt über ihr LinkedIn-Konto registrieren. -### 6.3 Ablauf des Anmeldeprozesses +### Ablauf des Anmeldeprozesses Der eigentliche Anmeldevorgang erfolgt in mehreren aufeinanderfolgenden Schritten. Zunächst wählt der Benutzer auf der Login-Seite der Webplattform die Option zur Anmeldung über LinkedIn aus. @@ -454,9 +454,9 @@ Nach erfolgreicher Authentifizierung sendet LinkedIn eine Antwort an die zuvor d Wie in Abschnitt 6.1 beschrieben, werden die abgerufenen Profildaten zur Identifikation oder Neuanlage des Benutzerkontos in der lokalen Datenbank verwendet. -## 7. Implementierung des Premium-Bereichs +## Implementierung des Premium-Bereichs -### 7.1 Ziel und Zweck des Premium-Bereichs +### Ziel und Zweck des Premium-Bereichs Der Premium-Bereich wurde mit dem Ziel entwickelt, den Mitgliedern des SZU Absolventenvereins einen klar abgegrenzten, exklusiven Bereich innerhalb der Vereinswebsite bereitzustellen. Das Premium-Bereich-Modul ist eine Erweiterung für das Content-Management-System Oqtane und bildet das Kernstück des digitalen Mitgliederbereichs. Es ermöglicht Mitgliedern, sich über das Hochladen eines Ingenieur-Antrags als PDF-Dokument für eine zeitlich begrenzte Premium-Mitgliedschaft zu qualifizieren. Premium-Mitglieder erhalten Zugang zu exklusiven Funktionen wie dem Einsehen genehmigter Anträge anderer Mitglieder sowie einer Mitgliedersuche mit integrierter Kontaktfunktion. @@ -664,7 +664,7 @@ public class AddPremiumTables : MultiDatabaseMigration Insgesamt definieren vier Migrationen die Datenbankstruktur: Die erste erstellt die Basistabelle des Moduls, die zweite fügt die drei Tabellen für Ingenieur-Anträge, Premium-Status und Premium-Events hinzu, die dritte entfernt nicht mehr benötigte Spalten nach der Umstellung auf den Oqtane FileManager, und die vierte ergänzt die Felder für Titel und Kurzbeschreibung. Alle Migrationen werden bei der Modulinstallation automatisch ausgeführt. -### 7.3 Zugriffsbeschränkung und Benutzerrechte +### Zugriffsbeschränkung und Benutzerrechte Der Zugriff auf den Premium-Bereich wird durch ein mehrstufiges Berechtigungssystem gesteuert, das sowohl auf Server- als auch auf Client-Seite durchgesetzt wird. Die verfügbaren Berechtigungen werden in der `ModuleInfo`-Klasse registriert: @@ -739,7 +739,7 @@ Zuerst wird die Oqtane-Rollenzugehörigkeit geprüft, anschließend der datenban Die Zugriffsbeschränkung wird konsequent auf beiden Seiten durchgesetzt: Clientseitig entscheidet die Blazor-Komponente anhand der Benutzerrolle, welche UI-Elemente angezeigt werden. Serverseitig prüft jeder Service-Aufruf die Berechtigung des anfragenden Benutzers über das `[Authorize]`-Attribut mit Policies wie `PolicyNames.ViewModule` und `PolicyNames.EditModule`, bevor Daten zurückgegeben oder Änderungen vorgenommen werden. Dadurch wird sichergestellt, dass selbst bei einer Manipulation der Client-Anfrage keine unberechtigten Zugriffe möglich sind. -### 7.4 Mehrwert für registrierte Mitglieder +### Mehrwert für registrierte Mitglieder Der Premium-Bereich schafft einen konkreten Mehrwert für registrierte Mitglieder auf mehreren Ebenen. Auf fachlicher Ebene entsteht durch die gesammelten Ingenieur-Anträge eine wachsende Wissensbasis, die allen Premium-Mitgliedern zugänglich ist. Absolventen können von den Arbeiten anderer Mitglieder lernen, sich inspirieren lassen und fachliche Ansätze vergleichen. Durch die Möglichkeit, Titel und Kurzbeschreibungen zu hinterlegen, können Mitglieder gezielt nach relevanten Themen suchen, ohne jedes PDF-Dokument einzeln öffnen zu müssen. @@ -749,9 +749,9 @@ Auf motivationaler Ebene bietet das zeitlich begrenzte Premium-System einen Anre Der Datenschutz wird dabei konsequent gewahrt. Die Mitgliedersuche gibt nur ausgewählte, nicht-sensible Informationen wie Anzeigenamen und Benutzernamen zurück. E-Mail-Adressen und andere persönliche Daten werden serverseitig herausgefiltert und sind für andere Mitglieder nicht einsehbar. Die Kontaktaufnahme erfolgt ausschließlich über das plattformeigene Benachrichtigungssystem, sodass kein Mitglied seine persönlichen Kontaktdaten preisgeben muss. -## 8. Technologien +## Technologien -### 8.1 ASP.NET und .NET +### ASP.NET und .NET Für die Entwicklung der Webanwendung wurde das Framework ASP.NET in Kombination mit der Plattform .NET verwendet. .NET ist eine von Microsoft entwickelte Entwicklungsplattform zur Erstellung moderner Anwendungen für Web, Desktop, Cloud und mobile Systeme. @@ -771,7 +771,7 @@ Ein weiterer Vorteil von ASP.NET besteht in der klar strukturierten Architektur Diese Struktur erleichtert die Wartung und Erweiterung der Anwendung erheblich, da Änderungen gezielt innerhalb einzelner Komponenten vorgenommen werden können. -### 8.2 PostgreSQL-Datenbank +### PostgreSQL-Datenbank Zur Speicherung der Daten der Plattform wurde das relationale Datenbanksystem PostgreSQL eingesetzt. PostgreSQL gehört zu den leistungsfähigsten Open-Source-Datenbanken und wird weltweit in vielen professionellen Anwendungen verwendet. @@ -814,7 +814,7 @@ Zusätzlich wurden Funktionen im Bereich Datenschutz umgesetzt, die den Anforder Insgesamt konnte ich durch die praktische Umsetzung der Plattform ein deutlich tieferes Verständnis für Webtechnologien, Systemarchitekturen und Backend-Entwicklung gewinnen. -### 9.2 Agile Projektarbeit und Teamarbeit (Zeitmanagement) +### Agile Projektarbeit und Teamarbeit (Zeitmanagement) Neben den technischen Aspekten konnte ich auch wichtige Erfahrungen im Bereich der agilen Projektarbeit sammeln. Für die Organisation des Projekts wurde das agile Framework Scrum eingesetzt. @@ -828,7 +828,7 @@ Darüber hinaus zeigte sich, dass agile Methoden besonders gut für Softwareproj Diese Erfahrungen haben mir ein besseres Verständnis für moderne Softwareentwicklungsprozesse vermittelt und gezeigt, wie wichtig strukturierte Planung und kontinuierliche Verbesserung in technischen Projekten sind. -### 9.3 Persönliche Weiterentwicklung +### Persönliche Weiterentwicklung Neben den technischen und organisatorischen Erkenntnissen stellte die Diplomarbeit auch eine wichtige persönliche Weiterentwicklung dar. Die eigenständige Planung und Umsetzung eines komplexen Softwareprojekts erforderte ein hohes Maß an Selbstorganisation und Durchhaltevermögen. @@ -840,9 +840,9 @@ Ein weiterer wichtiger Lernaspekt war die Verbesserung meiner Fähigkeiten im Be Zusammenfassend hat mir die Diplomarbeit nicht nur tiefere technische Kenntnisse vermittelt, sondern auch meine Fähigkeiten im Bereich Problemlösung, Selbstorganisation und Projektplanung gestärkt. Diese Kompetenzen stellen eine wichtige Grundlage für zukünftige berufliche Tätigkeiten im Bereich der Softwareentwicklung dar. -## 10. Fazit und Ausblick +## Fazit und Ausblick -### 10.1 Zusammenfassung der Arbeit +### Zusammenfassung der Arbeit Ziel dieser Diplomarbeit war die Konzeption und Entwicklung einer webbasierten Alumni-Plattform für den Absolventenverein. Die Plattform soll ehemaligen Studierenden ermöglichen, miteinander in Kontakt zu bleiben, Informationen auszutauschen und an Veranstaltungen des Vereins teilzunehmen. Dadurch wird die Kommunikation zwischen Absolventinnen und Absolventen sowie der Bildungseinrichtung langfristig gestärkt. @@ -856,7 +856,7 @@ Die Entwicklung der Plattform erfolgte nach agilen Prinzipien mithilfe des Scrum Zusammenfassend konnte mit der Diplomarbeit eine funktionale und erweiterbare Plattform entwickelt werden, die eine moderne Grundlage für die digitale Vernetzung von Alumni darstellt. -### 10.2 Mögliche Erweiterungen der Website +### Mögliche Erweiterungen der Website Obwohl bereits viele grundlegende Funktionen implementiert wurden, bietet die Plattform weiteres Potenzial für zukünftige Erweiterungen und Verbesserungen. @@ -878,7 +878,7 @@ erweiterte Such- und Filterfunktionen für Alumni-Profile Durch diese Erweiterungen könnte die Plattform langfristig noch attraktiver und vielseitiger gestaltet werden. -### 10.3 Zukunftspotenzial für den Absolventenverein +### Zukunftspotenzial für den Absolventenverein Die entwickelte Alumni-Plattform bietet dem Absolventenverein eine moderne digitale Infrastruktur zur Verwaltung und Vernetzung seiner Mitglieder. Durch die zentrale Plattform können Informationen, Veranstaltungen und Kontakte effizient organisiert werden. diff --git a/Diplomarbeitsbuch-individueller-teil-Konstantin-Hintermayer.md b/Diplomarbeitsbuch-individueller-teil-Konstantin-Hintermayer.md index 3d54653..2e0b7b1 100644 --- a/Diplomarbeitsbuch-individueller-teil-Konstantin-Hintermayer.md +++ b/Diplomarbeitsbuch-individueller-teil-Konstantin-Hintermayer.md @@ -1,10 +1,10 @@ # Konstantin Hintermayer -## 1. Einleitung des individuellen Teils +## Einleitung des individuellen Teils In diesem Abschnitt wird meine persönliche Aufgabenstellung im Rahmen des Projektes (`Alumnihub`) beschrieben. -### 1.1 Auftrag / persönliche Aufgabenstellungen +### Auftrag / persönliche Aufgabenstellungen Meine Zuständigkeiten und Verantwortlichkeiten: @@ -14,28 +14,28 @@ Meine Zuständigkeiten und Verantwortlichkeiten: - Auswertungen - Schwarzes Brett -### 1.2 Motivation +### Motivation Gegenstand der Diplomarbeit ist die Entwicklung modularer Webanwendungen mit Blazor und Oqtane. Aufbauend auf fundierten Kenntnissen in der Fullstack-Entwicklung (React, Node.js, Golang), welche privat bei diversen Projekten gesammelt worden sind, fokussiert sich die Arbeit auf die Architekturvorteile des .NET-Stacks. Besonders im Fokus stehen die Konsistenz durch statische Typisierung sowie das Zusammenspiel modularer Komponenten in verteilten Systemen. Mein Untersuchungsanliegen: Inwieweit optimiert die Integration von Blazor und dem Oqtane-Framework die Konsistenz und Wartbarkeit modularer Web-Architekturen im Vergleich zu den für mich gewohnten Technologie-Stacks (React/Node.js)? -## 2. Anforderungen an das entwickelte Modul bzw. die Funktionalität +## Anforderungen an das entwickelte Modul bzw. die Funktionalität -### 2.1 Modulanforderungen / funktionale Anforderungen +### Modulanforderungen / funktionale Anforderungen -### 2.2 Infrastrukturanforderungen / nicht‑funktionale Anforderungen +### Infrastrukturanforderungen / nicht‑funktionale Anforderungen - funktionale / nicht‑funktionale Anforderungen - Use Cases -## 3. Technisches Umfeld +## Technisches Umfeld Mein Aufgabenbereich umfasst einerseits die Entwicklung eigener Module, sowie das Bereitstellen des Services. -### 3.1 Auswahlverfahren +### Auswahlverfahren -#### 3.1.1 Entscheidungsfindung CMS +#### Entscheidungsfindung CMS Auch steht die Wahl der Programmiersprache und des CMS an. Nachdem wir im Unterricht fast ausschließlich mit C# entwickelt haben und nicht in eine komplett unbekannte Entwicklungsumgebung abdriften wollten, haben wir uns für die Webentwicklung mit ASP.NET Core 9 (Upgrade im Lauf der Diplomarbeit auf .NET Core 10) und dem CMS Oqtane entschieden. Auch hier gab es einige Kandidaten: @@ -50,7 +50,7 @@ Auch steht die Wahl der Programmiersprache und des CMS an. Nachdem wir im Unterr Insbesondere aufgrund seiner sehr hohen Flexibilität, haben wir uns am Ende für Oqtane entschieden. -#### 3.1.2 Entscheidungsfindung restliche Infrastruktur +#### Entscheidungsfindung restliche Infrastruktur Als Betriebssystem habe ich mich für Linux entschieden, einfach, da ich mit Linux im Serverumfeld die meisten und besten Erfahrungen gemacht habe. @@ -62,7 +62,7 @@ Im Bereich der Datenbanken musste ich mir ein paar Fragen stellen: Es war von Anfang an klar, dass es ein SQL-basiertes System wird, da wir im Team nur mit SQL-basierten Systemen Erfahrungen haben. Außerdem unterstützt unser CMS (Oqtane) nur SQL-basierte Systeme. In der Linuxwelt kommen jetzt nur noch ein paar Datenbankmanagementsysteme in die Auswahl: PostgreSQL, MySQL / MariaDB, SQLite. Da ist die Wahl auf PostgreSQL gefallen. Grund dafür war meine Vorerfahrung mit diesem Datenbankmanagementsystem, welche ich in meinem Nebenjob erlangt habe. -### 3.2 Beschreibung und Architektur von Oqtane +### Beschreibung und Architektur von Oqtane Oqtane ist ein Framework und CMS zur Entwicklung von Webseiten mithilfe von ASP.NET und Blazor. [@oqtane_about] Ein Oqtane-System besteht aus mehreren Komponenten. @@ -70,7 +70,7 @@ In dieser Diplomarbeit fokussieren wir uns hauptsächlich auf `Themes` und `Modu Ein `Module` (Modul) soll neue Funktionalitäten in das CMS hinzufügen und ein `Theme` soll die ganze Gestaltung der Webseite (die Shell) festlegen. [@oqtane_docs_extensions] -#### 3.2.1 Architektur eines Moduls +#### Architektur eines Moduls Ein Modul in Oqtane besteht aus vier Projekten: @@ -84,7 +84,7 @@ Ein Modul in Oqtane besteht aus vier Projekten: - Beim Debug werden die DLLs, PDBs und statischen Assets wie Skripte und Stylesheets der drei anderen Projekte in den bereits gebauten Oqtane.Server `oqtane.framework/oqtane.server/bin/debug/net10.0/...` kopiert. - Beim Release wird ein NuGet-Paket erstellt und unter oqtane.framework/oqtane.server/Packages abgelegt. Dort abgelegte NuGet-Pakete werden beim nächsten Start des Oqtane Servers installiert (Datenbank Migrationen werden gemacht und die Pakete entpackt). -### 3.3 Zusammenspiel der Infrastruktur +### Zusammenspiel der Infrastruktur In diesem Kapitel erkläre ich wie die ausgewählten Komponenten zusammenspielen. Wir verwenden NginX als Reverse Proxy, welcher bei uns die SSL Terminierung macht. Das Zertifikat, welches verwendet wird, wird von Let's Encrypt bereit gestellt und mittels HTTP-Challenges und dem Certbot auf dem Server aktualisiert und verwaltet. Oqtane selber läuft als Systemd-Service im Kestrel Backend. Kestrel ist ein kleiner Webserver, welcher in das ASP.NET Core Framework eingebaut worden ist. Oqtane (bzw. der ASP.NET Core Server "Kestrel") hört auf der Loopback IP und Port 5000. Damit ist Oqtane nur durch NginX erreichbar. PostgreSQL ist die Datenbank in dem System: Sie hört wieder auf der Loopback IP und Port 5432. In der folgenden Grafik ist das System Schematisch dargestellt. @@ -113,9 +113,9 @@ Zusätzlich gab es einen Administrationszugang zu den Servern, welcher über SSH Die VPN basierten Zugänge sind tendenziell schwieriger zu finden und auszunutzen, während die Lösung in der Schule mittels Highport den SSH Service öffentlich erreichbar macht. Durch den `Highport` ist der SSH Service schwieriger zu finden. Zur Authentifizierung mit SSH verwenden wir SSH-Keys, da diese durch ihre komplexität sicherer sind, als Passwörter. -### 3.4 Entwicklung mit ASP.NET +### Entwicklung mit ASP.NET -#### 3.4.1 Blazor [@wikipedia_blazor] +#### Blazor [@wikipedia_blazor] Blazor ist ein kostenloses und quelloffenes Web-Framework, welches es möglich macht Benutzeroberflächen für Web-Browser, basierend auf C# und HTML, zu erstellen. Es wird von Microsoft als teil des ASP.NET Core Frameworks entwickelt. @@ -158,11 +158,11 @@ Razor hat auch eine Reihe an Keywords, wie zum Beispiel (nur Auszugsweise, bzw. - foreach: Für Wiederholungen im Markup - if: Für Verzweigungen im Markup -#### 3.4.2 Kommunikation zwischen Front- und Backend +#### Kommunikation zwischen Front- und Backend Wie Front- und Backend miteinander interagieren hängt hauptsächlich vom Render-Modus ab. Oqtane kann auf verschiedene Arten betrieben werden. Hierbei ist es dem Modulentwickler ziemlich egal, welche Art der Kommunikation (WebSockets, HTTP Long-Polling, REST) verwendet wird. SignalR ist eine Library aus dem ASP.NET Framework, welche es möglich macht, Server zu Client Kommunikation zu betreiben. Oqtane verwendet SignalR im `Interactive Server (SignalR)` Render-Modus. -### 3.5 Dependency Injection +### Dependency Injection Dependency Injection ist ein Entwurfsmuster, bei dem die Abhängigkeiten eines Objekts nicht von diesem selbst erzeugt, sondern von außen „injiziert“ werden. @@ -170,7 +170,7 @@ Wie der Software-Architekt Martin Fowler, der den Begriff im Jahr 2004 maßgebli In den folgenden beiden Kapiteln wird das Dependency Inversion Principle und das Microsoft Dependency Injection Framework genauer vorgestellt. -#### 3.5.1 Dependency Inversion Principle [@ms_dependency_inversion][@logrocket_dependency_inversion] +#### Dependency Inversion Principle [@ms_dependency_inversion][@logrocket_dependency_inversion] Das Dependency-Inversion-Principle (DIP / auf Deutsch: Abhängigkeits-Umkehr-Prinzip) ist eines von den fünf `SOLID` Prinzipien in der Softwareentwicklung. @@ -204,7 +204,7 @@ architecture-beta Das High-Level-Modul ruft lediglich eine Abstraktion eines Low-Level-Moduls auf, welche von einem, oder mehreren Low-Level-Modulen implementiert wurde. Für das High-Level-Modul ist es hier egal, welches Low-Level-Modul die Implementierung bereitstellt. Dadurch erhält man einen viel modulareren Aufbau in der Software. Die einzelnen Module sind auch leichter austauschbar und testbar. Genau diese Modularität macht Dependency Injection möglich. -#### 3.5.2 Microsoft Dependency Injection Framework +#### Microsoft Dependency Injection Framework Dependency Injection ist in .NET genau so wie Konfiguration, Protokollierung und das Optionsmuster ins Framework integriert. [@ms_di_overview] @@ -270,7 +270,7 @@ architecture-beta ``` -### 3.6 Continuous Integration +### Continuous Integration Gitea, das Versionskontrollsystem dieser Diplomarbeit, hat einen Continuous-Integration-System eingebaut. Im Kern ist es baugleich zu den GitHub-Pipelines. Man kann im `.gitea/workflow` Ordner `.yml` Dateien ablegen, welche dann das Verhalten der Workflows definieren. @@ -290,17 +290,17 @@ Anwendungen von Gitea Actions bei dieser Diplomarbeit: - PM Repository: > Zum automatischen Überprüfen der Dokumente, unter anderem, mithilfe von KI, wie zum Beispiel Gemini. -### 3.7 Debian Paket +### Debian Paket TODO -## 4 Projektmanagement & Tools +## Projektmanagement & Tools -### 4.1 Scrum +### Scrum -### 4.2 YouTrack +### YouTrack -### 4.3 Git +### Git Git fungierte im Rahmen dieser Diplomarbeit als zentrales Werkzeug zur Versionskontrolle und Koordination sämtlicher Entwicklungsschritte. Die wichtigste Komponente stellt dabei der Commit dar, welcher als eindeutiger Snapshot des Projektzustands dient und über eine spezifische Commit-SHA (Secure Hash Algorithm) referenziert werden kann. Um eine lückenlose Nachvollziehbarkeit zu gewährleisten, wurde für jeden abgeschlossenen Arbeitsschritt ein eigener Commit erstellt. @@ -318,7 +318,7 @@ Sobald eine Änderung erfolgreich getestet wurde, wird sie durch einen Merge wie Für die Sicherung und Zusammenarbeit wurde im Rahmen dieser Arbeit Remote-Repositories auf einer Gitea Instanz verwendet. Durch die Befehle push und pull wird der lokale Stand mit dem Server synchronisiert. Dies gewährleistet eine konsistente Datenbasis und dient gleichzeitig als kontinuierliches Backup des Projektfortschritts. -### 4.4 Gitea +### Gitea Als schlanke und selbst gehostete Open-Source-Alternative zu Plattformen wie GitHub oder GitLab wurde für die Verwaltung der Repositories Gitea eingesetzt. Hauptgrund für die Benutzung von Gitea war meine bereits aufgesetzte Instanz, welche schon mehrere Jahre in Verwendung war und mit der es im Team auch schon Erfahrungen gab. Gitea bietet neben der reinen Git-Verwaltung essenzielle Werkzeuge für den Software-Lebenszyklus, wie ein integriertes Issue-Tracking, Code-Reviews über Pull-Requests sowie eine Benutzerverwaltung, und unterstützt somit die strukturierte Umsetzung der Diplomarbeit im Team.[@gitea_docs] @@ -346,11 +346,11 @@ Gitea Actions wurden eingesetzt, um CI/CD-Pipelines (Continuous Integration / Co Gitea fungierte zusätzlich als Register für Pakete und Container-Images. Selbst erstellte Artefakte, wie das Debian Paket für die Bereitstellung der Anwendung, wurden direkt in der Gitea-Instanz versioniert gespeichert. Dadurch waren alle notwendigen Komponenten für das Deployment an einem zentralen Ort verfügbar und abrufbar. Gitea selbst unterstützt verschiedenste Pakettypen. Darunter fallen unteranderem NuGet- und Debianpakete. Für beide haben wir in dieser Arbeit verwendung gefunden. [@gitea_docs][@gitea_packages] -### 4.5 Kommunikation +### Kommunikation -## 5 Module +## Module -### 5.1 Admin Modules +### Admin Modules Eine C#-Solution, welche einige Module, welche für den Admineinsatz geschrieben worden sind beinhaltet. Dieses Modul besteht aus 3 Teilmodulen. Einem Modul für den Versand von Rundmails, eines für die Einstellung von der Token Lebenszeit bei Tokens, welche per E-Mail verschickt werden und eines, welches das Reporting-System übernimmt. @@ -419,7 +419,7 @@ Die Implementierung des IReportingComponents stellt nur eine Property (`ReportTy Die Bereitstellung des Moduls geschieht im `AdminModules` Modul. -### 5.2 Event Registration +### Event Registration Dieses Modul ermöglicht es Administratoren und Absolventen, Veranstaltungen zu erstellen, auf der Seite zu veröffentlichen und zu verwalten, während Mitglieder ihre Teilnahme direkt über das Portal bestätigen oder absagen können. Dieses Modul dient der organisatorischen Unterstützung von Absolvententreffen und anderen Vereinsaktivitäten. Dieses Modul wurde gemeinsam mit Adam Gaiswinkler geschrieben, wobei er sich um die Darstellung der Events im Frontend gekümmert hat, während ich mich der Infrastruktur im Hintergrund angenommen habe. @@ -443,7 +443,7 @@ Um die Brücke zwischen dem C#-basierten Blazor-Frontend und der JavaScript-Bibl Durch diese Trennung bleibt die Geschäftslogik im C#-Code, während für die performante und ansprechende Darstellung auf etablierte Web-Technologien zurückgegriffen wird. -### 5.3 Schwarzes Brett +### Schwarzes Brett Das Modul "Schwarzes Brett" dient als digitale Anschlagtafel für den Absolventenverein. Mitglieder können hier Gesuche, Angebote oder allgemeine Informationen veröffentlichen. Es stellt eine zentrale Informationsdrehscheibe dar, die den informellen Austausch innerhalb des Vereins fördern soll. @@ -472,17 +472,17 @@ Ein wichtiges Merkmal des Schwarzen Bretts zur Sicherstellung der Inhaltsqualit Auf der Serverseite folgt das Modul dem etablierten Muster mit einem `BlackBoardRepository` für den effizienten Datenbankzugriff und einem `BlackBoardController` für die API-Bereitstellung. Die Implementierung des Scheduled Jobs als HostedServiceBase ermöglicht eine tiefe Integration in die Oqtane-Infrastruktur bei gleichzeitig geringem Ressourcenverbrauch. -## 6 Learnings +## Learnings -### 6.1 Produktion != Staging +### Produktion != Staging Ein Learning, welches doch relativ schnell aufkam ist im Bereich der IT eigentlich kein unbekanntes. Wir hatten dieses Learning relativ bald, im Frühling 2025, als die ersten Probleme mit dem Deployment von Oqtane aufkamen. Oqtane war zwar in unserer Entwicklungsumgebung sehr einfach zum einrichten gewesen, das Deployment in der Cloud vom Hetzner war jedoch geplagt von Problemen. Im Zeitraum von Mai bis Okober hatten wir keine laufende Produktivumgebung. Dadurch sind wir mit dieser Diplomarbeit auch in [Zeitverzug](#arbeitszeiteinschätzung-zeitverzug) gekommen. Hätte ich mich vor dem Start der Diplomarbeit mit dem Deployment von Oqtane auseinander gesetzt, dann wäre das in [Probleme mit Oqtane](#fehlende-oder-nur-schlechte-dokumentation-von-oqtane) beschriebene Problem früher aufgekommen und der Zeitverzug wäre nicht so groß, oder noch ganz vermeidbar gewesen. -### 6.2 Teamleitung (Motivation / Downsizing) +### Teamleitung (Motivation / Downsizing) Nachdem ich mich von Anfang an volkommen in das Deploymentproblem von Oqtane gestürzt habe, habe ich meine Rolle als Teamleitung etwas schleifen lassen. Dadurch fehlte bei einigen Teammitgliedern initial die Identifikation mit dem Projekt und in weitererfolge auch die Motivation an diesem Projekt mitzuarbeiten. Nachdem im Verlauf des Frühlings und über den Sommer von der hälfte des Teams trotz Besprechungen und Mahnungen keine Beiträge zu dem Projekt kamen, haben Hr. Prof. Gürth und ich uns dazu entschieden uns von 2 Personen vor unterschreiben des Projektantrages zu trennen. Grund dazu war die Angst, die mangelnde Motivation zieht das restliche Team mit hinunter. Wir wollten uns trotz des Downsizings nicht an Funktionalitäten sparen und haben uns für das nächste halbe bis dreiviertel Jahr einen ziemlich strikten Zeitplan vorgenommen. -### 6.3 Arbeitszeiteinschätzung (Zeitverzug) +### Arbeitszeiteinschätzung (Zeitverzug) Ein wesentliches Learning aus dem Projektverlauf war die Diskrepanz zwischen der initialen Planung und dem tatsächlichen Aufwand. Ursprünglich wurde der Zeitaufwand für das Aufsetzen der Infrastruktur und die Einarbeitung in das Oqtane-Framework auf etwa drei Wochen geschätzt. In der Realität nahm dieser Prozess jedoch mehrere Monate in Anspruch. @@ -503,7 +503,7 @@ Um das Projektziel dennoch zu erreichen, wurde der Zeitplan im Herbst 2025 massi > (Jon Bentley. 1985. Programmimg pearls. Commun. ACM 28, 9 (Sept. 1985), 896–901. https://doi.org/10.1145/4284.315122) [@bentley1985programming] > Diese Diplomarbeit liefert weitere Evidenz, dass diese Faustregel stimmt. -### 6.4 Sprints und Meetings (in Zukunft ja asynchron) +### Sprints und Meetings (in Zukunft ja asynchron) Ein zentrales Problem in unserer ursprünglichen Arbeitsweise war die Kopplung von Besprechungsterminen mit festen „Commit-Deadlines“ (dem Ende des aktuellen Sprint zyklusses). Da wir uns einmal pro Woche für sechs Stunden am Stück trafen, entstand ein destruktives Muster: From 332692fc41dbf61abf25ec80f5942d5f2674b59b Mon Sep 17 00:00:00 2001 From: KoCoder Date: Thu, 19 Mar 2026 15:07:20 +0100 Subject: [PATCH 4/9] Pandoc: Mermaid --- _extensions/diagram/_extension.yaml | 7 + _extensions/diagram/diagram.lua | 660 ++++++++++++++++++++++++++++ 2 files changed, 667 insertions(+) create mode 100644 _extensions/diagram/_extension.yaml create mode 100644 _extensions/diagram/diagram.lua diff --git a/_extensions/diagram/_extension.yaml b/_extensions/diagram/_extension.yaml new file mode 100644 index 0000000..e7c5479 --- /dev/null +++ b/_extensions/diagram/_extension.yaml @@ -0,0 +1,7 @@ +title: diagram +author: Albert Krewinkel +version: 1.2.0 +quarto-required: ">=1.3" +contributes: + filters: + - diagram.lua diff --git a/_extensions/diagram/diagram.lua b/_extensions/diagram/diagram.lua new file mode 100644 index 0000000..20d12da --- /dev/null +++ b/_extensions/diagram/diagram.lua @@ -0,0 +1,660 @@ +--[[ +diagram – create images and figures from code blocks. + +See copyright notice in file LICENSE. +]] +-- The filter uses the Figure AST element, which was added in pandoc 3. +PANDOC_VERSION:must_be_at_least '3.0' + +local version = pandoc.types.Version '1.2.0' + +-- Report Lua warnings to stderr if the `warn` function is not plugged into +-- pandoc's logging system. +if not warn then + -- fallback + warn = function(...) io.stderr:write(table.concat({ ... })) end +elseif PANDOC_VERSION < '3.1.4' then + -- starting with pandoc 3.1.4, warnings are reported to pandoc's logging + -- system, so no need to print warnings to stderr. + warn '@on' +end + +local io = require 'io' +local pandoc = require 'pandoc' +local system = require 'pandoc.system' +local utils = require 'pandoc.utils' +local List = require 'pandoc.List' +local stringify = utils.stringify +local with_temporary_directory = system.with_temporary_directory +local with_working_directory = system.with_working_directory + +--- Returns a filter-specific directory in which cache files can be +--- stored, or nil if no such directory is available. +local function cachedir () + local cache_home = os.getenv 'XDG_CACHE_HOME' + if not cache_home or cache_home == '' then + local user_home = system.os == 'windows' + and os.getenv 'USERPROFILE' + or os.getenv 'HOME' + + if not user_home or user_home == '' then + return nil + end + cache_home = pandoc.path.join{user_home, '.cache'} or nil + end + + -- Create filter cache directory + return pandoc.path.join{cache_home, 'pandoc-diagram-filter'} +end + +--- Path holding the image cache, or `nil` if the cache is not used. +local image_cache = nil + +local mimetype_for_extension = { + jpeg = 'image/jpeg', + jpg = 'image/jpeg', + pdf = 'application/pdf', + png = 'image/png', + svg = 'image/svg+xml', +} + +local extension_for_mimetype = { + ['application/pdf'] = 'pdf', + ['image/jpeg'] = 'jpg', + ['image/png'] = 'png', + ['image/svg+xml'] = 'svg', +} + +--- Converts a list of format specifiers to a set of MIME types. +local function mime_types_set (tbl) + local set = {} + local mime_type + for _, image_format_spec in ipairs(tbl) do + mime_type = mimetype_for_extension[image_format_spec] or image_format_spec + set[mime_type] = true + end + return set +end + +--- Reads the contents of a file. +local function read_file (filepath) + local fh = io.open(filepath, 'rb') + local contents = fh:read('a') + fh:close() + return contents +end + +--- Writes the contents into a file at the given path. +local function write_file (filepath, content) + local fh = io.open(filepath, 'wb') + fh:write(content) + fh:close() +end + +--- Like `pandoc.pipe`, but allows "multi word" paths: +-- Supplying a list as the first argument will use the first element as +-- the executable path and prepend the remaining elements to the list of +-- arguments. +local function pipe (command, args, input) + local cmd + if pandoc.utils.type(command) == 'List' then + command = command:map(stringify) + cmd = command:remove(1) + args = command .. args + else + cmd = stringify(command) + end + return pandoc.pipe(cmd, args, input) +end + + +-- +-- Diagram Engines +-- + +-- PlantUML engine; assumes that there's a `plantuml` binary. +local plantuml = { + line_comment_start = [[']], + mime_types = mime_types_set{'pdf', 'png', 'svg'}, + compile = function (self, puml) + local mime_type = self.mime_type or 'image/svg+xml' + -- PlantUML format identifiers correspond to common file extensions. + local format = extension_for_mimetype[mime_type] + if not format then + format, mime_type = 'svg', 'image/svg+xml' + end + local args = {'-t' .. format, "-pipe", "-charset", "UTF8"} + return pipe(self.execpath or 'plantuml', args, puml), mime_type + end, +} + +--- GraphViz engine for the dot language +local graphviz = { + line_comment_start = '//', + mime_types = mime_types_set{'jpg', 'pdf', 'png', 'svg'}, + mime_type = 'image/svg+xml', + compile = function (self, code) + local mime_type = self.mime_type + -- GraphViz format identifiers correspond to common file extensions. + local format = extension_for_mimetype[mime_type] + if not format then + format, mime_type = 'svg', 'image/svg+xml' + end + return pipe(self.execpath or 'dot', {"-T"..format}, code), mime_type + end, +} + +--- Mermaid engine +local mermaid = { + line_comment_start = '%%', + mime_types = mime_types_set{'pdf', 'png', 'svg'}, + compile = function (self, code) + local mime_type = self.mime_type or 'image/svg+xml' + local file_extension = extension_for_mimetype[mime_type] + return with_temporary_directory("diagram", function (tmpdir) + return with_working_directory(tmpdir, function () + local infile = 'diagram.mmd' + local outfile = 'diagram.' .. file_extension + write_file(infile, code) + pipe( + self.execpath or 'mmdc', + {"--pdfFit", "--input", infile, "--output", outfile}, + '' + ) + return read_file(outfile), mime_type + end) + end) + end, +} + +--- TikZ +-- + +--- LaTeX template used to compile TikZ images. +local tikz_template = pandoc.template.compile [[ +\documentclass{standalone} +\usepackage{tikz} +$for(header-includes)$ +$it$ +$endfor$ +$additional-packages$ +\begin{document} +$body$ +\end{document} +]] + +--- The TikZ engine uses pdflatex to compile TikZ code to an image +local tikz = { + line_comment_start = '%%', + + mime_types = { + ['application/pdf'] = true, + }, + + --- Compile LaTeX with TikZ code to an image + compile = function (self, src, user_opts) + return with_temporary_directory("tikz", function (tmpdir) + return with_working_directory(tmpdir, function () + -- Define file names: + local file_template = "%s/tikz-image.%s" + local tikz_file = file_template:format(tmpdir, "tex") + local pdf_file = file_template:format(tmpdir, "pdf") + + -- Treat string values as raw LaTeX + local meta = { + ['header-includes'] = user_opts['header-includes'], + ['additional-packages'] = {pandoc.RawInline( + 'latex', + stringify(user_opts['additional-packages'] or '') + )}, + } + local tex_code = pandoc.write( + pandoc.Pandoc({pandoc.RawBlock('latex', src)}, meta), + 'latex', + {template = tikz_template} + ) + write_file(tikz_file, tex_code) + + -- Execute the LaTeX compiler: + local success, result = pcall( + pipe, + self.execpath or 'pdflatex', + { '-interaction=nonstopmode', '-output-directory', tmpdir, tikz_file }, + '' + ) + if not success then + warn(string.format( + "The call\n%s\nfailed with error code %s. Output:\n%s", + result.command, + result.error_code, + result.output + )) + end + return read_file(pdf_file), 'application/pdf' + end) + end) + end +} + +--- Asymptote diagram engine +local asymptote = { + line_comment_start = '%%', + mime_types = { + ['application/pdf'] = true, + }, + compile = function (self, code) + return with_temporary_directory("asymptote", function(tmpdir) + return with_working_directory(tmpdir, function () + local pdf_file = "pandoc_diagram.pdf" + local args = {'-tex', 'pdflatex', "-o", "pandoc_diagram", '-'} + pipe(self.execpath or 'asy', args, code) + return read_file(pdf_file), 'application/pdf' + end) + end) + end, +} + +--- Cetz diagram engine +local cetz = { + line_comment_start = '%%', + mime_types = mime_types_set{'jpg', 'pdf', 'png', 'svg'}, + mime_type = 'image/svg+xml', + compile = function (self, code) + local mime_type = self.mime_type + local format = extension_for_mimetype[mime_type] + if not format then + format, mime_type = 'svg', 'image/svg+xml' + end + local preamble = [[ +#import "@preview/cetz:0.3.4" +#set page(width: auto, height: auto, margin: .5cm) +]] + + local typst_code = preamble .. code + + return with_temporary_directory("diagram", function (tmpdir) + return with_working_directory(tmpdir, function () + local outfile = 'diagram.' .. format + local execpath = self.execpath + if not execpath and quarto and quarto.version >= '1.4' then + -- fall back to the Typst exec shipped with Quarto. + execpath = List{'quarto', 'typst'} + end + pipe( + execpath or 'typst', + {"compile", "-f", format, "-", outfile}, + typst_code + ) + return read_file(outfile), mime_type + end) + end) + end, +} + +--- D2 engine for the D2 language +local d2 = { + line_comment_start = '#', + mime_types = mime_types_set{'png', 'svg'}, + + compile = function (self, code, user_opts) + return with_temporary_directory('diagram', function (tmpdir) + return with_working_directory(tmpdir, function () + -- D2 format identifiers correspond to common file extensions. + local mime_type = self.mime_type or 'image/svg+xml' + local file_extension = extension_for_mimetype[mime_type] + local infile = 'diagram.d2' + local outfile = 'diagram.' .. file_extension + + args = {'--bundle', '--pad=0', '--scale=1'} + + d2_user_opts = { + 'layout', + } + for _, d2_user_opt in pairs(d2_user_opts) do + if user_opts[d2_user_opt] then + table.insert(args, '--' .. d2_user_opt .. '=' .. user_opts[d2_user_opt]) + end + end + + table.insert(args, infile) + table.insert(args, outfile) + + write_file(infile, code) + + pipe(self.execpath or 'd2', args, '') + + return read_file(outfile), mime_type + end) + end) + end, +} + +local default_engines = { + asymptote = asymptote, + dot = graphviz, + mermaid = mermaid, + plantuml = plantuml, + tikz = tikz, + cetz = cetz, + d2 = d2, +} + +-- +-- Configuration +-- + +--- Options for the output format of the given name. +local function format_options (name) + local pdf2svg = name ~= 'latex' and name ~= 'context' + local is_office_format = name == 'docx' or name == 'odt' + -- Office formats seem to work better with PNG than with SVG. + local preferred_mime_types = is_office_format + and pandoc.List{'image/png', 'application/pdf'} + or pandoc.List{'application/pdf', 'image/png'} + -- Prefer SVG for non-PDF output formats, except for Office formats + if is_office_format then + preferred_mime_types:insert('image/svg+xml') + elseif pdf2svg then + preferred_mime_types:insert(1, 'image/svg+xml') + end + return { + name = name, + pdf2svg = pdf2svg, + preferred_mime_types = preferred_mime_types, + best_mime_type = function (self, supported_mime_types, requested) + return self.preferred_mime_types:find_if(function (preferred) + return supported_mime_types[preferred] and + (not requested or + (pandoc.utils.type(requested) == 'List' and + requested:includes(preferred)) or + (pandoc.utils.type(requested) == 'table' and + requested[preferred]) or + + -- Assume string, Inlines, and Blocks values specify the only + -- acceptable MIME type. + stringify(requested) == preferred) + end) + end + } +end + +--- Returns a configured diagram engine. +local function get_engine (name, engopts, format) + local engine = default_engines[name] or + select(2, pcall(require, stringify(engopts.package))) + + -- Sanity check + if not engine then + warn(PANDOC_SCRIPT_FILE, ": No such engine '", name, "'.") + return nil + elseif engopts == false then + -- engine is disabled + return nil + elseif engopts == true then + -- use default options + return engine + end + + local execpath = engopts.execpath or os.getenv(name:upper() .. '_BIN') + + local mime_type = format:best_mime_type( + engine.mime_types, + engopts['mime-type'] or engopts['mime-types'] + ) + if not mime_type then + warn(PANDOC_SCRIPT_FILE, ": Cannot use ", name, " with ", format.name) + return nil + end + + return { + execpath = execpath, + compile = engine.compile, + line_comment_start = engine.line_comment_start, + mime_type = mime_type, + opt = engopts or {}, + } +end + +--- Returns the diagram engine configs. +local function configure (meta, format_name) + local conf = meta.diagram or {} + local format = format_options(format_name) + meta.diagram = nil + + -- cache for image files + if conf.cache then + image_cache = conf['cache-dir'] + and stringify(conf['cache-dir']) + or cachedir() + pandoc.system.make_directory(image_cache, true) + end + + -- engine configs + local engine = {} + for name, engopts in pairs(conf.engine or default_engines) do + engine[name] = get_engine(name, engopts, format) + end + + return { + engine = engine, + format = format, + cache = image_cache and true, + image_cache = image_cache, + } +end + +-- +-- Format conversion +-- + +--- Converts a PDF to SVG. +local pdf2svg = function (imgdata) + -- Using `os.tmpname()` instead of a hash would be slightly cleaner, but the + -- function causes problems on Windows (and wasm). See, e.g., + -- https://github.com/pandoc-ext/diagram/issues/49 + local pdf_file = 'diagram-' .. pandoc.utils.sha1(imgdata) .. '.pdf' + write_file(pdf_file, imgdata) + local args = { + '--export-type=svg', + '--export-plain-svg', + '--export-filename=-', + pdf_file + } + return pandoc.pipe('inkscape', args, ''), os.remove(pdf_file) +end + +local function properties_from_code (code, comment_start) + local props = {} + local pattern = comment_start:gsub('%p', '%%%1') .. '| ' .. + '([-_%w]+): ([^\n]*)\n' + for key, value in code:gmatch(pattern) do + if key == 'fig-cap' then + props['caption'] = value + else + props[key] = value + end + end + return props +end + +local function diagram_options (cb, comment_start) + local attribs = comment_start + and properties_from_code(cb.text, comment_start) + or {} + for key, value in pairs(cb.attributes) do + attribs[key] = value + end + + local alt + local caption + local fig_attr = {id = cb.identifier} + local filename + local image_attr = {} + local user_opt = {} + + for attr_name, value in pairs(attribs) do + if attr_name == 'alt' then + alt = value + elseif attr_name == 'caption' then + -- Read caption attribute as Markdown + caption = attribs.caption + and pandoc.read(attribs.caption).blocks + or nil + elseif attr_name == 'filename' then + filename = value + elseif attr_name == 'label' then + fig_attr.id = value + elseif attr_name == 'name' then + fig_attr.name = value + else + -- Check for prefixed attributes + local prefix, key = attr_name:match '^(%a+)%-(%a[-%w]*)$' + if prefix == 'fig' then + fig_attr[key] = value + elseif prefix == 'image' or prefix == 'img' then + image_attr[key] = value + elseif prefix == 'opt' then + user_opt[key] = value + else + -- Use as image attribute + image_attr[attr_name] = value + end + end + end + + return { + ['alt'] = alt or + (caption and pandoc.utils.blocks_to_inlines(caption)) or + {}, + ['caption'] = caption, + ['fig-attr'] = fig_attr, + ['filename'] = filename, + ['image-attr'] = image_attr, + ['opt'] = user_opt, + } +end + +local function get_cached_image (hash, mime_type) + if not image_cache then + return nil + end + local filename = hash .. '.' .. extension_for_mimetype[mime_type] + local imgpath = pandoc.path.join{image_cache, filename} + local success, imgdata = pcall(read_file, imgpath) + if success then + return imgdata, mime_type + end + return nil +end + +local function cache_image (codeblock, imgdata, mimetype) + -- do nothing if caching is disabled or not possible. + if not image_cache then + return + end + local ext = extension_for_mimetype[mimetype] + local filename = pandoc.sha1(codeblock.text) .. '.' .. ext + local imgpath = pandoc.path.join{image_cache, filename} + write_file(imgpath, imgdata) +end + +-- Executes each document's code block to find matching code blocks: +local function code_to_figure (conf) + return function (block) + -- Check if a converter exists for this block. If not, return the block + -- unchanged. + local diagram_type = block.classes[1] + if not diagram_type then + return nil + end + + local engine = conf.engine[diagram_type] + if not engine then + return nil + end + + -- Unified properties. + local dgr_opt = diagram_options(block, engine.line_comment_start) + for optname, value in pairs(engine.opt or {}) do + dgr_opt.opt[optname] = dgr_opt.opt[optname] or value + end + + local run_pdf2svg = engine.mime_type == 'application/pdf' + and conf.format.pdf2svg + + -- Try to retrieve the image data from the cache. + local imgdata, imgtype + if conf.cache then + imgdata, imgtype = get_cached_image( + pandoc.sha1(block.text), + run_pdf2svg and 'image/svg+xml' or engine.mime_type + ) + end + + if not imgdata or not imgtype then + -- No cached image; call the converter + local success + success, imgdata, imgtype = + pcall(engine.compile, engine, block.text, dgr_opt.opt) + + -- Bail if an error occurred; imgdata contains the error message + -- when that happens. + if not success then + warn(PANDOC_SCRIPT_FILE, ': ', tostring(imgdata)) + return nil + elseif not imgdata then + warn(PANDOC_SCRIPT_FILE, ': Diagram engine returned no image data.') + return nil + elseif not imgtype then + warn(PANDOC_SCRIPT_FILE, ': Diagram engine did not return a MIME type.') + return nil + end + + -- Convert SVG if necessary. + if imgtype == 'application/pdf' and conf.format.pdf2svg then + imgdata, imgtype = pdf2svg(imgdata), 'image/svg+xml' + end + + -- If we got here, then the transformation went ok and `img` contains + -- the image data. + cache_image(block, imgdata, imgtype) + end + + -- Use the block's filename attribute or create a new name by hashing the + -- image content. + local basename, _extension = pandoc.path.split_extension( + dgr_opt.filename or pandoc.sha1(imgdata) + ) + local fname = basename .. '.' .. extension_for_mimetype[imgtype] + + -- Store the data in the media bag: + pandoc.mediabag.insert(fname, imgtype, imgdata) + + -- Create the image object. + local image = pandoc.Image(dgr_opt.alt, fname, "", dgr_opt['image-attr']) + + -- Create a figure if the diagram has a caption; otherwise return + -- just the image. + return dgr_opt.caption and + pandoc.Figure( + pandoc.Plain{image}, + dgr_opt.caption, + dgr_opt['fig-attr'] + ) or + pandoc.Plain{image} + end +end + +return setmetatable( + {{ + Pandoc = function (doc) + local conf = configure(doc.meta, FORMAT) + return doc:walk { + CodeBlock = code_to_figure(conf), + } + end + }}, + { + version = version, + } +) From e3d4cd275d60e94a53de29c45e8297e7c42df3e7 Mon Sep 17 00:00:00 2001 From: KoCoder Date: Thu, 19 Mar 2026 15:07:31 +0100 Subject: [PATCH 5/9] Pandoc: Razor --- razor.xml | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 razor.xml diff --git a/razor.xml b/razor.xml new file mode 100644 index 0000000..135abfb --- /dev/null +++ b/razor.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From 9c72506d2190596db2f824e0cf01ddaaf977d9e8 Mon Sep 17 00:00:00 2001 From: KoCoder Date: Thu, 19 Mar 2026 15:07:37 +0100 Subject: [PATCH 6/9] Pandoc: Header --- header.tex | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 header.tex diff --git a/header.tex b/header.tex new file mode 100644 index 0000000..312476e --- /dev/null +++ b/header.tex @@ -0,0 +1,8 @@ +\usepackage{etoolbox} +\makeatletter +\patchcmd{\LT@array}{\tabskip\z@}{\tabskip\fill}{}{} +\makeatother + +\usepackage[hyphens]{url} +\usepackage[hidelinks]{hyperref} +\setlength{\emergencystretch}{3em} % Prevent overfull lines From 89ea3ae7a1bba2779ec4bda25ff621ca4411583f Mon Sep 17 00:00:00 2001 From: KoCoder Date: Thu, 19 Mar 2026 15:07:48 +0100 Subject: [PATCH 7/9] Pandoc: Sources --- ieee.csl | 519 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 519 insertions(+) create mode 100644 ieee.csl diff --git a/ieee.csl b/ieee.csl new file mode 100644 index 0000000..7612c15 --- /dev/null +++ b/ieee.csl @@ -0,0 +1,519 @@ + + From 0165f058e696989009cbd8f0bae840aee325253a Mon Sep 17 00:00:00 2001 From: KoCoder Date: Thu, 19 Mar 2026 15:08:03 +0100 Subject: [PATCH 8/9] Pandoc: Sources --- sources.bib | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/sources.bib b/sources.bib index 5bd4557..f7c88ec 100644 --- a/sources.bib +++ b/sources.bib @@ -1,7 +1,7 @@ @online{ms_dependency_inversion, title = {Dependency Inversion}, url = {https://learn.microsoft.com/en-us/dotnet/architecture/modern-web-apps-azure/architectural-principles#dependency-inversion}, - author = {Microsoft}, + author = {{Microsoft}}, year = {2024}, urldate = {2026-03-19} } @@ -9,7 +9,7 @@ @online{logrocket_dependency_inversion, title = {Dependency Inversion Principle}, url = {https://blog.logrocket.com/dependency-inversion-principle/}, - author = {LogRocket}, + author = {{LogRocket}}, year = {2024}, urldate = {2026-03-19} } @@ -17,7 +17,7 @@ @online{oodesign_dependency_inversion, title = {Dependency Inversion Principle}, url = {https://www.oodesign.com/dependency-inversion-principle}, - author = {OO Design}, + author = {{OO Design}}, year = {2024}, urldate = {2026-03-19} } @@ -25,7 +25,7 @@ @online{ms_di_overview, title = {Dependency Injection Overview}, url = {https://learn.microsoft.com/en-us/dotnet/core/extensions/dependency-injection/overview}, - author = {Microsoft}, + author = {{Microsoft}}, year = {2024}, urldate = {2026-03-19} } @@ -33,7 +33,7 @@ @online{oqtane_about, title = {About Oqtane}, url = {https://www.oqtane.org/#about}, - author = {Oqtane Foundation}, + author = {{Oqtane Foundation}}, year = {2024}, urldate = {2026-03-19} } @@ -41,7 +41,7 @@ @online{oqtane_docs_extensions, title = {Oqtane Extensions}, url = {https://docs.oqtane.org/dev/extensions/index.html}, - author = {Oqtane Foundation}, + author = {{Oqtane Foundation}}, year = {2024}, urldate = {2026-03-19} } @@ -49,7 +49,7 @@ @online{wikipedia_blazor, title = {Blazor}, url = {https://en.wikipedia.org/wiki/Blazor}, - author = {Wikipedia}, + author = {{Wikipedia}}, year = {2024}, urldate = {2026-03-19} } @@ -93,7 +93,7 @@ @online{gitea_docs, title = {Gitea Documentation}, url = {https://docs.gitea.com/}, - author = {Gitea}, + author = {{Gitea}}, year = {2024}, urldate = {2026-03-19} } @@ -101,7 +101,7 @@ @online{gitea_issue_tracker, title = {Gitea Issue Tracker Comparison}, url = {https://docs.gitea.com/installation/comparison#issue-tracker}, - author = {Gitea}, + author = {{Gitea}}, year = {2024}, urldate = {2026-03-19} } @@ -109,7 +109,7 @@ @online{gitea_pull_requests, title = {Gitea Pull Requests}, url = {https://docs.gitea.com/usage/pull-request}, - author = {Gitea}, + author = {{Gitea}}, year = {2024}, urldate = {2026-03-19} } @@ -117,7 +117,7 @@ @online{gitea_actions, title = {Gitea Actions Overview}, url = {https://docs.gitea.com/usage/actions/overview}, - author = {Gitea}, + author = {{Gitea}}, year = {2024}, urldate = {2026-03-19} } @@ -125,7 +125,7 @@ @online{gitea_packages, title = {Gitea Packages Overview}, url = {https://docs.gitea.com/usage/packages/overview}, - author = {Gitea}, + author = {{Gitea}}, year = {2024}, urldate = {2026-03-19} } @@ -133,7 +133,7 @@ @online{dsgvo, title = {Datenschutz-Grundverordnung (DSGVO)}, url = {https://eur-lex.europa.eu/eli/reg/2016/679/}, - author = {Europäische Union}, + author = {{Europäische Union}}, year = {2016}, urldate = {2026-03-19} } @@ -141,7 +141,7 @@ @online{ris, title = {Rechtsinformationssystem des Bundes (RIS)}, url = {https://www.ris.bka.gv.at/}, - author = {Bundeskanzleramt Österreich}, + author = {{Bundeskanzleramt Österreich}}, year = {2024}, urldate = {2026-03-19} } @@ -149,7 +149,7 @@ @online{dsb, title = {Österreichische Datenschutzbehörde (DSB)}, url = {https://dsb.gv.at/}, - author = {Datenschutzbehörde}, + author = {{Datenschutzbehörde}}, year = {2024}, urldate = {2026-03-19} } @@ -157,7 +157,7 @@ @online{bsi_datensicherung, title = {Datensicherung und Datenverlust}, url = {https://www.bsi.bund.de/DE/Themen/Verbraucherinnen-und-Verbraucher/Informationen-und-Empfehlungen/Cyber-Sicherheitsempfehlungen/Daten-sichern-verschluesseln-und-loeschen/Datensicherung-und-Datenverlust/Datensicherung-wie-geht-das/datensicherung-wie-geht-das_node.html}, - author = {Bundesamt für Sicherheit in der Informationstechnik (BSI)}, + author = {{Bundesamt für Sicherheit in der Informationstechnik (BSI)}}, year = {2024}, urldate = {2026-03-19} } @@ -165,7 +165,7 @@ @online{chatgpt_datensicherung, title = {Notwendigkeit der Datensicherung}, url = {https://chatgpt.com/c/69a06632-e4fc-8384-bd6c-a543d7bbd00d}, - author = {OpenAI (ChatGPT)}, + author = {{OpenAI (ChatGPT)}}, year = {2024}, urldate = {2026-03-19} } From bce54b3b046886e1d27dbcf4e19016f840229d5c Mon Sep 17 00:00:00 2001 From: KoCoder Date: Thu, 19 Mar 2026 15:08:55 +0100 Subject: [PATCH 9/9] Pandoc: Command --- metadata.yaml | 7 +++++++ pandoc-cmd.sh | 18 ++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 metadata.yaml create mode 100755 pandoc-cmd.sh diff --git a/metadata.yaml b/metadata.yaml new file mode 100644 index 0000000..d8c3b7e --- /dev/null +++ b/metadata.yaml @@ -0,0 +1,7 @@ +--- +include_toc: true +gitea: none +lang: de-DE +csl: ieee.csl +link-citations: true +--- diff --git a/pandoc-cmd.sh b/pandoc-cmd.sh new file mode 100755 index 0000000..95c383b --- /dev/null +++ b/pandoc-cmd.sh @@ -0,0 +1,18 @@ +#!/bin/bash +pandoc \ + Allgemein.md \ + Diplomarbeitsbuch-individueller-teil-Konstantin-Hintermayer.md \ + Diplomarbeitsbuch-individueller-teil-Florian-Edlmayer.md \ + Diplomarbeitsbuch-individueller-teil-Adam-Gaiswinkler.md \ + bibliographie.md \ + --toc \ + --toc-depth=3 \ + --number-sections \ + --lua-filter _extensions/diagram/diagram.lua \ + --syntax-definition razor.xml \ + --citeproc \ + --bibliography sources.bib \ + -V geometry:margin=2cm \ + -H header.tex \ + --lof \ + -o diplomarbeitsbuch.pdf \ No newline at end of file