diff options
| author | Orangerot <purple@orangerot.dev> | 2024-05-24 17:42:08 +0200 |
|---|---|---|
| committer | Orangerot <purple@orangerot.dev> | 2024-05-24 17:47:22 +0200 |
| commit | 7fcdc1c788725f866de71fc9dfd8c4d1cb132b57 (patch) | |
| tree | 89931c85ae3f149884ba02c69862558e93f01531 /11-entwurfsheft-kolloquium | |
Diffstat (limited to '11-entwurfsheft-kolloquium')
46 files changed, 3024 insertions, 0 deletions
diff --git a/11-entwurfsheft-kolloquium/.gitignore b/11-entwurfsheft-kolloquium/.gitignore new file mode 100644 index 0000000..87ec682 --- /dev/null +++ b/11-entwurfsheft-kolloquium/.gitignore @@ -0,0 +1,302 @@ +## Core latex/pdflatex auxiliary files: +*.aux +*.lof +*.log +*.lot +*.fls +*.out +*.toc +*.fmt +*.fot +*.cb +*.cb2 +.*.lb + +## Intermediate documents: +*.dvi +*.xdv +*-converted-to.* +# these rules might exclude image files for figures etc. +# *.ps +# *.eps +*.pdf +!assets/*.pdf + +## Generated if empty string is given at "Please type another file name for output:" +.pdf + +## Bibliography auxiliary files (bibtex/biblatex/biber): +*.bbl +*.bcf +*.blg +*-blx.aux +*-blx.bib +*.run.xml + +## Build tool auxiliary files: +*.fdb_latexmk +*.synctex +*.synctex(busy) +*.synctex.gz +*.synctex.gz(busy) +*.pdfsync + +## Build tool directories for auxiliary files +# latexrun +latex.out/ + +## Auxiliary and intermediate files from other packages: +# algorithms +*.alg +*.loa + +# achemso +acs-*.bib + +# amsthm +*.thm + +# beamer +*.nav +*.pre +*.snm +*.vrb + +# changes +*.soc + +# comment +*.cut + +# cprotect +*.cpt + +# elsarticle (documentclass of Elsevier journals) +*.spl + +# endnotes +*.ent + +# fixme +*.lox + +# feynmf/feynmp +*.mf +*.mp +*.t[1-9] +*.t[1-9][0-9] +*.tfm + +#(r)(e)ledmac/(r)(e)ledpar +*.end +*.?end +*.[1-9] +*.[1-9][0-9] +*.[1-9][0-9][0-9] +*.[1-9]R +*.[1-9][0-9]R +*.[1-9][0-9][0-9]R +*.eledsec[1-9] +*.eledsec[1-9]R +*.eledsec[1-9][0-9] +*.eledsec[1-9][0-9]R +*.eledsec[1-9][0-9][0-9] +*.eledsec[1-9][0-9][0-9]R + +# glossaries +*.acn +*.acr +*.glg +*.glo +*.gls +*.glsdefs +*.lzo +*.lzs +*.slg +*.slo +*.sls + +# uncomment this for glossaries-extra (will ignore makeindex's style files!) +*.ist + +# gnuplot +*.gnuplot +*.table + +# gnuplottex +*-gnuplottex-* + +# gregoriotex +*.gaux +*.glog +*.gtex + +# htlatex +*.4ct +*.4tc +*.idv +*.lg +*.trc +*.xref + +# hyperref +*.brf + +# knitr +*-concordance.tex +# TODO Uncomment the next line if you use knitr and want to ignore its generated tikz files +# *.tikz +*-tikzDictionary + +# listings +*.lol + +# luatexja-ruby +*.ltjruby + +# makeidx +*.idx +*.ilg +*.ind + +# minitoc +*.maf +*.mlf +*.mlt +*.mtc[0-9]* +*.slf[0-9]* +*.slt[0-9]* +*.stc[0-9]* + +# minted +_minted* +*.pyg + +# morewrites +*.mw + +# newpax +*.newpax + +# nomencl +*.nlg +*.nlo +*.nls + +# pax +*.pax + +# pdfpcnotes +*.pdfpc + +# sagetex +*.sagetex.sage +*.sagetex.py +*.sagetex.scmd + +# scrwfile +*.wrt + +# svg +svg-inkscape/ + +# sympy +*.sout +*.sympy +sympy-plots-for-*.tex/ + +# pdfcomment +*.upa +*.upb + +# pythontex +*.pytxcode +pythontex-files-*/ + +# tcolorbox +*.listing + +# thmtools +*.loe + +# TikZ & PGF +*.dpth +*.md5 +*.auxlock + +# titletoc +*.ptc + +# todonotes +*.tdo + +# vhistory +*.hst +*.ver + +# easy-todo +*.lod + +# xcolor +*.xcp + +# xmpincl +*.xmpi + +# xindy +*.xdy + +# xypic precompiled matrices and outlines +*.xyc +*.xyd + +# endfloat +*.ttt +*.fff + +# Latexian +TSWLatexianTemp* + +## Editors: +# WinEdt +*.bak +*.sav + +# Texpad +.texpadtmp + +# LyX +*.lyx~ + +# Kile +*.backup + +# gummi +.*.swp + +# KBibTeX +*~[0-9]* + +# TeXnicCenter +*.tps + +# auto folder when using emacs and auctex +./auto/* +*.el + +# expex forward references with \gathertags +*-tags.tex + +# standalone packages +*.sta + +# Makeindex log files +*.lpz + +# xwatermark package +*.xwm + +# REVTeX puts footnotes in the bibliography by default, unless the nofootinbib +# option is specified. Footnotes are the stored in a file with suffix Notes.bib. +# Uncomment the next line to have this generated file ignored. +#*Notes.bib diff --git a/11-entwurfsheft-kolloquium/.gitlab-ci.yml b/11-entwurfsheft-kolloquium/.gitlab-ci.yml new file mode 100644 index 0000000..27d0617 --- /dev/null +++ b/11-entwurfsheft-kolloquium/.gitlab-ci.yml @@ -0,0 +1,36 @@ +plantuml: + stage: .pre + image: + name: plantuml/plantuml + entrypoint: [""] + script: + - java -jar plantuml.jar -tpdf assets/diagrams/*.puml + artifacts: + paths: + - assets + +tex: + stage: build + image: texlive/texlive + script: + - mkdir public + - make tex + - mv *.pdf public + artifacts: + paths: + - public + dependencies: + - plantuml + +pages: + stage: deploy + script: + - echo Hello, World! + artifacts: + paths: + - public + rules: + - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH + dependencies: + - tex + diff --git a/11-entwurfsheft-kolloquium/CHANGELOG.md b/11-entwurfsheft-kolloquium/CHANGELOG.md new file mode 100644 index 0000000..7671a41 --- /dev/null +++ b/11-entwurfsheft-kolloquium/CHANGELOG.md @@ -0,0 +1,34 @@ +# Changelog +Alle Änderungen an diesem Projekt werden in dieser Datei dokumentiert. +Die Versionsnummern folgt der Syntax in `sdqbeamer.cls`. + +## [2022-05-03 v3.1.3] +- Die Breite des Gruppennamens in der Fußzeile kann nun über `\groupnamewidth{}` gesteuert werden +- FIX: zweizeilige Fußzeilen haben nun gleichmäßigen vertikalen Abstand (Issue #16 in Gitlab) + +## [2021-08-10 v3.1.2] +- FIX: framesubtitle wird nun angezeigt (Issue #6 in Gitlab) + +## [2020-12-08 v3.1.1] +- FIX: Titelbild (Issue #4 in Gitlab) + +## [2020-12-07 v3.1] +- Umgebung ``contentblock`` (farbloser Block mit fetter Überschrift) hinzugefügt +- Farbboxen (``greenblock``, ``blueblock``, …) hinzugefügt +- Abstufungen der KIT-Farben in 10er-Schritten entsprechend der Gestaltungsrichtlinien eingeführt +- FIX: Navigationspunkte für Subsections in eine Zeile gesetzt, um vertikal Platz zu sparen +- FIX: ``inputenc`` an den Anfang von ``sdqbeamer.cls`` verschoben + +## [2020-11-16 v3.0] +- Seitenformat 16:10 hinzugefügt +- Umstellung auf KIT-Design vom 1. August 2020 + - Anpassung auf neues Farbschema und Maße + - neues Titelbild aus der KIT-Bildwelt +- Neue Optionen: + - durch `smallfoot` und `bigfoot` kann die Schriftgröße der Fußzeile gesteuert werden + - durch `navbarkit` kann eine Fußzeile nach KIT-Vorgaben erzwungen werden +- Deutsch (`de`) ist nun die Standard-Option +- Ordner `templates` wurde gelöscht und die Inhalte in `sdqbeamer.cls` integriert +- Globale Größe auf 10 pt verringert (vorher: 11 pt), da der beschreibbare Bereich im Vergleich zur 2009er Version kleiner geworden ist +- SDQ-spezifische Logos und Titelbilder entfernt. Diese sind ab sofort im Branch »sdq« verfügbar. +- Fix: Zeilenumbruch bei Titel in der Fußzeile repariert
\ No newline at end of file diff --git a/11-entwurfsheft-kolloquium/Makefile b/11-entwurfsheft-kolloquium/Makefile new file mode 100644 index 0000000..67f5384 --- /dev/null +++ b/11-entwurfsheft-kolloquium/Makefile @@ -0,0 +1,18 @@ +MAIN = presentation +FLAGS = -pdf + +all: clean compile +compile: diagram tex +clean: clean-diagram clean-tex + +dev: + latexmk $(FLAGS) -pvc $(MAIN) +tex: + latexmk $(FLAGS) $(MAIN) +diagram: + java -jar plantuml.jar -tpdf assets/diagrams/*.puml +clean-tex: + latexmk -C +clean-diagram: + find assets/diagrams -type f -not -name '*.puml' -delete + diff --git a/11-entwurfsheft-kolloquium/README.md b/11-entwurfsheft-kolloquium/README.md new file mode 100644 index 0000000..6a5e9ea --- /dev/null +++ b/11-entwurfsheft-kolloquium/README.md @@ -0,0 +1,118 @@ +LaTeX-Vorlage für Präsentationen +================================ + +Das vorliegende Paket dient als Vorlage für Präsentationen im [Corporate Design des KIT](https://intranet.kit.edu/gestaltungsrichtlinien.php) (Fassung vom 1. August 2020). + +Es wird an der Forschungsgruppe [DSiS](https://dsis.kastel.kit.edu) an der KIT-Fakultät für Informatik entwickelt und basiert auf [LaTeX Beamer](https://ctan.org/pkg/beamer). + +Autor: [Dr.-Ing. Erik Burger](https://dsis.kastel.kit.edu/staff_erik_burger.php) +mit Beiträgen von Christian Hammer, Klaus Krogmann und Maximilian Schambach + +Siehe https://sdqweb.ipd.kit.edu/wiki/Dokumentvorlagen + +Hinweise, Verbesserungsvorschläge +================================= + +Bitte verwenden Sie das [Issue-Tracking-System von Gitlab](https://git.scc.kit.edu/i43/dokumentvorlagen/praesentationen/beamer/-/issues), um auf Probleme mit der Vorlage hinzuweisen oder Erweiterungswünsche zu äußern. Sie können gerne auch eine Änderung per Merge-Request vorschlagen. + +Verwendung +========== + +Optionen der Dokumentklasse `sdqbeamer` +----------------------------------------- +Durch die folgenden Optionen kann das Seitenverhältnis der Folien bestimmt werden: + +| Seitenverhältnis | Option | +| ---------------- | ------------------- | +| 16:9 | `16:9` (Standard) | +| 16:10 | `16:10` | +| 4:3 | `4:3` | + +Die Schriftgröße in der Fußzeile ist standardmäßig größer gewählt, als in den Gestaltungsrichtlinien vorgegeben. Diese Vorgabe kann durch die Option `smallfoot` erzwungen werden. + +| Schriftgröße Fußzeile | Option | +| ----------------------| -------------------- | +| etwas größer (12pt) | `bigfoot` (Standard) | +| KIT-Vorgabe (9pt) | `smallfoot` | + +Die Plazierung der Navigationsleiste kann durch folgende Optionen beeinflußt werden: + +| Position | Option | Bemerkung | +| ------------------------ | ---------------- | ------------------------------------------ | +| oberhalb der Trennlinie | `navbarinline` | Standard | +| unterhalb der Trennlinie | `navbarinfooter` | keine Subsection-Punkte, Größe `smallfoot` | +| Seitenleiste links | `navbarside` | keine Subsection-Punkte | +| keine Navigationsleiste | `navbaroff` | | +| KIT-Vorgabe | `navbarkit` | entspricht `navbaroff` und `smallfoot` | + +Als Sprache sind Deutsch und Englisch verfügbar. Durch die Sprachwahl werden automatisch die passenden Logos und Formate (z.B. Datum) gewählt. + +| Sprache | | +| -------- |---------------- | +| Deutsch | `de` (Standard) | +| Englisch | `en` | + +Beispiel: `\documentclass[de,16:9,navbarinline]{sdqbeamer}` + +Titelbild +--------- + +Das Bild auf der Titelfolie kann mit dem Befehl + +`\titleimage{myimage}` (ohne Dateiendung) + +gesetzt werden. Um ein eigenes Bild zu verwenden, bitte die Datei (z.B. `myimage.jpg`) ins `logos/`-Verzeichnis legen und den Befehl anpassen. Mitgeliefert wird ein generisches Bild aus der KIT-Bildwelt (https://intranet.kit.edu/gestaltungsrichtlinien.php) in der Datei `logos/banner_2020_kit.jpg`. Falls kein Titelbild eingefügt werden soll, bitte `\titleimage{}` setzen. + +Für 16:9-Folien sollte das Verhältnis des Bildes 160:37 betragen, für 4:3-Folien 63:20. Es können auch breitere Bilder verwendet werden, da das Titelbild auf die Höhe des Rahmens skaliert und zentriert wird. + +Logo und Name Abteilung/KIT-Fakultät/Institut +--------------------------------------------- + +Das Logo rechts oben auf der Titelfolie kann mit dem folgenden Befehl gesetzt werden: + +`\grouplogo{mylogo}` (ohne Dateiendung) + +Um ein eigenes Logo zu verwenden, bitte die Datei (z.B. `mylogo.pdf`) in das Verzeichnis `logos/` legen und den Befehl anpassen. Falls kein Logo eingefügt werden soll, bitte `\grouplogo{}` setzen. + +Der Gruppenname kann mit folgendem Befehl gesetzt werden: + +`\groupname{Software Design and Quality}` + +Der Gruppenname erscheint in der Fußzeile rechts unten. Lange Namen werden in zwei Zeilen umgebrochen. Falls der Gruppenname leer gelassen wird (`\groupname{}`), wird die volle Breite der Fußzeile für Autornamen und Titel verwendet. + +Die Standardbreite des Gruppennamens sind 50 mm. Sie kann mit + +`\groupnamewidth{80mm}` + +verändert werden, wodurch sich auch die Breite des Textfeldes mit Autor und Titel entsprechend ändert. Umbrüche sind mit `\\` möglich. Statt zweizeiliger Fußzeilen empfiehlt sich eventuell die Option `smallfoot`. + +LaTeX allgemein +--------------- +Siehe https://sdqweb.ipd.kit.edu/wiki/LaTeX + +Dateistruktur +============ +`presentation.tex` +------------------ +Hauptdatei des LaTeX-Dokuments. + +`presentation.bib` +------------- +Beispieldatei für BibTeX-Referenzen +https://sdqweb.ipd.kit.edu/wiki/BibTeX-Literaturlisten + +`sdqbeamer.cls` +----------------- +Dokumentklasse für Präsentationen im KIT-Design. + +`logos/` +-------- +In diesem Verzeichnis befinden das KIT-Logo als PDF sowie das Hintergrundbild der Titelfolie als JPG. + +`CHANGELOG.md` +-------------- +Dokumentation der Änderungen in den jeweiligen Versionen. + +`README.md` +----------- +Dieser Text. diff --git a/11-entwurfsheft-kolloquium/assets/.gitignore b/11-entwurfsheft-kolloquium/assets/.gitignore new file mode 100644 index 0000000..16252a4 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/.gitignore @@ -0,0 +1,3 @@ +diagrams/* +!diagrams/*.puml + diff --git a/11-entwurfsheft-kolloquium/assets/.gitingnore b/11-entwurfsheft-kolloquium/assets/.gitingnore new file mode 100644 index 0000000..16252a4 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/.gitingnore @@ -0,0 +1,3 @@ +diagrams/* +!diagrams/*.puml + diff --git a/11-entwurfsheft-kolloquium/assets/KIT_Deckblatt.pdf b/11-entwurfsheft-kolloquium/assets/KIT_Deckblatt.pdf Binary files differnew file mode 100644 index 0000000..7de8ed4 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/KIT_Deckblatt.pdf diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/backendComponentDiagram.puml b/11-entwurfsheft-kolloquium/assets/diagrams/backendComponentDiagram.puml new file mode 100644 index 0000000..806522c --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/backendComponentDiagram.puml @@ -0,0 +1,61 @@ +@startuml
+' skinparam linetype ortho
+
+'#########################################################################
+'SubscriptionsAPI
+component SubscriptionsAPI {
+
+ component SubscriptionService
+ component SubscriptionController
+ component SubscriptionDataAccessLayer
+
+ portout "Webserver" as wSub
+ portin "Database" as dSub
+ }
+
+dSub --0)- SubscriptionDataAccessLayer
+SubscriptionDataAccessLayer --0)- SubscriptionService
+SubscriptionService --0)- SubscriptionController
+SubscriptionController --0)- wSub
+
+'#########################################################################
+
+
+'#########################################################################
+'EpisodeActionsAPI
+
+component EpisodeActionsAPI {
+ component EpisodeActionService
+ component EpisodeActionController
+ component EpisodeActionDataAccessLayer
+
+ portout "Webserver" as wEpisode
+ portin "Database" as dEpisode
+}
+
+dEpisode --0)- EpisodeActionDataAccessLayer
+EpisodeActionController --0)- wEpisode
+EpisodeActionDataAccessLayer --0)- EpisodeActionService
+EpisodeActionService --0)- EpisodeActionController
+
+'#########################################################################
+
+
+'#########################################################################
+'AuthenticationAPI
+
+component AuthenticationAPI {
+ component AuthenticationService
+ component AuthenticationController
+ component AuthenticationDataAccessLayer
+
+ portout "Webserver" as wAuth
+ portin "Database" as dAuth
+}
+
+dAuth --0)- AuthenticationDataAccessLayer
+AuthenticationController --0)- wAuth
+AuthenticationDataAccessLayer --0)- AuthenticationService
+AuthenticationService --0)- AuthenticationController
+
+@enduml
diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram-authentication.puml b/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram-authentication.puml new file mode 100644 index 0000000..a2b3518 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram-authentication.puml @@ -0,0 +1,112 @@ +@startuml + +package authenticationAPI <<Frame>> { + package authenticationDataAccessLayer <<Frame>> { + ' interface AuthenticationDao { + ' String login(String username) + ' int logout(String username) + ' } + + ' class AuthenticationDataAccessService <<@Respository>> { + ' <<create>> AuthenticationDataAccessService(JpaTemplate jpaTemplate) + ' String login(String username) + ' int logout(String username) + ' } + + interface UserDetailsManager { + void createUser(UserDetails userDetails) + void changePassword(String oldPassword, String newPassword) + void deleteUser(String username) + void updateUser(UserDetails user) + boolean userExists(String username) + } + note left + Aus org.springframework.security.provisioning + - liefert Methoden zum Erstellen neuer User + und zum Aktualisieren bestehender. + end note + + class JdbcUserDetailsManager <<@Repository>> { + <<create>> JdbcUserDetailsManager(DataSource dataSource) + void createUser(UserDetails user) + void changePassword(String oldPassword, String newPassword) + void deleteUser(String username) + void updateUser(UserDetails user) + boolean userExists(String username) + } + note right + User Management Service aus dem Paket + org.springframework.security.provisioning + der CRUD Operationen für User bereitstellt. + Hier sind nur die relevanten Methoden modelliert. + end note + } + + package authenticationService <<Frame>> { + class AuthenticationService <<@Service>> { + -- + <<create>> AuthenticationService(UserDetailsManager userDetailsManager) + List<String> verifyLogin(String username) + int logout(String username) + int forgotPassword(ForgotPasswordRequest forgotPasswordRequest) + .. via JdbcUserDetailsManager .. + int resetPassword(String username, RequestWithPassword requestWithPassword) + int registerUser(UserDetails user) + int changePassword(String username, ChangePasswordRequest changePasswordRequest) + int deleteUser(String username, RequestWithPassword requestWithPassword) + } + + class JavaMailSenderImpl {} + note left + Aus org.springframework.mail.javamail. + Implementierung des JavaMailSender Interfaces, + welches das MailSender Interface durch Unterstützung + von MIME Nachrichten erweitert. + Das MailSender Interface definiert dabei eine + Strategie zum Versenden einfacher Mails. + Unterstützt sowohl JavaMail MimeMessages und + Spring SimpleMailMessages. + end note + } + + package authenticationController <<Frame>> { + class AuthenticationController <<@Controller>> { + <<create>> AuthenticationController(AuthenticationService authenticationService) + ResponseEntity<List<String>> verifyLogin(String username) + ResponseEntity<Integer> logout(String username) + ResponseEntity<Integer> forgotPassword(ForgotPasswordRequest forgotPasswordRequest) + ResponseEntity<Integer> resetPassword(String username, RequestWithPassword requestWithPassword) + ResponseEntity<Integer> registerUser(UserDetails user) + ResponseEntity<Integer> changePassword(String username, ChangePasswordRequest changePasswordRequest) + ResponseEntity<Integer> deleteUser(String username, RequestWithPassword requestWithPassword) + } + + class ChangePasswordRequest { + <<create>> ChangePasswordRequest(String oldPassword, String newPassword) + String getOldPassword() + String getNewPassword() + } + + class ForgotPasswordRequest { + <<create>> ForgotPasswordRequest(String email) + String getEmail() + } + + class RequestWithPassword { + <<create>> ResetPasswordRequest(String password) + String getPassword() + } + } +} + +' User <.. AuthenticationDataAccessService: DB +' User <.. JdbcUserDetailsManager: DB +UserDetailsManager <.. AuthenticationService: <<use>> +' AuthenticationDao <.. AuthenticationService: <<use>> +AuthenticationService --o AuthenticationController +' AuthenticationDao <|. AuthenticationDataAccessService: <<realize>> +UserDetailsManager <|. JdbcUserDetailsManager: <<realize>> +JavaMailSenderImpl <. AuthenticationService: <<use>> + +@enduml + diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram-episode-actions.puml b/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram-episode-actions.puml new file mode 100644 index 0000000..7a4530e --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram-episode-actions.puml @@ -0,0 +1,84 @@ +@startuml + +package episodeActionsAPI <<Frame>> { + package episodeActionDataAccessLayer <<Frame>> { + class EpisodeActionDataAccessService <<@Repository>> { + <<create>> EpisodeActionDataAccessService (JpaTemplate jpaTemplate) + long addEpisodeActions(String username, List<EpisodeActionPost> episodeActionPosts) + List<EpisodeActionPost> getEpisodeActions(String username) + List<EpisodeActionPost> getEpisodeActionsOfPodcast(String username, String podcastURL) + List<EpisodeActionPost> getEpisodeActionsSince(String username, LocalDateTime since) + List<EpisodeActionPost> getEpisodeActionsOfPodcastSince(String username, String podcastURL, LocalDateTime since) + } + + interface EpisodeActionDao { + long addEpisodeActions(String username, List<EpisodeActionPost> episodeActionPosts) + List<EpisodeActionPost> getEpisodeActions(String username) + List<EpisodeActionPost> getEpisodeActionsOfPodcast(String username, String podcastURL) + List<EpisodeActionPost> getEpisodeActionsSince(String username, LocalDateTime since) + List<EpisodeActionPost> getEpisodeActionsOfPodcastSince(String username, String podcastURL, LocalDateTime since) + } + } + + package episodeActionService <<Frame>> { + class EpisodeActionService <<@Service>> { + <<create>> EpisodeActionService (EpisodeActionDao episodeActionDao) + LocalDateTime addEpisodeActions(String username, List<EpisodeActionPosts> episodeActionPosts) + List<EpisodeActionPost> getEpisodeActions(String username) + List<EpisodeActionPost> getEpisodeActionsOfPodcast(String username, String podcastURL) + List<EpisodeActionPost> getEpisodeActionsSince(String username, LocalDateTime since) + List<EpisodeActionPost> getEpisodeActionsOfPodcastSince(String username, String podcastURL, LocalDateTime since) + } + } + + package episodeActionController <<Frame>> { + class EpisodeActionController <<@Controller>>{ + <<create>> EpisodeActionController (EpisodeActionService episodeActionService) + ResponseEntity<EpisodeActionPostResponse> addEpisodeActions(String username, EpisodeActionPostRequest episodeActionPostRequest) + ResponseEntity<EpisodeActionGetResponse> getEpisodeActions(String username, String deviceID, boolean aggregated) + ResponseEntity<EpisodeActionGetResponse> getEpisodeActionsOfPodcast(String username, String podcastURL, String deviceID, boolean aggregated) + ResponseEntity<EpisodeActionGetResponse> getEpisodeActionsSince(String username, String deviceID, long since, boolean aggregated) + ResponseEntity<EpisodeActionGetResponse> getEpisodeActionsOfPodcastSince(String username, String podcastURL, String deviceID, long since, boolean aggregated) + } + + class EpisodeActionPostResponse { + <<create>> EpisodeActionPostResponse(List<Pair<String, String>> updateURLs) + long getTimestamp() + List<Pair<String, String>> getUpdatedURLs() + } + + class EpisodeActionPost { + <<create>> EpisodeActionPost(String podcastURL, String episodeURL, Action action, LocalDateTime timestamp, int started, int position) + String getPodcastURL() + String getEpisodeURL() + int getGUID() + Action getAction() + LocalDateTime getTimestamp() + int getStarted() + int getPosition() + EpisodeAction getEpisodeAction() + } + + class EpisodeActionPostRequest { + <<create>> EpisodeActionPostRequest(List<EpisodeActionPost> episodeActionPosts) + List<EpisodeActionPost> getEpisodeActionPosts() + } + + class EpisodeActionGetResponse { + <<create>> EpisodeActionGetResponse(List<EpisodeActionPost> episodeActionPosts) + List<EpisodeActionPost> getEpisodeActionPosts() + long getTimestamp() + } + } +} + +EpisodeActionPost -o EpisodeActionGetResponse +EpisodeActionPost -o EpisodeActionPostRequest +' EpisodeAction <.. EpisodeActionDataAccessService: DB +' Episode <.. EpisodeActionDataAccessService: DB +EpisodeActionDao <.. EpisodeActionService: <<use>> +EpisodeActionService --o EpisodeActionController +EpisodeActionDao <|. EpisodeActionDataAccessService: <<realize>> + +@enduml + diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram-model.puml b/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram-model.puml new file mode 100644 index 0000000..72ad49f --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram-model.puml @@ -0,0 +1,109 @@ +@startuml + +package model <<Frame>> { + class Subscription { + <<create>> Subscription(String url, String title) + int getID() + String getURL() + long getLastActionTimestamp() + String getTitle() + } + + class SubscriptionAction { + <<create>> SubscriptionAction(int userID, int subscriptionID) + int getID() + int getUserID() + int getSubscriptionID() + long getTimestamp() + boolean getAdded() + } + + class Episode { + <<create>> Episode(int subscriptionID, int id, String url, String title, String thumbnailURL, int total) + int getSubscriptionID() + int getID() + int getGUID() + String getURL() + String getTitle() + int getTotal() + } + + enum Action { + Download + Play + Delete + New + Flattr + String getJsonProperty() + } + + class EpisodeAction { + <<create>> EpisodeAction(Action action, LocalDateTime timestamp, int started, int position) + int getEpisodeID() + Action getAction() + long getTimestamp() + int getStarted() + int getPosition() + void setEpisodeID() + EpisodeActionPost getEpisodeActionPost(String podcastURL, String episodeURL) + } + + interface UserDetails { + String getUsername() + String getPassword() + Collection<Authority> getAuthorities() + boolean isAccountExpired() + boolean isAccountLocked() + boolean isCredentialsNonExpired() + boolean isEnabled() + } + note left + Aus org.springframework.security.core.userdetails. + Wird für die Schnittstelle UserDetailsManager benötigt. + Stellt wichtige Informationen eines Users bereit. + Diese werden nur indirekt von Spring Security + benutzt, indem sie vorher in Authentication Objekten + gekapselt werden. + end note + + class User { + -- + <<create>> User(String username, String password) + int getID() + String getSessionToken() + boolean getEmailIsValidated() + .. interface methods .. + String getUsername() + String getPassword() + Collection<Authority> getAuthorities() + boolean isAccountExpired() + boolean isAccountLocked() + boolean isCredentialsNonExpired() + boolean isEnabled() + } + + interface GrantedAuthority { + String getAuthority() + } + note right + Aus org.springframework.security.core. + Wird für die Schnittstelle UserDetails benötigt. + Repräsentiert eine Autorisierung, die einem + Authentication Objekt gewährt wird. + end note + + class Authority { + <<create>> Authority() + String getAuthority() + } +} + +Subscription <. SubscriptionAction: ID +Action <-- EpisodeAction +EpisodeAction .> Episode: ID +UserDetails <|.. User: <<realize>> +User -> Authority +GrantedAuthority <|.. Authority: <<realize>> + +@enduml + diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram-subscriptions.puml b/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram-subscriptions.puml new file mode 100644 index 0000000..432f185 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram-subscriptions.puml @@ -0,0 +1,75 @@ +@startuml + +package subscriptionsAPI <<Frame>> { + package subscriptionDataAccessLayer <<Frame>> { + class SubscriptionDataAccessService <<@Repository>> { + <<create>> SubscriptionDataAccessService(JpaTemplate jpaTemplate) + int uploadSubscriptions(String username, List<SubscriptionAction> subscriptions) + List<String> getSubscriptions(String username) + List<String> getSubscriptionsSince(String username, LocalDateTime time) + int addSubscriptions(String username, List<SubscriptionAction> addedSubscriptions) + int removeSubscriptions(String username, List<SubscriptionAction> removedSubscriptions) + List<SubscriptionTitles> getTitles(String username) + } + + interface SubscriptionDao { + int uploadSubscriptions(String username, List<SubscriptionAction> subscriptions) + List<String> getSubscriptions(String username) + List<String> getSubscriptionsSince(String username, LocalDateTime time) + int addSubscriptions(String username, List<SubscriptionAction> addedSubscriptions) + int removeSubscriptions(String username, List<SubscriptionAction> removedSubscriptions) + List<SubscriptionTitles> getTitles(String username) + } + } + + package subscriptionService <<Frame>> { + class SubscriptionService <<@Service>> { + <<create>> SubscriptionService(SubscriptionDao subscriptionDao) + int uploadSubscriptions(String username, List<SubscriptionAction> subscriptions) + List<String> getSubscriptions(String username) + List<String> getSubscriptionsSince(String username, LocalDateTime time) + int addSubscriptions(String username, List<SubscriptionAction> addedSubscriptions) + int removeSubscriptions(String username, List<SubscriptionAction> removedSubscriptions) + List<SubscriptionTitles> getTitles(String username) + } + } + + package subscriptionController <<Frame>> { + class SubscriptionController <<@Controller>>{ + ' @Autowired + <<create>> SubscriptionController(SubscriptionService subscriptionService) + ' @GetMapping + ResponseEntity<List<String>> getSubscriptions(String username, String deviceID, String functionJSONP) + ' @PutMapping + ResponseEntity<String> uploadSubscriptions(String username, String deviceID, List<String> subscriptions) + ' @PostMapping + ResponseEntity<SubscriptionDelta> applySubscriptionDelta(String username, String deviceID, SubscriptionDelta delta) + ' @GetMapping + ResponseEntity<SubscriptionDelta> getSubscriptionDelta(String username, String deviceID, long since) + ResponseEntity<List<SubscriptionTitles>> getTitles(String username, String deviceID) + } + + class SubscriptionTitles { + <<create>> SubscriptionTitles(Subscription subscription, List<EpisodeActionPost> episodeTitles) + Subscription getSubscription() + List<EpisodeActionPost> getEpisodesTitles() + } + + class SubscriptionDelta { + <<create>> SubscriptionDelta(List<String> add, List<String> remove) + List<String> getRemove() + LocalDate getTimestamp() + List<List<String>> getUpdate_urls() + } + } + +} + +' Subscription <.. SubscriptionDataAccessService: DB +' SubscriptionAction <.. SubscriptionDataAccessService: DB +SubscriptionService --o SubscriptionController +SubscriptionDao <.. SubscriptionService: <<use>> +SubscriptionDao <|. SubscriptionDataAccessService: <<realize>> + +@enduml + diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram-util.puml b/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram-util.puml new file mode 100644 index 0000000..03dfc9a --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram-util.puml @@ -0,0 +1,43 @@ +@startuml + +package util <<Frame>> { + class RSSParser { + <<create>> RSSParser(String subscriptionURL) + String getSubscriptionTitle() + List<Episode> getEpisodes() + Episode getEpisodeForURL(String episodeURL) + } + note bottom + Verwendet intern Spring um + HTTP-Anfragen zu erstellen. + end note + + class CleanCronJob { + <<create>> CleanCronJob(JdbcUserDetailsManager jdbcUserDetailsManager) + void cleanInvalidUsers() + } + note bottom + Hintergrundservice, der in periodischen Abständen + Nutzer, die ihre E-Mail-Adresse nicht nach 24 Stunden + bestätigt haben, wieder aus der Datenbank löscht. + (Auf die Assoziation zu JdbcUserDetailsManager wird + im Sinne der Übersichtlichkeit verzichtet.) + end note + + class ResponseEntity<T> { + <<create>> ResponseEntity(T body, HttpStatusCode status) + T getBody() + HttpStatusCode getStatusCode() + } + note bottom + Aus org.springframework.http. + Erweitert die Klasse HttpEntity, welche + ein HTTP Anfrage- oder Antwort-Objekt + repräsentiert, durch einen HttpStatusCode. + Wird von den Controller-Methoden als + Rückgabewert verwendet. + end note +} + +@enduml + diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram.puml b/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram.puml new file mode 100644 index 0000000..f833aa2 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/classdiagram.puml @@ -0,0 +1,68 @@ +@startuml +' skinparam linetype ortho +' skinparam groupInheritance 2 +allowmixing + +!include classdiagram-authentication.puml +!include classdiagram-episode-actions.puml +!include classdiagram-model.puml +!include classdiagram-subscriptions.puml +!include classdiagram-util.puml + +class SecurityConfigurationBasicAuth { + <<create>> SecurityConfigurationBasicAuth() + PasswordEncoder encoder() + UserDetailsManager userDetailsService() + SecuryFilterChain fiterChain(HTTPSecurity http) throws Excpetion +} +note top + Erstellt einen Servlet Filter (springSecurityFilterChain) + der für die gesamte Sicherheit zuständig ist (Schutz der URLs, + Validierung von Anmeldedaten, Weiterleitung zur Anmeldung, etc.). +end note + +class PSEApplication { + <<create>> PSEApplication() + void main(String[] args) +} + +database Datenbank +Datenbank <-[hidden]d- subscriptionsAPI +Datenbank <-[hidden]d- episodeActionsAPI +Datenbank <-[hidden]d- authenticationAPI +() SQL as SQLSub +() SQL as SQLAuth +() SQL as SQLEpisode + +Datenbank -- SQLSub +Datenbank -- SQLAuth +Datenbank -- SQLEpisode + +Subscription --o SubscriptionTitles +EpisodeActionPost -o SubscriptionTitles +UserDetailsManager <.. SecurityConfigurationBasicAuth: <<use>> + +SubscriptionController ..o PSEApplication +AuthenticationController ..o PSEApplication +EpisodeActionController ..o PSEApplication +SecurityConfigurationBasicAuth ..o PSEApplication + +PSEApplication --() HTTP + +SQLSub )-- SubscriptionDataAccessService: JPA +' SQLAuth )-- AuthenticationDataAccessService: JPA +SQLAuth )-- JdbcUserDetailsManager: JDBC +SQLEpisode )-- EpisodeActionDataAccessService: JPA + +RSSParser <. SubscriptionDataAccessService: <<use>> +RSSParser <. EpisodeActionDataAccessService: <<use>> +' JdbcUserDetailsManager <-- CleanCronJob + +model .o Datenbank: ORM (User, SubscriptionAction, Subscription, EpisodeAction, Episode) +' Datenbank o.. Subscription: ORM +' Datenbank o.. SubscriptionAction: ORM +' Datenbank o.. Episode: ORM +' Datenbank o.. EpisodeAction: ORM +' Datenbank o.. User: ORM + +@enduml diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/componentdiagram.puml b/11-entwurfsheft-kolloquium/assets/diagrams/componentdiagram.puml new file mode 100644 index 0000000..dea4a1d --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/componentdiagram.puml @@ -0,0 +1,53 @@ +@startuml + +[App] as app +[VueRouter] as router +[NavbarComponent] as navbar +[LoginPage] as login_page +[SubscriptionsPage] as abo_page +[EpisodesPage] as episodes_page +[SettingsPage] as settings_page +[ForgotPasswordPage] as forgot_page +[ResetPasswordPage] as reset_page +note top + Wird in der E-Mail zum Zurücksetzen des Passworts mit dem JWT-Token verlinkt. + Sendet das alte und neue Passwort und den JWT an die API. +end note +[RegistrationPage] as registration_page + +[SubscriptionComponent] as sub +[EpisodeComponent] as episode +[LastUpdateComponent] as last_update +[PasswordValidatorComponent] as password + +app --> router + +app --> navbar +router --> login_page +router --> forgot_page +router --> reset_page +router --> registration_page +router --> abo_page +router --> episodes_page +router --> settings_page + +navbar -[hidden] router + +episodes_page -[hidden] abo_page +login_page -[hidden] forgot_page +registration_page -[hidden] reset_page +abo_page -[hidden] settings_page +forgot_page -[hidden] episodes_page +' forgot_page -[hidden] settings_page + +abo_page --> sub +episodes_page --> episode + +sub --> last_update +episode --> last_update + +settings_page --> password +reset_page --> password +registration_page --> password + +@enduml diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/db.puml b/11-entwurfsheft-kolloquium/assets/diagrams/db.puml new file mode 100644 index 0000000..bdefaea --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/db.puml @@ -0,0 +1,78 @@ +@startuml +' Type Symbol +' Zero or One |o-- +' Exactly One ||-- +' Zero or Many }o-- +' One or Many }|-- + +skinparam linetype ortho + +entity User { + * int id <<unique>> + * <u>String email</u> + * String password + * boolean verified + * long created_at +} + +entity SubscriptionAction { + * int id <<unique>> + * <u>int user_id</u> + * long timestamp + * int subscription_id + * boolean added +} + +entity Subscription { + * int id <<unique>> + * <u>String url</u> + * long timestamp + * String title +} + +entity Episode { + * int id <<unique>> + * <u>int guid <<unique>></u> + * <u>String url</u> + * String title + * int total + * int subscription_id +} +note right + Wenn der Client eine GUID aus dem Feed mitsendet, wird + diese statt der URL verwendet um die Episode zu finden. + So wird die Episode auch noch gefunden, nachdem sich + die URL geändert hat. +end note +note bottom of Episode + Wenn für die Episoden-URL einer EpisodeAction noch keine Episode in der Datenbank steht, + dann schreibe dafür ein Dummy-Objekt in Datenbank und lade asynchron die Episoden der Subscription. + Ersetze dann die Dummy-Objekte durch die Episoden und setze den Timestamp der Subscription auf + die aktuelle Zeit. + Um DoS-Angriffe auf den Backend-Server abzuwenden, können die Episoden einer Subscription erst + nach einer Stunde erneut gefetched werden. Bis dahin werden für EpisodeActions, die sich auf noch + nicht geladene Episoden beziehen, nur Dummy-Objekte für die Episoden in die Datenbank geschrieben. + Es sei noch darauf hingewiesen, dass diese Dummy-Episoden bei Anfragen nicht mit ausgegeben werden. +end note + +entity EpisodeAction { + * int id <<unique>> + * <u>int user_id</u> + * int episode_id + * long timestamp + * int action + * int started + * int position +} +note right + Speichere für jede Episode + nur letzte Play-Action. +endnote + +User ||--o{ EpisodeAction +User ||--o{ SubscriptionAction +SubscriptionAction }|--|| Subscription +EpisodeAction }|--|| Episode +Subscription ||-right-|{ Episode + +@enduml diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/deployment.puml b/11-entwurfsheft-kolloquium/assets/diagrams/deployment.puml new file mode 100644 index 0000000..26918e2 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/deployment.puml @@ -0,0 +1,59 @@ +@startuml
+
+node "<<device>> \nBackend Server" as backendServer{
+ database " <<database system>> \n MariaDB Server 10.6" as database {
+ rectangle rectangle1 [
+ <<schema>>
+ User
+ ]
+ rectangle rectangle2 [
+ <<schema>>
+ SubscriptionAction
+ ]
+ rectangle rectangle3 [
+ <<schema>>
+ EpisodeAction
+ ]
+ rectangle rectangle4 [
+ <<schema>>
+ Subscription
+ ]
+ rectangle rectangle5 [
+ <<schema>>
+ Episode
+ ]
+ }
+
+ node "<<framework>> \nJava Spring" as javaSpring{
+ node " <<device>> \n Tomcat Webserver"
+ }
+}
+
+node "<<device>> \nFrontend" as frontendServer {
+
+}
+
+node "<<device>> \nEndgerät" as terminal {
+ node "<<application>> \nBrowser" as browser
+ node "<<application>> \nPodcatcher" as podcatcher
+}
+
+backendServer "1" - "*" podcatcher
+
+node "<<device>> \nFrontend Server" as frontendServer{
+ node "<<framework>> \nVue.js" as vuejs {
+
+ }
+}
+
+podcatcher -[hidden] browser
+
+backendServer - "1" frontendServer
+
+database "1" -- "1" javaSpring
+
+browser "*" -- frontendServer
+
+
+
+@enduml
diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-forgotAndResetPW.puml b/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-forgotAndResetPW.puml new file mode 100644 index 0000000..603130c --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-forgotAndResetPW.puml @@ -0,0 +1,41 @@ +@startuml + +skinparam ParticipantPadding 30 + +participant AuthenticationController << (C, #ADD1B2) @Controller >> +-> AuthenticationController: ""POST /api/2/auth/forgot.json"" \n//@RequestBody ForgotPasswordRequest forgotPasswordRequest// \n\n-> forgotPassword(//forgotPasswordRequest//) +activate AuthenticationController +participant AuthenticationService << (C, #ADD1B2) @Service >> +AuthenticationController -> AuthenticationService: forgotPassword(//forgotPasswordRequest//) +activate AuthenticationService +participant JavaMailSenderImpl << (C, #ADD1B2) >> +AuthenticationService -> JavaMailSenderImpl: create link to reset password with JWT as URL parameter \n-> send(SimpleMailMessage simpleMessage) with link +activate JavaMailSenderImpl +<<- JavaMailSenderImpl: sends email with link containing a JWT to reset password +JavaMailSenderImpl --> AuthenticationService +deactivate JavaMailSenderImpl +AuthenticationService --> AuthenticationController: int indicating status +deactivate AuthenticationService +<-- AuthenticationController: ResponseEntity<Integer> indicating status \n\n-> ""HTTP status code"" +deactivate AuthenticationController +||60|| +-> AuthenticationController: ""PUT /api/2/auth/{username}/resetpassword.json"" \n//@RequestParam String jwt// \n//@RequestBody ResetPasswordRequest resetPasswordRequest// \n\n-> login user (""username"") via JWT (//jwt//) \n-> resetPassword(""username"", //resetPasswordRequest//) +activate AuthenticationController +AuthenticationController -> AuthenticationService: resetPassword(""username"", //resetPasswordRequest//) +activate AuthenticationService +participant JdbcUserDetailsManager << (C, #ADD1B2) @Repository >> +AuthenticationService -> JdbcUserDetailsManager: String oldPassword = //resetPasswordRequest//.getOldPassword() \nString newPassword = //resetPasswordRequest//.getNewPassword() \n-> changePassword(newPassword, oldPassword) +activate JdbcUserDetailsManager +database Database +JdbcUserDetailsManager -> Database: change password of logged in user +activate Database +Database --> JdbcUserDetailsManager +deactivate Database +JdbcUserDetailsManager --> AuthenticationService: int indicating status +deactivate JdbcUserDetailsManager +AuthenticationService --> AuthenticationController: int indicating status +deactivate AuthenticationService +<-- AuthenticationController: ResponseEntity<Integer> indicating status \n\n-> ""HTTP status code"" +deactivate AuthenticationController + +@enduml
\ No newline at end of file diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-getEpisodeActions.puml b/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-getEpisodeActions.puml new file mode 100644 index 0000000..47497d5 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-getEpisodeActions.puml @@ -0,0 +1,38 @@ +@startuml + +' title =**Get All Episode Actions** + +participant EpisodeActionController << (C, #ADD1B2) @Controller >> +-> EpisodeActionController: ""GET /api/2/episodes/{username}.json"" \n//@RequestParam("device") String deviceID// \n//@RequestParam("aggregated") boolean aggregated// \n\n-> getEpisodeActions(""username"", //deviceID//, //aggregated//) +note right + Die Parameter //deviceID// und //aggregated// werden ignoriert, + da nicht zwischen Geräten unterschieden und für jede + Episode sowieso nur die letzte Play-Action gespeichert + wird. Dies gilt für alle GET-Anfragen der Episode Actions API. +end note +activate EpisodeActionController +participant EpisodeActionService << (C, #ADD1B2) @Service >> +EpisodeActionController -> EpisodeActionService: getEpisodeActions(""username"") +activate EpisodeActionService +participant EpisodeActionDataAccessService << (C, #ADD1B2) @Repository >> +EpisodeActionService -> EpisodeActionDataAccessService: getEpisodeActions(""username"") +activate EpisodeActionDataAccessService +EpisodeActionDataAccessService -> EpisodeActionDataAccessService: getEpisodeActionsSince(""username"", \nLocalDateTime.MIN.toEpochSecond(ZoneOffset.UTC)) +database Database +activate EpisodeActionDataAccessService +EpisodeActionDataAccessService -> Database: get all EpisodeActions for all subscribed podcasts +activate Database +Database --> EpisodeActionDataAccessService: List<EpisodeAction> selectedEpisodeActions \n-> then remove all older than LocalDateTime.MIN (none) +EpisodeActionDataAccessService -> Database: join EpisodeActions in selectedEpisodeActions with episodeURL of Episode +Database --> EpisodeActionDataAccessService +deactivate Database +EpisodeActionDataAccessService --> EpisodeActionDataAccessService: List<EpisodeActionPost> episodeActionPosts +deactivate EpisodeActionDataAccessService +EpisodeActionDataAccessService --> EpisodeActionService: List<EpisodeActionPost> episodeActionPosts +deactivate EpisodeActionDataAccessService +EpisodeActionService --> EpisodeActionController: List<EpisodeActionPost> episodeActionPosts +deactivate EpisodeActionService +<-- EpisodeActionController: ResponseEntity<EpisodeActionGetResponse> response \n\n-> ""HTTP status code"" \n-> ""JSON"" +deactivate EpisodeActionController + +@enduml
\ No newline at end of file diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-getEpisodeActionsOfPodcastSince.puml b/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-getEpisodeActionsOfPodcastSince.puml new file mode 100644 index 0000000..d8797d1 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-getEpisodeActionsOfPodcastSince.puml @@ -0,0 +1,32 @@ +@startuml + +' title =**Get Episode Actions of Podcast Since** + +participant EpisodeActionController << (C, #ADD1B2) @Controller >> +-> EpisodeActionController: ""GET /api/2/episodes/{username}.json"" \n//@RequestParam("podcast") String podcastURL// \n//@RequestParam("device") String deviceID// \n//@RequestParam("since") long since// \n//@RequestParam("aggregated") boolean aggregated// \n\n-> getEpisodeActionsOfPodcastSince(""username"", //podcastURL//, //deviceID//, //since//, //aggregated//) +note right + Die Parameter //deviceID// und //aggregated// werden ignoriert. + Siehe Notiz in Sequenzdiagramm **Get All Episode Actions**. +end note +activate EpisodeActionController +participant EpisodeActionService << (C, #ADD1B2) @Service >> +EpisodeActionController -> EpisodeActionService: getEpisodeActionsOfPodcastSince(""username"", //podcastURL//, //since//) +activate EpisodeActionService +participant EpisodeActionDataAccessService << (C, #ADD1B2) @Repository >> +EpisodeActionService -> EpisodeActionDataAccessService: getEpisodeActionsOfPodcastSince(""username"", //podcastURL//, //since//) +activate EpisodeActionDataAccessService +database Database +EpisodeActionDataAccessService -> Database: get all EpisodeActions the given podcast (//podcastURL//) +activate Database +Database --> EpisodeActionDataAccessService: List<EpisodeAction> selectedEpisodeActions \n-> then remove all older than //since// +EpisodeActionDataAccessService -> Database: join EpisodeActions in selectedEpisodeActions with episodeURL of Episode +Database --> EpisodeActionDataAccessService +deactivate Database +EpisodeActionDataAccessService --> EpisodeActionService: List<EpisodeActionPost> episodeActionPosts +deactivate EpisodeActionDataAccessService +EpisodeActionService --> EpisodeActionController: List<EpisodeActionPost> episodeActionPosts +deactivate EpisodeActionService +<-- EpisodeActionController: ResponseEntity<EpisodeActionGetResponse> response \n\n-> ""HTTP status code"" \n-> ""JSON"" +deactivate EpisodeActionController + +@enduml
\ No newline at end of file diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-getSubscriptions.puml b/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-getSubscriptions.puml new file mode 100644 index 0000000..6e6895f --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-getSubscriptions.puml @@ -0,0 +1,36 @@ +@startuml + +' title =**Get All Subscriptions** + +participant SubscriptionController << (C, #ADD1B2) @Controller >> +-> SubscriptionController: ""GET /subscriptions/{username}.json"" \n"" /subscriptions/{username}/{deviceid}.json"" \n//@RequestParam("jsonp") String functionJSONP// \n\n-> getSubscriptions(""username"", ""deviceid"", //functionJSONP//) +activate SubscriptionController +note right + Die Parameter ""deviceid"" und + //functionJSONP// werden ignoriert, + da nicht zwischen Geräten unterschieden + und JSONP nicht unterstützt wird. +end note +participant SubscriptionService << (C, #ADD1B2) @Service >> +SubscriptionController -> SubscriptionService: getSubscriptions(""username"") +activate SubscriptionService +participant SubscriptionDataAccessService << (C, #ADD1B2) @Repository >> +SubscriptionService -> SubscriptionDataAccessService: getSubscriptions(""username"") +activate SubscriptionDataAccessService +SubscriptionDataAccessService -> SubscriptionDataAccessService: getSubscriptionsSince(""username"", LocalDateTime.MIN) +database Database +activate SubscriptionDataAccessService +SubscriptionDataAccessService -> Database: get all Podcasts from Subscriptions for ""username"" +activate Database +Database --> SubscriptionDataAccessService: List<Podcast> subscribedPodcasts +deactivate Database +SubscriptionDataAccessService --> SubscriptionDataAccessService: List<String> podcastURLs +deactivate SubscriptionDataAccessService +SubscriptionDataAccessService --> SubscriptionService: List<String> podcastURLs +deactivate SubscriptionDataAccessService +SubscriptionService --> SubscriptionController: List<String> podcastURLs +deactivate SubscriptionService +<-- SubscriptionController: ResponseEntity<List<String>> podcastURLs \n \n-> ""HTTP status code"" \n-> ""JSON"" +deactivate SubscriptionController + +@enduml
\ No newline at end of file diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-register.puml b/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-register.puml new file mode 100644 index 0000000..b7b7aa1 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-register.puml @@ -0,0 +1,26 @@ +@startuml + +' title =**Register** + +participant AuthenticationController << (C, #ADD1B2) @Controller >> +-> AuthenticationController: ""POST /api/2/auth/register.json"" \n//@RequestBody UserDetails user// \n\n-> registerUser(//user//) +activate AuthenticationController +participant AuthenticationService << (C, #ADD1B2) @Service >> +AuthenticationController -> AuthenticationService: registerUser(//user//) +activate AuthenticationService +participant JdbcUserDetailsManager << (C, #ADD1B2) @Repository >> +AuthenticationService -> JdbcUserDetailsManager: createUser(//user//) +activate JdbcUserDetailsManager +database Database +JdbcUserDetailsManager -> Database: create new User with given UserDetails (//user//) +activate Database +Database --> JdbcUserDetailsManager +deactivate Database +JdbcUserDetailsManager --> AuthenticationService: int indicating status +deactivate JdbcUserDetailsManager +AuthenticationService --> AuthenticationController: int indicating status +deactivate AuthenticationService +<-- AuthenticationController: ResponseEntity<Integer> indicating status \n\n-> ""HTTP status code"" +deactivate AuthenticationController + +@enduml
\ No newline at end of file diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-uploadEpisodeActions.puml b/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-uploadEpisodeActions.puml new file mode 100644 index 0000000..d3dac57 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-uploadEpisodeActions.puml @@ -0,0 +1,38 @@ +@startuml + +' title =**Upload Episode Actions** + +participant EpisodeActionController << (C, #ADD1B2) @Controller >> +-> EpisodeActionController: ""POST /api/2/episodes/{username}.json"" \n//@RequestBody EpisodeActionPostRequest episodeActionPostRequest// \n\n-> addEpisodeActions(""username"", //episodeActionPostRequest//) +activate EpisodeActionController +participant EpisodeActionService << (C, #ADD1B2) @Service >> +EpisodeActionController -> EpisodeActionService: addEpisodeActions(""username"", \nepisodeActionPosts = //episodeActionPostRequest//.getEpisodeActionPosts()) +activate EpisodeActionService +participant EpisodeActionDataAccessService << (C, #ADD1B2) @Repository >> +EpisodeActionService -> EpisodeActionDataAccessService: addEpisodeActions(""username"", episodeActionPosts) +database Database +activate EpisodeActionDataAccessService +loop for each EpisodeActionPost in episodeActionPosts -> episodeAction = episodeActionPost.getEpisodeAction() +opt episodeAction.getAction().equals(Action.PLAY) +EpisodeActionDataAccessService -> Database: set episodeID field of episodeAction for this ""username"" via podcastURL and episodeURL +activate Database +Database --> EpisodeActionDataAccessService +EpisodeActionDataAccessService -> Database: get last EpisodeAction with this episodeID if present +Database --> EpisodeActionDataAccessService: Optional<EpisodeAction> lastEpisodeAction +opt lastEpisodeAction.isPresent() +EpisodeActionDataAccessService -> Database: replace lastEpisodeAction with episodeAction +else else +EpisodeActionDataAccessService -> Database: add episodeAction to DB as new entry +end +Database --> EpisodeActionDataAccessService +deactivate Database +end +end +EpisodeActionDataAccessService --> EpisodeActionService: long latestTimestamp +deactivate EpisodeActionDataAccessService +EpisodeActionService --> EpisodeActionController: LocalDateTime timestamp = LocalDateTime.ofEpochSecond(latestTimestamp, 0, ZoneOffset.UTC) +deactivate EpisodeActionService +<-- EpisodeActionController: ResponseEntity<EpisodeActionPostResponse> \n(with empty list for updateURLs) \n\n-> ""HTTP status code"" \n-> ""JSON"" +deactivate EpisodeActionController + +@enduml
\ No newline at end of file diff --git a/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-uploadSubscriptions.puml b/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-uploadSubscriptions.puml new file mode 100644 index 0000000..1edc8cf --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/diagrams/sequencediagram-uploadSubscriptions.puml @@ -0,0 +1,32 @@ +@startuml + +' title =**Upload Subscriptions** + +participant SubscriptionController << (C, #ADD1B2) @Controller >> +-> SubscriptionController: ""PUT /subscriptions/{username}/{deviceid}.json"" \n//@RequestBody List<String> subscriptions// \n\n-> uploadSubscriptions(""username"", ""deviceid"", //subscriptions//) +activate SubscriptionController +participant SubscriptionService << (C, #ADD1B2) @Service >> +SubscriptionController -> SubscriptionService: uploadSubscriptions(""username"", //subscriptions//) +activate SubscriptionService +participant SubscriptionDataAccessService << (C, #ADD1B2) @Repository >> +SubscriptionService -> SubscriptionDataAccessService: uploadSubscriptions(""username"", //subscriptions//) +activate SubscriptionDataAccessService +database Database +SubscriptionDataAccessService -> Database: delete all subsciptions of ""username"" +activate Database +Database --> SubscriptionDataAccessService +SubscriptionDataAccessService -> SubscriptionDataAccessService: addSubscriptions(""username"", //subscriptions//) +activate SubscriptionDataAccessService +SubscriptionDataAccessService -> Database: upload all subscriptions (//subscriptions//) for ""username"" +Database --> SubscriptionDataAccessService +deactivate Database +SubscriptionDataAccessService --> SubscriptionDataAccessService: int indicating status +deactivate SubscriptionDataAccessService +SubscriptionDataAccessService --> SubscriptionService: int indicating status +deactivate SubscriptionDataAccessService +SubscriptionService --> SubscriptionController: int indicating status +deactivate SubscriptionService +<-- SubscriptionController: ResponseEntity<String> with empty String for success \n\n-> ""HTTP status code"" \n-> ""JSON"" +deactivate SubscriptionController + +@enduml
\ No newline at end of file diff --git a/11-entwurfsheft-kolloquium/assets/episode.png b/11-entwurfsheft-kolloquium/assets/episode.png Binary files differnew file mode 100644 index 0000000..c0db4a2 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/episode.png diff --git a/11-entwurfsheft-kolloquium/assets/help.png b/11-entwurfsheft-kolloquium/assets/help.png Binary files differnew file mode 100644 index 0000000..39a1b84 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/help.png diff --git a/11-entwurfsheft-kolloquium/assets/lastupdate.png b/11-entwurfsheft-kolloquium/assets/lastupdate.png Binary files differnew file mode 100644 index 0000000..e9b7f5c --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/lastupdate.png diff --git a/11-entwurfsheft-kolloquium/assets/logo.pdf b/11-entwurfsheft-kolloquium/assets/logo.pdf Binary files differnew file mode 100644 index 0000000..91fd334 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/logo.pdf diff --git a/11-entwurfsheft-kolloquium/assets/logo.svg b/11-entwurfsheft-kolloquium/assets/logo.svg new file mode 100644 index 0000000..1609066 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/logo.svg @@ -0,0 +1,211 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg + version="1.2" + width="87.589989mm" + height="52.16547mm" + viewBox="0 0 8758.9989 5216.547" + preserveAspectRatio="xMidYMid" + fill-rule="evenodd" + stroke-width="28.222" + stroke-linejoin="round" + xml:space="preserve" + id="svg206" + xmlns="http://www.w3.org/2000/svg" + xmlns:svg="http://www.w3.org/2000/svg"> + <defs + class="ClipPathGroup" + id="defs8" /> + <defs + id="defs51"><font + id="EmbeddedFont_1" + horiz-adv-x="2048" + horiz-origin-x="0" + horiz-origin-y="0" + vert-origin-x="512" + vert-origin-y="768" + vert-adv-y="1024"> + <font-face + font-family="Noto Sans Display Light embedded" + units-per-em="2048" + font-weight="normal" + font-style="normal" + ascent="2170" + descent="609" + id="font-face10" /> + <missing-glyph + horiz-adv-x="2048" + d="M 0,0 L 2047,0 2047,2047 0,2047 0,0 Z" + id="missing-glyph12" /> + <glyph + unicode="y" + horiz-adv-x="927" + d="M 2,1089 L 127,1089 367,413 C 388,352 407,298 422,250 437,203 449,161 457,124 L 463,124 C 471,156 483,196 498,246 513,296 530,350 551,409 L 786,1089 913,1089 453,-193 C 418,-290 377,-364 328,-416 279,-468 213,-494 131,-494 107,-494 84,-493 63,-490 43,-487 25,-482 8,-476 L 8,-377 C 23,-383 40,-387 57,-391 75,-394 95,-396 117,-396 170,-396 214,-378 249,-342 284,-307 314,-252 340,-179 L 403,4 2,1089 Z" + id="glyph14" /> + <glyph + unicode="t" + horiz-adv-x="610" + d="M 465,80 C 494,80 521,82 547,87 573,91 595,97 614,105 L 614,11 C 594,3 569,-5 541,-11 512,-17 481,-20 449,-20 363,-20 296,5 249,56 202,106 178,189 178,304 L 178,996 27,996 27,1061 178,1100 219,1350 295,1350 295,1090 608,1090 608,996 295,996 295,310 C 295,157 352,80 465,80 Z" + id="glyph16" /> + <glyph + unicode="s" + horiz-adv-x="742" + d="M 817,289 C 817,191 782,115 713,61 643,7 545,-20 418,-20 347,-20 284,-14 228,-1 173,12 126,29 88,50 L 88,162 C 134,138 186,118 244,102 301,86 360,78 420,78 520,78 592,96 636,133 680,169 702,218 702,281 702,341 679,387 632,419 585,451 515,484 422,519 359,542 303,565 255,589 207,613 169,643 142,680 116,717 102,768 102,832 102,919 136,987 204,1037 271,1086 361,1110 473,1110 535,1110 592,1104 646,1092 700,1080 750,1063 795,1043 L 754,946 C 713,964 667,980 617,993 568,1006 518,1012 469,1012 388,1012 326,997 283,967 239,937 217,893 217,836 217,792 228,758 249,733 270,707 301,686 342,668 383,650 433,630 492,609 553,585 608,562 657,537 707,512 745,481 774,443 803,405 817,353 817,289 Z" + id="glyph18" /> + <glyph + unicode="r" + horiz-adv-x="583" + d="M 596,1108 C 646,1108 692,1102 733,1091 L 717,983 C 674,995 632,1001 590,1001 497,1001 423,964 368,890 312,817 285,719 285,598 L 285,-1 168,-1 168,1089 266,1089 279,886 285,886 C 311,948 350,1000 402,1043 455,1086 520,1108 596,1108 Z" + id="glyph20" /> + <glyph + unicode="o" + horiz-adv-x="927" + d="M 1030,547 C 1030,433 1012,333 976,248 940,164 887,98 818,51 749,4 665,-20 565,-20 471,-20 390,3 322,50 253,96 201,162 164,247 127,333 109,433 109,547 109,723 150,861 232,961 315,1061 429,1110 575,1110 672,1110 755,1087 822,1040 890,993 941,927 977,842 1012,757 1030,659 1030,547 Z M 229,547 C 229,407 257,294 312,208 368,123 453,80 567,80 685,80 771,123 826,209 882,295 909,408 909,547 909,637 898,717 875,787 851,856 815,911 766,951 717,990 653,1010 573,1010 459,1010 373,969 315,887 258,805 229,692 229,547 Z" + id="glyph22" /> + <glyph + unicode="n" + horiz-adv-x="847" + d="M 633,1110 C 749,1110 838,1078 900,1014 962,950 993,850 993,713 L 993,1 877,1 877,705 C 877,809 854,885 810,935 766,985 701,1010 616,1010 395,1010 285,871 285,594 L 285,1 168,1 168,1090 262,1090 279,901 287,901 C 314,962 357,1011 416,1051 474,1091 547,1110 633,1110 Z" + id="glyph24" /> + <glyph + unicode="m" + horiz-adv-x="1430" + d="M 1245,1110 C 1348,1110 1427,1080 1485,1018 1542,957 1571,860 1571,727 L 1571,1 1454,1 1454,723 C 1454,820 1434,892 1393,939 1352,986 1296,1010 1227,1010 1130,1010 1056,980 1005,919 953,858 928,764 928,637 L 928,1 811,1 811,723 C 811,820 791,892 750,939 709,986 653,1010 584,1010 487,1010 413,978 361,914 310,850 285,751 285,619 L 285,1 168,1 168,1090 262,1090 279,918 287,918 C 313,971 352,1016 403,1054 455,1092 521,1110 600,1110 675,1110 739,1093 791,1059 842,1025 879,975 899,908 L 907,908 C 936,972 980,1022 1038,1057 1097,1093 1166,1110 1245,1110 Z" + id="glyph26" /> + <glyph + unicode="i" + horiz-adv-x="187" + d="M 227,1493 C 279,1493 305,1464 305,1405 305,1345 279,1315 227,1315 175,1315 150,1345 150,1405 150,1464 175,1493 227,1493 Z M 285,1090 L 285,0 168,0 168,1090 285,1090 Z" + id="glyph28" /> + <glyph + unicode="h" + horiz-adv-x="847" + d="M 285,1059 C 285,1031 284,1003 283,977 281,951 279,926 276,901 L 285,901 C 312,962 355,1011 413,1051 471,1091 543,1110 629,1110 746,1110 836,1078 899,1014 962,950 993,850 993,713 L 993,1 877,1 877,705 C 877,809 854,885 810,935 766,985 701,1010 616,1010 395,1010 285,871 285,594 L 285,1 168,1 168,1557 285,1557 285,1059 Z" + id="glyph30" /> + <glyph + unicode="f" + horiz-adv-x="689" + d="M 575,995 L 332,995 332,-1 213,-1 213,995 27,995 27,1058 213,1093 213,1202 C 213,1445 316,1566 522,1566 559,1566 593,1563 623,1557 653,1551 680,1544 705,1536 L 678,1439 C 655,1448 630,1454 603,1460 577,1465 550,1468 524,1468 456,1468 407,1447 377,1405 347,1362 332,1295 332,1202 L 332,1089 575,1089 575,995 Z" + id="glyph32" /> + <glyph + unicode="e" + horiz-adv-x="874" + d="M 559,1110 C 646,1110 720,1089 779,1046 839,1003 883,944 913,869 943,794 958,708 958,611 L 958,531 229,531 C 231,386 262,275 325,198 387,121 476,82 592,82 656,82 712,88 759,100 806,111 858,130 915,156 L 915,50 C 865,25 814,7 764,-4 713,-15 655,-20 588,-20 434,-20 315,30 232,129 150,229 109,365 109,537 109,648 126,746 162,832 197,918 249,986 315,1036 382,1085 464,1110 559,1110 Z M 559,1012 C 465,1012 389,979 333,912 276,845 243,750 233,627 L 838,627 C 838,742 815,835 769,906 723,977 653,1012 559,1012 Z" + id="glyph34" /> + <glyph + unicode="d" + horiz-adv-x="900" + d="M 535,-20 C 398,-20 293,27 219,120 145,214 109,352 109,535 109,722 147,865 224,963 301,1061 408,1110 545,1110 629,1110 698,1090 752,1050 805,1010 845,961 872,904 L 881,904 C 879,935 878,970 876,1009 873,1048 872,1084 872,1117 L 872,1557 989,1557 989,0 895,0 879,191 872,191 C 845,132 805,82 751,41 697,0 625,-20 535,-20 Z M 553,80 C 669,80 752,119 801,195 850,271 875,382 875,527 L 875,545 C 875,695 850,810 801,890 752,970 671,1010 559,1010 451,1010 369,969 313,886 257,804 229,686 229,533 229,385 256,273 309,196 363,119 444,80 553,80 Z" + id="glyph36" /> + <glyph + unicode="c" + horiz-adv-x="768" + d="M 580,-20 C 429,-20 313,29 231,127 150,226 109,363 109,539 109,662 129,766 170,850 211,935 269,1000 343,1044 417,1088 504,1110 602,1110 651,1110 698,1106 742,1096 787,1087 825,1074 858,1057 L 825,957 C 791,972 754,984 714,993 673,1002 636,1006 600,1006 481,1006 390,964 326,881 261,798 229,685 229,541 229,405 258,294 314,210 371,126 459,84 580,84 630,84 678,90 723,101 768,112 809,125 846,142 L 846,37 C 812,20 773,6 729,-5 685,-15 636,-20 580,-20 Z" + id="glyph38" /> + <glyph + unicode="a" + horiz-adv-x="822" + d="M 535,1108 C 651,1108 737,1078 795,1018 852,958 881,863 881,734 L 881,0 793,0 772,185 766,185 C 729,123 684,74 631,36 578,-1 503,-20 408,-20 311,-20 233,6 176,59 119,111 90,187 90,285 90,394 132,477 215,533 298,589 420,621 580,629 L 764,639 764,715 C 764,822 744,897 705,942 665,987 606,1010 528,1010 477,1010 426,1002 378,987 329,972 281,953 231,928 L 195,1022 C 242,1047 295,1067 352,1084 410,1100 470,1108 535,1108 Z M 594,543 C 466,536 370,512 307,470 244,429 213,367 213,285 213,217 232,165 271,131 310,96 363,78 430,78 535,78 617,111 676,176 735,240 764,330 764,445 L 764,551 594,543 Z" + id="glyph40" /> + <glyph + unicode="S" + horiz-adv-x="875" + d="M 956,381 C 956,294 936,220 894,160 852,100 796,55 724,25 652,-5 571,-20 479,-20 396,-20 324,-14 262,-2 201,11 147,26 102,46 L 102,162 C 152,142 209,124 273,109 338,94 409,87 485,87 589,87 673,110 738,158 803,206 836,278 836,373 836,431 823,478 798,515 772,553 734,586 682,614 630,642 565,670 485,699 410,726 345,757 291,791 236,825 194,868 164,919 134,970 119,1035 119,1112 119,1192 138,1259 176,1314 214,1369 267,1411 333,1440 399,1469 474,1483 559,1483 626,1483 689,1476 750,1463 810,1449 868,1430 924,1405 L 883,1303 C 772,1352 663,1377 555,1377 462,1377 386,1354 328,1310 269,1266 240,1200 240,1114 240,1052 252,1001 278,964 303,926 340,895 389,869 438,843 498,817 567,791 648,762 717,731 775,698 833,664 878,623 909,573 941,523 956,459 956,381 Z" + id="glyph42" /> + <glyph + unicode="P" + horiz-adv-x="848" + d="M 539,1462 C 869,1462 1034,1325 1034,1049 1034,908 992,798 907,718 823,638 690,598 510,598 L 311,598 311,0 193,0 193,1462 539,1462 Z M 528,1358 L 311,1358 311,702 498,702 C 629,702 730,727 803,776 875,825 911,914 911,1043 911,1152 880,1232 818,1282 756,1333 659,1358 528,1358 Z" + id="glyph44" /> + <glyph + unicode="E" + horiz-adv-x="769" + d="M 950,0 L 193,0 193,1462 950,1462 950,1356 311,1356 311,821 913,821 913,715 311,715 311,107 950,107 950,0 Z" + id="glyph46" /> + <glyph + unicode=" " + horiz-adv-x="503" + id="glyph48" /> + </font></defs> + <defs + class="TextShapeIndex" + id="defs55" /> + <defs + class="EmbeddedBulletChars" + id="defs87" /> + + <g + id="id10" + clip-path="none" + transform="translate(-700.00001,-2550)"> + + <text + class="SVGTextShape" + id="text151" + x="217.60002" + y="-56.506969" + style="letter-spacing:4.7625px;word-spacing:104.775px"><tspan + class="TextParagraph" + font-family="'Noto Sans Display Light', sans-serif" + font-size="494px" + font-weight="400" + id="tspan149"><tspan + class="TextPosition" + x="650.59998" + y="7647.4932" + id="tspan147"><tspan + fill="#808080" + stroke="none" + style="white-space:pre" + id="tspan145" + dx="2.1199999">Podcast Synchronisation made Efficient</tspan></tspan></tspan></text> + </g><g + id="g1277" + transform="translate(-700.00001,-2550)"><path + id="path131-3" + d="m 6694.0006,4763 c -559.5515,4.407 -980.3924,428.0893 -986.038,985.9863 18.2894,552.8957 454.3127,974.1166 989.0352,986.0379 v -235.0244 c -406.8751,-27.3888 -715.1078,-362.1649 -719.0259,-748.0163 12.7874,-421.0793 236.9242,-746.3999 750.0318,-749.98 895.0688,1.4728 1915.5158,0 2730.9957,0 V 4763 Z" + style="fill:#0084d1;fill-opacity:1" + clip-path="none" /><path + id="path131" + d="m 6685.0183,2562.996 c -559.5515,4.407 -980.3924,428.0893 -986.038,985.9863 18.2894,552.8957 454.3127,974.1167 989.0352,986.038 v -235.0244 c -406.8751,-27.3888 -715.1078,-362.165 -719.0259,-748.0164 12.7874,-421.0792 236.9242,-746.3998 750.0318,-749.98 895.0688,1.4728 1915.5158,0 2730.996,0 V 2562.996 Z" + style="fill:#0084d1;fill-opacity:1" + clip-path="none" /></g><g + id="g1263" + transform="translate(-700.00001,-2550)"><path + fill="none" + stroke="#069a2e" + stroke-width="265" + stroke-linejoin="round" + d="m 2793,5962 c 1283,0 429,-2762 1712,-2762" + id="path124" /><path + id="path110-6" + d="M 3198.0212,6550 V 6300.0411 H 2448.0411 V 6050.0305 5550.0094 H 2198.0305 V 6300.0411 6550 H 2448.0411 2698 Z" + style="fill:#069a2e;fill-opacity:1" /><path + id="path110" + d="m 4111.997,2550.0252 v 249.9589 h 749.9801 v 250.0106 500.0211 h 250.0106 v -750.0317 -249.9589 h -250.0106 -249.9589 z" + style="fill:#069a2e;fill-opacity:1" /></g> + <g + id="g1249" + transform="translate(-700.00001,-2550)"><path + fill="#ff8000" + stroke="none" + d="M 2215,4164 C 2412.6918,3832.6035 2379.3124,3383.7591 2135.4189,3084.8193 1956.8564,2857.4026 1671.3097,2718.8851 1382,2721 c 0,-52.6667 0,-105.3333 0,-158 -60.1303,-1.0792 190.6585,-1.2724 121.9814,2.7933 434.6311,30.3756 832.6257,336.7309 974.9655,748.2365 148.7336,402.6249 41.0263,883.7477 -266.0719,1183.8452 C 1996.6852,4716.1853 1689.0048,4838.6187 1382,4830 c 0,-61.6667 0,-123.3333 0,-185 338.199,2.9253 666.226,-186.816 833,-481 z" + id="path193" /><path + fill="#ff8000" + stroke="none" + d="m 1936,3979 c 175.8129,-283.3241 59.7943,-700.6319 -239.8255,-849.407 -94.2713,-50.9942 -201.887,-77.9344 -309.1745,-74.593 0,-57 0,-114 0,-171 396.3865,-24.0968 777.5367,297.6517 818.5878,693.1841 44.0348,337.5467 -149.4277,694.9971 -466.4953,826.9493 -110.1027,49.0687 -231.5272,73.543 -352.0925,67.8666 0,-61.6667 0,-123.3333 0,-185 220.6353,7.5804 440.8554,-115.3286 549,-308 z" + id="path186" /><path + fill="#ff8000" + stroke="none" + d="m 1659,3822 c 86.3933,-138.0398 18.2474,-344.669 -134.6962,-402.3205 C 1483.44,3402.2177 1438.3524,3394.2432 1394,3398 c 0,-56.6667 0,-113.3333 0,-170 223.1964,-19.6143 444.7886,153.3254 478.4886,375.1817 32.646,181.6951 -54.6854,381.4331 -217.3127,472.2205 -78.2316,46.131 -170.3991,69.3119 -261.1759,62.5978 0,-58.3333 0,-116.6667 0,-175 105.6736,9.5509 212.8962,-49.2218 265,-141 z" + id="path179" /><rect + class="BoundingBox" + stroke="none" + fill="none" + x="700" + y="2550" + width="501" + height="4001" + id="rect136" + style="fill:#ff8000;fill-opacity:1" /></g> + +</svg> diff --git a/11-entwurfsheft-kolloquium/assets/navbar.png b/11-entwurfsheft-kolloquium/assets/navbar.png Binary files differnew file mode 100644 index 0000000..dd9f8e8 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/navbar.png diff --git a/11-entwurfsheft-kolloquium/assets/password-margin.png b/11-entwurfsheft-kolloquium/assets/password-margin.png Binary files differnew file mode 100644 index 0000000..d9d4fa3 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/password-margin.png diff --git a/11-entwurfsheft-kolloquium/assets/password.png b/11-entwurfsheft-kolloquium/assets/password.png Binary files differnew file mode 100644 index 0000000..68248a0 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/password.png diff --git a/11-entwurfsheft-kolloquium/assets/subscription.png b/11-entwurfsheft-kolloquium/assets/subscription.png Binary files differnew file mode 100644 index 0000000..58a84f9 --- /dev/null +++ b/11-entwurfsheft-kolloquium/assets/subscription.png diff --git a/11-entwurfsheft-kolloquium/logos/banner_2020_kit.jpg b/11-entwurfsheft-kolloquium/logos/banner_2020_kit.jpg Binary files differnew file mode 100644 index 0000000..70ae1d0 --- /dev/null +++ b/11-entwurfsheft-kolloquium/logos/banner_2020_kit.jpg diff --git a/11-entwurfsheft-kolloquium/notizen b/11-entwurfsheft-kolloquium/notizen new file mode 100644 index 0000000..70ac63b --- /dev/null +++ b/11-entwurfsheft-kolloquium/notizen @@ -0,0 +1,40 @@ +Titelseite: +- Begrüßung + +Einführung: +- Podcast: RSS-Feed, Episoden, Audio/Video +- Podcatcher: lokale Verwaltung von Podcasts, API Unterstützung, +Abspielen von Episoden +- Synchronisationsserver (das soll unser Produkt werden): Hörfortschritte, +Abonnements, Discovery (bei AntennaPod z.B. iTunes) + +Zielsetzung: + +Synchronisation (die Art, die wir bei uns anwenden): +- alle Aktionen werden auf den Server und infolge dessen auf alle Podcatcher +übertragen + +Features: +- Synchronisation: Abos, Hörfortschritt +- Weboberfläche: Aboliste, Zuletzt gehört +- Account-Verwaltung: Registrieren, Anmelden, Passwort ändern/zurücksetzen, +Account löschen, Daten importieren/exportieren + +UI-Journey: +- login.html: + - Sprache ändern + - OAuth (kann) + - Registrieren (muss): neues Fenster, E-Mail + 2-mal Passwort (sicher?), + vergeben? -> Fehler / Bestätigungslink per E-Mail (gültig 24h) + - Anmelden (muss): E-Mail + Passwort eingeben, Login merken, + login, Fehlermeldung oder Dashboard + - Passwort vergessen: neues Fenster, E-Mail eingeben, falls Account wird + Link versendet, 24h gültig, nach betätigen PW zweimal eingeben & bestätigen + (Anforderungen) + +- podcasts.html: Abonnements, Eisoden, Hörfortschritte + +- listening.html: Zuletzt gehörte Episoden, Hörfortschritt, Wann gehört + +- settings.html: PW ändern, Gpodder Import, pers. Daten imp./exp., + Account löschen diff --git a/11-entwurfsheft-kolloquium/presentation.tex b/11-entwurfsheft-kolloquium/presentation.tex new file mode 100644 index 0000000..ca05873 --- /dev/null +++ b/11-entwurfsheft-kolloquium/presentation.tex @@ -0,0 +1,52 @@ +%% Beispiel-Präsentation mit LaTeX Beamer im KIT-Design +%% entsprechend den Gestaltungsrichtlinien vom 1. August 2020 +%% +%% Siehe https://sdqweb.ipd.kit.edu/wiki/Dokumentvorlagen + +%% Beispiel-Präsentation +\documentclass[xcolor={dvipsnames}]{sdqbeamer} +\usepackage{multicol} +\usepackage{fontawesome5} +\usepackage{rest-api} +\usepackage{graphicx} +\usepackage{ulem} +\usepackage[dvipsnames]{xcolor} + + +%% Titelbild +\titleimage{banner_2020_kit} + +%% Gruppenlogo +\grouplogo{kitlogo_de_rgb} + +%% Gruppenname und Breite (Standard: 50 mm) +\groupname{Praxis der Softwareentwicklung} +%\groupnamewidth{50mm} + +\title[Kolloquium Pflichtenheft]{ + PSE\textsuperscript{2} - Podcast Synchronisation made Efficient +} +\subtitle{Kolloquium Entwurfsheft} +\author[Immanuel Reitz]{Immanuel Reitz} + +\date[17.\,01.\,2023]{17. Januar 2023} + +\begin{document} + +\KITtitleframe + +\include{slides/apiExtension} + +\include{slides/architecture} + +\include{slides/pattern} + +\include{slides/classdiagram} + +\include{slides/sequence} + +\include{slides/frontend} + +\include{slides/changes} +%comment +\end{document} diff --git a/11-entwurfsheft-kolloquium/presentation.tex.orig b/11-entwurfsheft-kolloquium/presentation.tex.orig new file mode 100644 index 0000000..8dd6019 --- /dev/null +++ b/11-entwurfsheft-kolloquium/presentation.tex.orig @@ -0,0 +1,68 @@ +%% Beispiel-Präsentation mit LaTeX Beamer im KIT-Design +%% entsprechend den Gestaltungsrichtlinien vom 1. August 2020 +%% +%% Siehe https://sdqweb.ipd.kit.edu/wiki/Dokumentvorlagen + +%% Beispiel-Präsentation +\documentclass{sdqbeamer} + +\usepackage{tikz} +\usetikzlibrary{positioning} +\usetikzlibrary{calc} +\usetikzlibrary{arrows} +\usepackage{multicol} +\usepackage{fontawesome5} +\usepackage{tikz} +\usepackage{tikz-uml} +\usepackage{rest-api} +\usetikzlibrary{positioning, arrows, chains} +\usetikzlibrary[calc] + + +%% Titelbild +\titleimage{banner_2020_kit} + +%% Gruppenlogo +\grouplogo{kitlogo_de_rgb} + +%% Gruppenname und Breite (Standard: 50 mm) +\groupname{Praxis der Softwareentwicklung} +%\groupnamewidth{50mm} + +\title[Kolloquium Pflichtenheft]{ + PSE\textsuperscript{2} - Podcast Synchronisation made Efficient +} +\subtitle{Kolloquium Entwurfsheft} +\author[Immanuel Reitz]{Immanuel Reitz} + +\date[17.\,01.\,2023]{17. Januar 2023} + +\begin{document} + +\KITtitleframe + +\include{slides/apiExtension} +% Folie Einführung +\include{slides/einführung} + +% Folie Zielsetzung +\include{slides/zielsetzung} + +\include{slides/architektur} + +\include{slides/classdiagram} + +\include{slides/abläufe} + +<<<<<<< HEAD +% TODO: Folie Features +\include{slides/features} + +\include{slides/frontend} + +% TODO: User-Journey +======= +\include{slides/pattern} +>>>>>>> main + +\end{document} diff --git a/11-entwurfsheft-kolloquium/sdqbeamer.cls b/11-entwurfsheft-kolloquium/sdqbeamer.cls new file mode 100644 index 0000000..1b9c2b8 --- /dev/null +++ b/11-entwurfsheft-kolloquium/sdqbeamer.cls @@ -0,0 +1,975 @@ +%% Vorlage für Präsentationen mit LaTeX Beamer im KIT-Design +%% entsprechend den Gestaltungsrichtlinien vom 1. August 2020 +%% +%% Siehe https://sdqweb.ipd.kit.edu/wiki/Dokumentvorlagen + + +\NeedsTeXFormat{LaTeX2e} +\ProvidesClass{sdqbeamer}[2022-05-03 v3.1.3 SDQ Beamer class] + +\RequirePackage[utf8]{inputenc} +\RequirePackage[T1]{fontenc} + +\newif\ifsectionnavigation +\newif\ifnavbarinfoot +\newif\ifnavbarinline +\newif\ifnavbarside +\newif\iffourtothree +\newif\ifsixteentonine +\newif\ifsixteentoten +\newif\ifgerman +\newif\ifsmallfooterfont + +\def\kitslogan#1{\def\@kitslogan{#1}} +\def\kitlogo#1{\def\@kitlogo{#1}} +\def\groupname#1{\def\@groupname{#1}} +\def\groupnamewidth#1{\def\@groupnamewidth{#1}} + +% siehe README.md +\DeclareOption{de}{ + \kitslogan{KIT -- Die Forschungsuniversität in der Helmholtz-Gemeinschaft} + \kitlogo{pse_logo} + \germantrue + \PassOptionsToPackage{autostyle}{csquotes} + } +\DeclareOption{en}{ + \kitslogan{KIT -- The Research University in the Helmholtz Association} + \kitlogo{kitlogo_en_rgb} + \germanfalse + } +\DeclareOption{4:3}{ + \fourtothreetrue + \sixteentoninefalse + \sixteentotenfalse +} +\DeclareOption{16:9}{ + \fourtothreefalse + \sixteentoninetrue + \sixteentotenfalse +} +\DeclareOption{16:10}{ + \fourtothreefalse + \sixteentoninefalse + \sixteentotentrue +} +\DeclareOption{navbarside}{ + \sectionnavigationtrue + \navbarsidetrue + \navbarinlinefalse + \navbarinfootfalse +} +\DeclareOption{navbarinline}{ + \sectionnavigationtrue + \navbarsidefalse + \navbarinlinetrue + \navbarinfootfalse +} +\DeclareOption{navbarinfooter}{ + \sectionnavigationtrue + \navbarsidefalse + \navbarinlinefalse + \navbarinfoottrue +} +\DeclareOption{navbaroff}{ + \sectionnavigationfalse +} +\DeclareOption{navbarkit}{ + \sectionnavigationfalse + \smallfooterfonttrue +} +\DeclareOption{smallfoot}{ + \smallfooterfonttrue +} +\DeclareOption{bigfoot}{ + \smallfooterfontfalse +} + +\ExecuteOptions{de,16:9,navbarinline,bigfoot} + +\DeclareOption*{\PassOptionsToClass{\CurrentOption}{beamer}} + +\ProcessOptions\relax + +\LoadClass[10pt,utf8]{beamer} + +% Babel-Paket wird nur bei deutscher Sprache benötigt +\ifgerman + \RequirePackage[ngerman]{babel} +\fi +\RequirePackage{csquotes} +\RequirePackage{hyperref} +\RequirePackage[absolute,overlay]{textpos} + +%% --------------- +%% | Typographie | +%% --------------- + +\RequirePackage{microtype} + +\RequirePackage[scaled=.92]{helvet} +\RequirePackage[scaled=.78]{beramono} +\RequirePackage{libertineRoman} + +\setbeamerfont{title}{series=\bfseries,size=\Large} +\setbeamerfont{frametitle}{series=\bfseries,size=\Large} +\setbeamerfont{framesubtitle}{series=\bfseries,size=\normalsize} + +%% ----------------- +%% | Folien-Layout | +%% ----------------- + +% Seitenverhältnis +% +% Die Folien sind auf die Standardhöhe in LaTeX Beamer (9,6 cm) normiert. +% Die Maße der KIT-Gestaltungsrichtlinien (Folienhöhe 14,3 cm) wurden durch +% den Quotienten 1,5 geteilt. + +\RequirePackage{geometry} +\iffourtothree + \geometry{papersize={12.8cm,9.6cm}} +\fi +\ifsixteentoten + \geometry{papersize={15.36cm,9.6cm}} +\fi +\ifsixteentonine + \geometry{papersize={17.07cm,9.6cm}} +\fi + +% Ränder laut Gestaltungsrichtlinen; 3 mm -> 2 mm, 11 mm -> 7,3 mm +\newlength{\kitoutermargin} +\setlength{\kitoutermargin}{2mm} +\newlength{\kitinnermargin} +\setlength{\kitinnermargin}{7.3mm} +\newlength{\kitbottommargin} +\setlength{\kitbottommargin}{\kitinnermargin} + +% Ränder außen +\setbeamersize{text margin left=\kitinnermargin,text margin right=\kitinnermargin} + +% keine Navigationssymbole +\setbeamertemplate{navigation symbols}{} +\setbeamercovered{invisible} +\useinnertheme{rounded} +\beamer@compresstrue % Miniframes (Navigations-Punkte) für Subsections immer in einer Zeile, ohne Umbrüche + +% Folientitel +\setbeamertemplate{frametitle}{ + \ifbeamer@plainframe\else% + % Unterkante Titeltext: 22,5 mm -> 15 mm von Seitenkopf + \begin{textblock*}{\dimexpr\paperwidth-30mm-2\kitinnermargin}[0,1](\kitinnermargin,15mm)% + \usebeamerfont{frametitle}\insertframetitle% + \ifx\insertframesubtitle\@empty\else\\[.1em]\fi + \usebeamerfont{framesubtitle}\insertframesubtitle% + \end{textblock*}% + \begin{textblock*}{20mm}[1,1](\dimexpr\paperwidth-\kitinnermargin\relax,15mm)%j + \includegraphics[width=20mm]{logos/\@kitlogo}% + \end{textblock*}% + \fi +% Rand oben (ergibt Beginn des Textes bei 34 mm -> 22,7 mm) + \vspace {18mm} +} + +%% Fußzeile +\newlength{\kitbottom} + % Navbar in Footer: Schmale Fußzeile +\ifnavbarinfoot + % Bei Navbar in Footer immer kleiner Font in der Fußzeile + \setbeamerfont{footer}{size=\fontsize{6pt}{7.2pt}\selectfont} + \setlength{\kitbottom}{4mm} +\else + % Ansonsten kleiner Text nur, wenn "smallfoot" gewählt + \ifsmallfooterfont + \setbeamerfont{footer}{size=\fontsize{6pt}{7.2pt}\selectfont} + \else + \setbeamerfont{footer}{size=\scriptsize} + \fi + \setlength{\kitbottom}{\kitbottommargin} +\fi +\setbeamerfont{page number in head/foot}{series=\bfseries} + +\newlength{\kitbottomdepth} +\newlength{\kitbottomheight} +\newlength{\kitfootergroupwidth} + +\setbeamertemplate{footline}{% +\setlength{\kitbottomdepth}{\dimexpr.5\kitbottom-.5em\relax}% +\setlength{\kitbottomheight}{\dimexpr.5\kitbottom+.5em\relax}% + %% die "%" am Ende sind nötig, damit keine Abstände eingefügt werden + % + % Falls kein Gruppenname angegeben, die ganze Breite der Fußzeile für den Titel nutzen. + \ifdefined\@groupname% + \ifx\@groupname\empty% + \setlength{\kitfootergroupwidth}{0mm}% + \else% + % Falls die Breite des Gruppenlogos definiert ist, diese nehmen, sonst 50 mm + \ifdefined\@groupnamewidth% + \setlength{\kitfootergroupwidth}{\@groupnamewidth}% + \else% + \setlength{\kitfootergroupwidth}{50mm}% + \fi% + \fi% + \else + \setlength{\kitfootergroupwidth}{0mm}% + \fi + \usebeamerfont{footer}% + \ifsectionnavigation% + % Option "navbarinline" + \ifnavbarinline% + \begin{beamercolorbox}[wd=\paperwidth, leftskip=2mm, rightskip=2mm]{} + \insertnavigation{\dimexpr\paperwidth-4mm\relax} + \vspace{1mm} + \end{beamercolorbox}% + \fi% + % Option "navbarinfooter" + \ifnavbarinfoot% + % Punkte für Subsections deaktivieren + \setbeamertemplate{mini frames}{}% + \begin{beamercolorbox}[wd=\paperwidth, leftskip=1mm, rightskip=1mm]{}% + \insertsectionnavigationhorizontal{\dimexpr\paperwidth-\kitoutermargin\relax}{}{} + \end{beamercolorbox}% + \fi% + \fi% + \leavevmode% + \begin{beamercolorbox}[wd=13mm, ht=\kitbottomheight, dp=\kitbottomdepth, leftskip=4mm]{} + \usebeamerfont{page number in head/foot}% + \strut\insertframenumber{}/\inserttotalframenumber% + \end{beamercolorbox}% + \begin{beamercolorbox}[wd=20mm, ht=\kitbottomheight, dp=\kitbottomdepth]{} + \usebeamerfont{date in head/foot}% + \strut\insertshortdate% + \end{beamercolorbox}% + % Die Boxen mit dem Titel und dem Gruppennamen sind vertikal zentriert, damit auch zweizeilige Texte schön aussehen + % Daher müssen sie um \kitbottomdepth nach unten verschoben werden + \raisebox{-\kitbottomdepth}{ + % Die Box hat daher auch Höhe \kitbottom und Tiefe 0mm + \begin{beamercolorbox}[wd=\dimexpr\paperwidth-37mm-\kitfootergroupwidth, ht=\kitbottom, dp=0mm]{}% + % Inhalt vertikal zentrieren; Anpassung um 1.5 pt, damit bei einzeiligem Inhalt genau die Baseline der Blöcke mit Seitenzahl und Datum getroffen wird + \vbox to\kitbottom{\vfill\vskip1.5pt% + \beamer@shortauthor\ifx\beamer@shortauthor\empty\else: \fi\beamer@shorttitle% + \vfill}% + \end{beamercolorbox}% + \ifdefined\@groupname% + \begin{beamercolorbox}[wd=\kitfootergroupwidth, ht=\kitbottom, dp=0mm, rightskip=\kitinnermargin]{} + \vbox to\kitbottom{\vfill\vskip1.5pt% + \raggedleft\@groupname% + \vfill}% + \end{beamercolorbox}% + \fi% + }% +} + +%% Option "navbarside" +\ifnavbarside +\useoutertheme[height=0cm,width=3.5cm,left]{sidebar} + +\setbeamerfont{title in sidebar}{family=\sffamily,series=\mdseries,size={\fontsize{10pt}{11pt}}} +\setbeamerfont{section in sidebar}{family=\sffamily,series=\mdseries,size={\fontsize{9pt}{9.9pt}}} +\setbeamerfont{subsection in sidebar}{family=\sffamily,series=\mdseries,size={\fontsize{8pt}{8.8pt}}} + +\setbeamertemplate{sidebar \beamer@sidebarside} + {\vskip1.5cm% + \hskip6.5mm% + \advance\beamer@sidebarwidth by -5mm% + \insertverticalnavigation{\beamer@sidebarwidth}% + }% +\fi + +%% Hintergrund +\usebackgroundtemplate{ + % Trennlinie nicht bei "plain"-Frames + \ifbeamer@plainframe\else\kitseparationline\fi +} + +% Trennlinie +\newcommand{\kitseparationline}{ + \begin{pgfpicture}{0mm}{0mm}{\paperwidth}{\paperheight} + \pgfsetstrokecolor{black!15} + \pgfsetlinewidth{.5pt} + \pgfpathmoveto{\pgfpoint{\kitoutermargin}{\kitinnermargin}} + \pgfpathlineto{\pgfpoint{\paperwidth-\kitoutermargin}{\kitinnermargin}} + \pgfusepath{stroke} + \end{pgfpicture}% +} + + +%% -------------- +%% | Titelseite | +%% -------------- + +\def\titleimage#1{\def\@titleimage{#1}} +\def\grouplogo#1{\def\@grouplogo{#1}} + +\newcommand{\KITtitleframe}{ + \begin{frame}[plain] + \titlepage + \end{frame} +} + +\newlength{\kittitleimageheight} +\setbeamertemplate{title page}{ + % From textpos documentation (https://ctan.org/pkg/textpos) + % + % \begin{textblock}{<hsize>}[<ho>,<vo>](<hpos>,<vpos>) + % The coordinates <ho> and <vo> are fractions of the width and height of the text + % box, respectively, and state that the box is to be placed so that the reference point + % (<ho>,<vo>) within the box is to be placed at the point (<hpos>,<vpos>) on the page. + + % KIT-Logo + \begin{textblock*}{30mm}(\kitinnermargin,6.7mm) + \includegraphics[width=30mm]{logos/\@kitlogo} + \end{textblock*} + + % Gruppenlogo + \ifdefined\@grouplogo + \ifx\@grouplogo\empty \else + \begin{textblock*}{20mm}(\dimexpr\paperwidth-24mm\relax,6.7mm) + \includegraphics[width=20mm,height=20mm,keepaspectratio]{logos/\@grouplogo} + \end{textblock*} + \fi % falls \grouplogo{} aufgerufen wird, kein Gruppenlogo einbinden + \else + \begin{textblock*}{20mm}(\dimexpr\paperwidth-24mm\relax,6.7mm) + \colorbox{kit-purple100!20}{\parbox[t][12mm][c]{19mm}{\color{kit-purple100}\scriptsize\centering + \ifgerman + Bitte Logo über \texttt{\textbackslash grouplogo\{\}} festlegen. + \else + Please set a logo using \texttt{\textbackslash grouplogo\{\}}. + \fi + }} + \end{textblock*} + \fi + + % Titel + \begin{textblock*}{\dimexpr\paperwidth-8mm\relax}[0,.5](\kitinnermargin,28mm) + \usebeamerfont*{title}\inserttitle + \end{textblock*} + + % Untertitel + \begin{textblock*}{\dimexpr\paperwidth-8mm\relax}(\kitinnermargin,36mm) + \small\textbf{\insertsubtitle} + \end{textblock*} + + % Autor + \begin{textblock*}{\dimexpr\paperwidth-8mm\relax}(\kitinnermargin,41mm) + \small\insertauthor~\textbar~\insertdate + \end{textblock*} + + % Titelbild + \setlength{\kittitleimageheight}{40mm} + \begin{textblock*}{\paperwidth}(\kitoutermargin,\dimexpr\paperheight-\kitbottommargin-\kittitleimageheight) + \begin{pgfpicture}{0mm}{0mm}{\paperwidth}{\kittitleimageheight} + % Clipping-Pfad um titelbild + \pgfsetstrokecolor{black!15} + \pgfsetlinewidth{1pt} + \pgfsetcornersarced{\pgfpoint{3mm}{3mm}} + \pgfpathmoveto{\pgfpoint{\paperwidth-2\kitoutermargin}{0mm}} + \pgfpathlineto{\pgfpoint{\paperwidth-2\kitoutermargin}{\kittitleimageheight}} + \pgfsetcornersarced{\pgfpointorigin} + \pgfpathlineto{\pgfpoint{0mm}{\kittitleimageheight}} + \pgfsetcornersarced{\pgfpoint{3mm}{3mm}} + \pgfpathlineto{\pgfpointorigin} + \pgfsetcornersarced{\pgfpointorigin} + \pgfpathclose + \pgfusepath{stroke,clip} + \pgfsetstrokecolor{black} + + % Titelbild + \ifdefined\@titleimage + \ifx\@titleimage\empty \else% + \pgftext[at=\pgfpoint{.5\paperwidth}{0mm},center,bottom]{% + \includegraphics[height=40mm]{logos/\@titleimage} + } + \fi % Bei Aufruf von \titleimage{} leeren Rahmen anzeigen. + \else + \pgftext[at=\pgfpoint{.5\paperwidth}{.5\kittitleimageheight},center,base]{% + \colorbox{kit-purple100!20}{\parbox[c][\kittitleimageheight][c]{\paperwidth}{\color{kit-purple100}\centering Bitte Titelbild über \texttt{\textbackslash titleimage\{\}} festlegen. + }}% + } + \fi + + + \end{pgfpicture}% + \end{textblock*} + + + % KIT slogan + \begin{textblock*}{80mm}[0,.5](\kitoutermargin,\dimexpr\paperheight-.5\kitbottommargin) + \fontsize{5.5pt}{5.5pt}\selectfont\@kitslogan + \end{textblock*} + + \begin{textblock*}{30mm}[1,.5](\dimexpr\paperwidth-\kitoutermargin\relax,\dimexpr\paperheight-.5\kitbottommargin) + \fontsize{11pt}{11pt}\selectfont\bfseries\raggedleft% + {\href{https://www.kit.edu}{www.kit.edu}} + \end{textblock*} + +} +%% --------------- +%% | /Titelseite | +%% --------------- + +%% ---------- +%% | Farben | +%% ---------- +%% KIT-Farbschema + +% KIT color green : +\definecolor{kit-green}{RGB}{0, 150, 130} +\definecolor{kit-green100}{RGB}{0, 150, 130} +\definecolor{kit-green90}{rgb}{0.1, 0.6294, 0.5588} +\definecolor{kit-green80}{rgb}{0.2, 0.6706, 0.6078} +\definecolor{kit-green75}{rgb}{0.25, 0.6912, 0.6324} +\definecolor{kit-green70}{rgb}{0.3, 0.7118, 0.6569} +\definecolor{kit-green60}{rgb}{0.4, 0.7529, 0.7059} +\definecolor{kit-green50}{rgb}{0.5, 0.7941, 0.7549} +\definecolor{kit-green40}{rgb}{0.6, 0.8353, 0.8039} +\definecolor{kit-green30}{rgb}{0.7, 0.8765, 0.8529} +\definecolor{kit-green25}{rgb}{0.75, 0.8971, 0.8775} +\definecolor{kit-green20}{rgb}{0.8, 0.9176, 0.902} +\definecolor{kit-green15}{rgb}{0.85, 0.9382, 0.9265} +\definecolor{kit-green10}{rgb}{0.9, 0.9588, 0.951} +\definecolor{kit-green5}{rgb}{0.95, 0.9794, 0.9755} + +% KIT color blue: +\definecolor{kit-blue}{RGB}{70, 100, 170} +\definecolor{kit-blue100}{RGB}{70, 100, 170} +\definecolor{kit-blue90}{rgb}{0.3471, 0.4529, 0.7} +\definecolor{kit-blue80}{rgb}{0.4196, 0.5137, 0.7333} +\definecolor{kit-blue75}{rgb}{0.4559, 0.5441, 0.75} +\definecolor{kit-blue70}{rgb}{0.4922, 0.5745, 0.7667} +\definecolor{kit-blue60}{rgb}{0.5647, 0.6353, 0.8} +\definecolor{kit-blue50}{rgb}{0.6373, 0.6961, 0.8333} +\definecolor{kit-blue40}{rgb}{0.7098, 0.7569, 0.8667} +\definecolor{kit-blue30}{rgb}{0.7824, 0.8176, 0.9} +\definecolor{kit-blue25}{rgb}{0.8186, 0.848, 0.9167} +\definecolor{kit-blue20}{rgb}{0.8549, 0.8784, 0.9333} +\definecolor{kit-blue15}{rgb}{0.8912, 0.9088, 0.95} +\definecolor{kit-blue10}{rgb}{0.9275, 0.9392, 0.9667} +\definecolor{kit-blue5}{rgb}{0.9637, 0.9696, 0.9833} + +% KIT color red : +\definecolor{kit-red}{RGB}{162, 34, 35} +\definecolor{kit-red100}{RGB}{162, 34, 35} +\definecolor{kit-red90}{rgb}{0.6718, 0.22, 0.2235} +\definecolor{kit-red80}{rgb}{0.7082, 0.3067, 0.3098} +\definecolor{kit-red75}{rgb}{0.7265, 0.35, 0.3529} +\definecolor{kit-red70}{rgb}{0.7447, 0.3933, 0.3961} +\definecolor{kit-red60}{rgb}{0.7812, 0.48, 0.4824} +\definecolor{kit-red50}{rgb}{0.8176, 0.5667, 0.5686} +\definecolor{kit-red40}{rgb}{0.8541, 0.6533, 0.6549} +\definecolor{kit-red30}{rgb}{0.8906, 0.74, 0.7412} +\definecolor{kit-red25}{rgb}{0.9088, 0.7833, 0.7843} +\definecolor{kit-red20}{rgb}{0.9271, 0.8267, 0.8275} +\definecolor{kit-red15}{rgb}{0.9453, 0.87, 0.8706} +\definecolor{kit-red10}{rgb}{0.9635, 0.9133, 0.9137} +\definecolor{kit-red5}{rgb}{0.9818, 0.9567, 0.9569} + +% KIT color yellow : +\definecolor{kit-yellow}{RGB}{252, 229, 0} +\definecolor{kit-yellow100}{RGB}{252, 229, 0} +\definecolor{kit-yellow90}{rgb}{0.9894, 0.9082, 0.1} +\definecolor{kit-yellow80}{rgb}{0.9906, 0.9184, 0.2} +\definecolor{kit-yellow75}{rgb}{0.9912, 0.9235, 0.25} +\definecolor{kit-yellow70}{rgb}{0.9918, 0.9286, 0.3} +\definecolor{kit-yellow60}{rgb}{0.9929, 0.9388, 0.4} +\definecolor{kit-yellow50}{rgb}{0.9941, 0.949, 0.5} +\definecolor{kit-yellow40}{rgb}{0.9953, 0.9592, 0.6} +\definecolor{kit-yellow30}{rgb}{0.9965, 0.9694, 0.7} +\definecolor{kit-yellow25}{rgb}{0.9971, 0.9745, 0.75} +\definecolor{kit-yellow20}{rgb}{0.9976, 0.9796, 0.8} +\definecolor{kit-yellow15}{rgb}{0.9982, 0.9847, 0.85} +\definecolor{kit-yellow10}{rgb}{0.9988, 0.9898, 0.9} +\definecolor{kit-yellow5}{rgb}{0.9994, 0.9949, 0.95} + +% KIT color orange : +\definecolor{kit-orange}{RGB}{223, 155, 27} +\definecolor{kit-orange100}{RGB}{223, 155, 27} +\definecolor{kit-orange90}{rgb}{0.8871, 0.6471, 0.1953} +\definecolor{kit-orange80}{rgb}{0.8996, 0.6863, 0.2847} +\definecolor{kit-orange75}{rgb}{0.9059, 0.7059, 0.3294} +\definecolor{kit-orange70}{rgb}{0.9122, 0.7255, 0.3741} +\definecolor{kit-orange60}{rgb}{0.9247, 0.7647, 0.4635} +\definecolor{kit-orange50}{rgb}{0.9373, 0.8039, 0.5529} +\definecolor{kit-orange40}{rgb}{0.9498, 0.8431, 0.6424} +\definecolor{kit-orange30}{rgb}{0.9624, 0.8824, 0.7318} +\definecolor{kit-orange25}{rgb}{0.9686, 0.902, 0.7765} +\definecolor{kit-orange20}{rgb}{0.9749, 0.9216, 0.8212} +\definecolor{kit-orange15}{rgb}{0.9812, 0.9412, 0.8659} +\definecolor{kit-orange10}{rgb}{0.9875, 0.9608, 0.9106} +\definecolor{kit-orange5}{rgb}{0.9937, 0.9804, 0.9553} + +% KIT color lightgreen : +\definecolor{kit-lightgreen}{RGB}{140, 182, 60} +\definecolor{kit-lightgreen100}{RGB}{140, 182, 60} +\definecolor{kit-lightgreen90}{rgb}{0.5941, 0.7424, 0.3118} +\definecolor{kit-lightgreen80}{rgb}{0.6392, 0.771, 0.3882} +\definecolor{kit-lightgreen75}{rgb}{0.6618, 0.7853, 0.4265} +\definecolor{kit-lightgreen70}{rgb}{0.6843, 0.7996, 0.4647} +\definecolor{kit-lightgreen60}{rgb}{0.7294, 0.8282, 0.5412} +\definecolor{kit-lightgreen50}{rgb}{0.7745, 0.8569, 0.6176} +\definecolor{kit-lightgreen40}{rgb}{0.8196, 0.8855, 0.6941} +\definecolor{kit-lightgreen30}{rgb}{0.8647, 0.9141, 0.7706} +\definecolor{kit-lightgreen25}{rgb}{0.8873, 0.9284, 0.8088} +\definecolor{kit-lightgreen20}{rgb}{0.9098, 0.9427, 0.8471} +\definecolor{kit-lightgreen15}{rgb}{0.9324, 0.9571, 0.8853} +\definecolor{kit-lightgreen10}{rgb}{0.9549, 0.9714, 0.9235} +\definecolor{kit-lightgreen5}{rgb}{0.9775, 0.9857, 0.9618} + + +% KIT color purple : +\definecolor{kit-purple}{RGB}{163, 16, 124} +\definecolor{kit-purple100}{RGB}{163, 16, 124} +\definecolor{kit-purple90}{rgb}{0.6753, 0.1565, 0.5376} +\definecolor{kit-purple80}{rgb}{0.7114, 0.2502, 0.589} +\definecolor{kit-purple75}{rgb}{0.7294, 0.2971, 0.6147} +\definecolor{kit-purple70}{rgb}{0.7475, 0.3439, 0.6404} +\definecolor{kit-purple60}{rgb}{0.7835, 0.4376, 0.6918} +\definecolor{kit-purple50}{rgb}{0.8196, 0.5314, 0.7431} +\definecolor{kit-purple40}{rgb}{0.8557, 0.6251, 0.7945} +\definecolor{kit-purple30}{rgb}{0.8918, 0.7188, 0.8459} +\definecolor{kit-purple25}{rgb}{0.9098, 0.7657, 0.8716} +\definecolor{kit-purple20}{rgb}{0.9278, 0.8125, 0.8973} +\definecolor{kit-purple15}{rgb}{0.9459, 0.8594, 0.9229} +\definecolor{kit-purple10}{rgb}{0.9639, 0.9063, 0.9486} +\definecolor{kit-purple5}{rgb}{0.982, 0.9531, 0.9743} + +% KIT color brown : +\definecolor{kit-brown}{RGB}{167, 130, 46} +\definecolor{kit-brown100}{RGB}{167, 130, 46} +\definecolor{kit-brown90}{rgb}{0.6894, 0.5588, 0.2624} +\definecolor{kit-brown80}{rgb}{0.7239, 0.6078, 0.3443} +\definecolor{kit-brown75}{rgb}{0.7412, 0.6324, 0.3853} +\definecolor{kit-brown70}{rgb}{0.7584, 0.6569, 0.4263} +\definecolor{kit-brown60}{rgb}{0.7929, 0.7059, 0.5082} +\definecolor{kit-brown50}{rgb}{0.8275, 0.7549, 0.5902} +\definecolor{kit-brown40}{rgb}{0.862, 0.8039, 0.6722} +\definecolor{kit-brown30}{rgb}{0.8965, 0.8529, 0.7541} +\definecolor{kit-brown25}{rgb}{0.9137, 0.8775, 0.7951} +\definecolor{kit-brown20}{rgb}{0.931, 0.902, 0.8361} +\definecolor{kit-brown15}{rgb}{0.9482, 0.9265, 0.8771} +\definecolor{kit-brown10}{rgb}{0.9655, 0.951, 0.918} +\definecolor{kit-brown5}{rgb}{0.9827, 0.9755, 0.959} + +% KIT color cyan : +\definecolor{kit-cyan}{RGB}{35, 161, 224} +\definecolor{kit-cyan100}{RGB}{35, 161, 224} +\definecolor{kit-cyan90}{rgb}{0.2235, 0.6682, 0.8906} +\definecolor{kit-cyan80}{rgb}{0.3098, 0.7051, 0.9027} +\definecolor{kit-cyan75}{rgb}{0.3529, 0.7235, 0.9088} +\definecolor{kit-cyan70}{rgb}{0.3961, 0.742, 0.9149} +\definecolor{kit-cyan60}{rgb}{0.4824, 0.7788, 0.9271} +\definecolor{kit-cyan50}{rgb}{0.5686, 0.8157, 0.9392} +\definecolor{kit-cyan40}{rgb}{0.6549, 0.8525, 0.9514} +\definecolor{kit-cyan30}{rgb}{0.7412, 0.8894, 0.9635} +\definecolor{kit-cyan25}{rgb}{0.7843, 0.9078, 0.9696} +\definecolor{kit-cyan20}{rgb}{0.8275, 0.9263, 0.9757} +\definecolor{kit-cyan15}{rgb}{0.8706, 0.9447, 0.9818} +\definecolor{kit-cyan10}{rgb}{0.9137, 0.9631, 0.9878} +\definecolor{kit-cyan5}{rgb}{0.9569, 0.9816, 0.9939} + +% KIT color gray : +\definecolor{kit-gray}{RGB}{0, 0, 0} +\definecolor{kit-gray100}{RGB}{0, 0, 0} +\definecolor{kit-gray90}{rgb}{0.1, 0.1, 0.1} +\definecolor{kit-gray80}{rgb}{0.2, 0.2, 0.2} +\definecolor{kit-gray75}{rgb}{0.25, 0.25, 0.25} +\definecolor{kit-gray70}{rgb}{0.3, 0.3, 0.3} +\definecolor{kit-gray60}{rgb}{0.4, 0.4, 0.4} +\definecolor{kit-gray50}{rgb}{0.5, 0.5, 0.5} +\definecolor{kit-gray40}{rgb}{0.6, 0.6, 0.6} +\definecolor{kit-gray30}{rgb}{0.7, 0.7, 0.7} +\definecolor{kit-gray25}{rgb}{0.75, 0.75, 0.75} +\definecolor{kit-gray20}{rgb}{0.8, 0.8, 0.8} +\definecolor{kit-gray15}{rgb}{0.85, 0.85, 0.85} +\definecolor{kit-gray10}{rgb}{0.9, 0.9, 0.9} +\definecolor{kit-gray5}{rgb}{0.95, 0.95, 0.95} + + + +\setbeamercolor*{normal text}{fg=black} +\setbeamercolor*{alerted text}{fg=kit-red100} +\setbeamercolor*{example text}{fg=black} +\setbeamercolor*{structure}{fg=black} + +\setbeamercolor*{palette primary}{fg=black,bg=black!15} +\setbeamercolor*{palette secondary}{fg=black,bg=black!15} +\setbeamercolor*{palette tertiary}{fg=black,bg=black!15} +\setbeamercolor*{palette quaternary}{fg=black,bg=black!15} + +\setbeamercolor*{palette sidebar primary}{fg=black!75} +\setbeamercolor*{palette sidebar secondary}{fg=black!75} +\setbeamercolor*{palette sidebar tertiary}{fg=black!75} +\setbeamercolor*{palette sidebar quaternary}{fg=black!75} + +\setbeamercolor*{item projected}{fg=white,bg=kit-green100} + +\setbeamercolor*{block title}{fg=white,bg=kit-green100} +\setbeamercolor*{block title alerted}{use=alerted text,fg=white,bg=alerted text.fg!75!black} +\setbeamercolor*{block title example}{fg=white,bg=kit-blue100} + +\setbeamercolor*{block body}{fg=black,bg=kit-green15} +\setbeamercolor*{block body alerted}{parent=normal text,use=block title alerted,bg=block title alerted.bg!10!bg} +\setbeamercolor*{block body example}{fg=black,bg=kit-blue15} + +\setbeamercolor*{separation line}{} +\setbeamercolor*{fine separation line}{} + +\setbeamercolor*{background canvas}{bg=white} + +%% ----------- +%% | /Farben | +%% ----------- + +%% ----------------------------------- +%% | halbgerundete Aufzählungspunkte | +%% ----------------------------------- + +\newcommand{\itemizeColor}{kit-green100} + +% KIT-Aufzählungszeichen +\newcommand{\KITmark}{% + \begin{pgfpicture}{0mm}{0mm}{1ex}{1ex} + {\pgfsetcornersarced{\pgfpoint{.3ex}{.3ex}} + \pgfpathmoveto{\pgfpoint{0cm}{1ex}} + \pgfpathlineto{\pgfpoint{1ex}{1ex}} + \pgfpathlineto{\pgfpoint{1ex}{0cm}}} + {\pgfsetcornersarced{\pgfpoint{.3ex}{.3ex}} + \pgfpathmoveto{\pgfpoint{1ex}{0cm}} + \pgfpathlineto{\pgfpointorigin} + \pgfpathlineto{\pgfpoint{0cm}{1ex}}} + \color{\itemizeColor} + \pgfusepath{fill} + \end{pgfpicture}% +} + +% \setbeamertemplate{itemize items}{\raisebox{.2ex}{\KITmark}} +\setbeamertemplate{itemize items}[square] +\setbeamercolor{itemize item}{fg=kit-green100} + +%% ---------------------- +%% | Inhaltsverzeichnis | +%% ---------------------- + +\setbeamertemplate{section in toc}{\normalsize\textbf{\textcolor{kit-blue}{\inserttocsectionnumber.~\inserttocsection}}\par} +\setbeamertemplate{subsection in toc}{\small\hspace{1.2em}\raisebox{.2ex}{\KITmark}\hspace{\labelsep}\inserttocsubsection\par} + +%% ------------------------------ +%% | halbgerundete Beamer-Boxen | +%% ------------------------------ + +\renewcommand\beamerboxesrounded[2][]{% + \global\let\beamer@firstlineitemizeunskip=\relax% + \vbox\bgroup% + \setkeys{beamerboxes}{upper=block title,lower=block body,width=\textwidth,shadow=false}% + \setkeys{beamerboxes}{#1}% + {% + \usebeamercolor{\bmb@lower}% + \globalcolorstrue% + \colorlet{lower.bg}{bg}% + }% + {% + \usebeamercolor{\bmb@upper}% + \globalcolorstrue% + \colorlet{upper.bg}{bg}% + }% + % + % Typeset head + % + \vskip4bp + \setbox\bmb@box=\hbox{% + \begin{minipage}[b]{\bmb@width}% + \usebeamercolor[fg]{\bmb@upper}% + #2% + \end{minipage}}% + \ifdim\wd\bmb@box=0pt% + \setbox\bmb@box=\hbox{}% + \ht\bmb@box=1.5pt% + \bmb@prevheight=-4.5pt% + \else% + \wd\bmb@box=\bmb@width% + \bmb@temp=\dp\bmb@box% + \ifdim\bmb@temp<1.5pt% + \bmb@temp=1.5pt% + \fi% + \setbox\bmb@box=\hbox{\raise\bmb@temp\hbox{\box\bmb@box}}% + \dp\bmb@box=0pt% + \bmb@prevheight=\ht\bmb@box% + \fi% + \bmb@temp=\bmb@width% + \bmb@dima=\bmb@temp\advance\bmb@dima by2.2bp% + \bmb@dimb=\bmb@temp\advance\bmb@dimb by4bp% + \hbox{% + \begin{pgfpicture}{0bp}{+-\ht\bmb@box}{0bp}{+-\ht\bmb@box} + \ifdim\wd\bmb@box=0pt% + \color{lower.bg}% + \else% + \color{upper.bg}% + \fi% + \pgfpathqmoveto{-4bp}{-1bp} + % Adaption for "KIT-Design" + \pgfpathlineto{\pgfpoint{-4bp}{3bp}} + %\pgfpathqcurveto{-4bp}{1.2bp}{-2.2bp}{3bp}{0bp}{3bp} + \pgfpathlineto{\pgfpoint{\bmb@temp}{3bp}} + \pgfpathcurveto% + {\pgfpoint{\bmb@dima}{3bp}}% + {\pgfpoint{\bmb@dimb}{1.2bp}}% + {\pgfpoint{\bmb@dimb}{-1bp}}% + \bmb@dima=-\ht\bmb@box% + \advance\bmb@dima by-2pt% + \pgfpathlineto{\pgfpoint{\bmb@dimb}{\bmb@dima}} + \pgfpathlineto{\pgfpoint{-4bp}{\bmb@dima}} + \pgfusepath{fill} + \end{pgfpicture}% + \copy\bmb@box% + }% + \nointerlineskip% + \vskip-1pt% + \ifdim\wd\bmb@box=0pt% + \else% + \hbox{% + \begin{pgfpicture}{0pt}{0pt}{\bmb@width}{6pt} + \bmb@dima=\bmb@width% + \advance\bmb@dima by8bp% + \pgfpathrectangle{\pgfpoint{-4bp}{-1bp}}{\pgfpoint{\bmb@dima}{8bp}} + \pgfusepath{clip} + {\pgftransformshift{\pgfpoint{-4bp}{0bp}}\pgftext[left,base]{\pgfuseshading{bmb@transition}}}% + \end{pgfpicture}% + }% + \nointerlineskip% + \vskip-0.5pt% + \fi% + \ifbmb@shadow% + \setbox\bmb@boxshadow=\hbox{\pgfuseshading{bmb@shadow}}% + \setbox\bmb@boxshadowball=\hbox{\pgfuseshading{bmb@shadowball}}% + \setbox\bmb@boxshadowballlarge=\hbox{\pgfuseshading{bmb@shadowballlarge}}% + \fi% + \setbox\bmb@colorbox=\hbox{{\pgfpicturetrue\pgfsetcolor{lower.bg}}}% + \setbox\bmb@box=\hbox\bgroup\begin{minipage}[b]{\bmb@width}% + \vskip2pt% + \usebeamercolor[fg]{\bmb@lower}% + \colorlet{beamerstructure}{upper.bg}% + \colorlet{structure}{upper.bg}% + %\color{.}% + } + +\def\endbeamerboxesrounded{% + \end{minipage}\egroup% + \wd\bmb@box=\bmb@width% + \bmb@temp=\dp\bmb@box% + \advance\bmb@temp by.5pt% + \setbox\bmb@box=\hbox{\raise\bmb@temp\hbox{\box\bmb@box}}% + \dp\bmb@box=0pt% + \bmb@temp=\wd\bmb@box% + \bmb@dima=\bmb@temp\advance\bmb@dima by2.2bp% + \bmb@dimb=\bmb@temp\advance\bmb@dimb by4bp% + \hbox{% + \begin{pgfpicture}{0bp}{0bp}{0bp}{0bp} + \ifbmb@shadow% + {\pgftransformshift{\pgfpoint{4bp}{-3bp}}\pgftext{\copy\bmb@boxshadowball}} + \begin{pgfscope} + {% + \advance\bmb@temp by-1bp% + \pgfpathrectangle{\pgfpoint{\bmb@temp}{-7bp}}{\pgfpoint{9bp}{9bp}}% + \pgfusepath{clip} + }% + {\pgftransformshift{\pgfpoint{\bmb@temp}{1bp}}\pgftext{\box\bmb@boxshadowballlarge}} + \end{pgfscope} + \begin{pgfscope} + \advance\bmb@temp by-4bp% + \pgfpathrectangle{\pgfpoint{4bp}{-7bp}}{\pgfpoint{\bmb@temp}{5bp}} + \pgfusepath{clip} + {\pgftransformshift{\pgfpoint{4bp}{-7bp}}\pgftext[left,base]{\copy\bmb@boxshadow}}% + \end{pgfscope} + \begin{pgfscope} + \advance\bmb@temp by 4bp% + \bmb@dima=\ht\bmb@box% + \advance\bmb@dima by\bmb@prevheight% + \advance\bmb@dima by 4bp% + \pgfpathrectangle{\pgfpoint{\bmb@temp}{1bp}}{\pgfpoint{4bp}{\bmb@dima}} + \pgfusepath{clip} + \advance\bmb@dima by-4bp% + {\pgftransformshift{\pgfpoint{\bmb@temp}{\bmb@dima}}\pgftext{\box\bmb@boxshadowball}} + \advance\bmb@dima by-1bp% + \pgfpathrectangle{\pgfpoint{\bmb@temp}{1bp}}{\pgfpoint{4bp}{\bmb@dima}} + \pgfusepath{clip} + \advance\bmb@temp by4bp% + {\pgftransformshift{\pgfpoint{\bmb@temp}{-3bp}}% + \pgftransformrotate{90}% + \pgftext[left,base]{\box\bmb@boxshadow}}% + \end{pgfscope} + \fi% + \unhbox\bmb@colorbox% + \pgfpathqmoveto{-4bp}{1bp} + \pgfpathqcurveto{-4bp}{-1.2bp}{-2.2bp}{-3bp}{0bp}{-3bp} + \pgfpathlineto{\pgfpoint{\the\bmb@dimb}{-3bp}} + { + \bmb@dima=\ht\bmb@box% + \pgfpathlineto{\pgfpoint{\bmb@dimb}{\bmb@dima}} + \pgfpathlineto{\pgfpoint{-4bp}{\bmb@dima}} + \pgfusepath{fill} + } + \ifbmb@shadow% + { + \color{black!50!bg} + \pgfsetlinewidth{0pt} + \pgfpathmoveto{\pgfpoint{\bmb@dimb}{-.5bp}} + \bmb@dima=\ht\bmb@box% + \advance\bmb@dima by\bmb@prevheight% + \advance\bmb@dima by 1bp% + \pgfpathlineto{\pgfpoint{\bmb@dimb}{\bmb@dima}} + \pgfusepath{stroke} + \bmb@temp=\bmb@dima + \advance\bmb@dima by 1bp% + \color{black!31!bg} + \pgfpathmoveto{\pgfpoint{\bmb@dimb}{\bmb@temp}} + \pgfpathlineto{\pgfpoint{\bmb@dimb}{\bmb@dima}} + \pgfusepath{stroke} + \advance\bmb@dima by 1bp% + \advance\bmb@temp by 1bp% + \color{black!19!bg} + \pgfpathmoveto{\pgfpoint{\bmb@dimb}{\bmb@temp}} + \pgfpathlineto{\pgfpoint{\bmb@dimb}{\bmb@dima}} + \pgfusepath{stroke} + \advance\bmb@dima by 1bp% + \advance\bmb@temp by 1bp% + \color{black!6!bg} + \pgfpathmoveto{\pgfpoint{\bmb@dimb}{\bmb@temp}} + \pgfpathlineto{\pgfpoint{\bmb@dimb}{\bmb@dima}} + \pgfusepath{stroke} + \advance\bmb@dima by 1.5bp% + \advance\bmb@temp by 1bp% + \color{bg} + \pgfpathmoveto{\pgfpoint{\bmb@dimb}{\bmb@temp}} + \pgfpathlineto{\pgfpoint{\bmb@dimb}{\bmb@dima}} + \pgfusepath{stroke} + } + \fi + \end{pgfpicture}% + \box\bmb@box% + }% + \ifbmb@shadow% + \vskip4bp minus 2bp% + \else% + \vskip2bp% + \fi% + \egroup% of \vbox\bgroup +} + + +%% ------------------------------- +%% | /halbgerundete Beamer-Boxen | +%% ------------------------------- + + +%% ---------------------- +%% | Block-Definitionen | +%% ---------------------- + +% Content environment for structuring. Basically a headline followed by text +\newenvironment<>{contentblock}[1]{\begingroup% + \setbeamertemplate{blocks}[default] + \setbeamercolor{block body}{fg=black,bg=}% + \setbeamercolor{block title}{fg=black,bg=}% + \setbeamerfont*{block title}{family=\sffamily,series=\bfseries,size=\large} + \begin{block}#2{#1}% + }{\end{block}% +\endgroup} + + +\newenvironment<>{greenblock}[1]{\begingroup% + \setbeamercolor{block body}{fg=black,bg=kit-green15}% + \setbeamercolor{block title}{fg=white,bg=kit-green100}% + \begin{block}#2{#1}% + }{\end{block} +\endgroup} + +\newenvironment<>{blueblock}[1]{\begingroup% + \setbeamercolor{block body}{fg=black,bg=kit-blue15}% + \setbeamercolor{block title}{fg=white,bg=kit-blue100}% + \setbeamercolor{itemize item}{fg=kit-blue100} + \begin{block}#2{#1}% + }{\end{block} +\endgroup} + +\newenvironment<>{redblock}[1]{\begingroup% + \setbeamercolor{block body}{fg=black,bg=kit-red15}% + \setbeamercolor{block title}{fg=white,bg=kit-red100}% + \setbeamercolor{itemize item}{fg=kit-red100}% + \begin{block}#2{#1}% + }{\end{block}% +\endgroup} + +\newenvironment<>{brownblock}[1]{\begingroup% + \setbeamercolor{block body}{fg=black,bg=kit-brown15}% + \setbeamercolor{block title}{fg=white,bg=kit-brown100}% + \setbeamercolor{itemize item}{fg=kit-brown100}% + \begin{block}#2{#1}% + }{\end{block}% +\endgroup} + +\newenvironment<>{purpleblock}[1]{\begingroup% + \setbeamercolor{block body}{fg=black,bg=kit-purple15}% + \setbeamercolor{block title}{fg=white,bg=kit-purple100}% + \setbeamercolor{itemize item}{fg=kit-purple100}% + \begin{block}#2{#1}% + }{\end{block}% +\endgroup} + +\newenvironment<>{grayblock}[1]{\begingroup% + \setbeamercolor{block body}{fg=black,bg=kit-gray15}% + \setbeamercolor{block title}{fg=white,bg=kit-gray70}% + \setbeamercolor{itemize item}{fg=kit-gray70}% + \begin{block}#2{#1}% + }{\end{block}% +\endgroup} + +\newenvironment<>{yellowblock}[1]{\begingroup% + \setbeamercolor{block body}{fg=black,bg=kit-yellow30}% + \setbeamercolor{block title}{fg=black,bg=kit-yellow100}% + \setbeamercolor{itemize item}{fg=kit-yellow100}% + \begin{block}#2{#1}% + }{\end{block}% +\endgroup} + +\newenvironment<>{lightgreenblock}[1]{\begingroup% + \setbeamercolor{block body}{fg=black,bg=kit-lightgreen15}% + \setbeamercolor{block title}{fg=white,bg=kit-lightgreen100}% + \setbeamercolor{itemize item}{fg=kit-lightgreen100}% + \begin{block}#2{#1}% + }{\end{block}% +\endgroup} + +\newenvironment<>{orangeblock}[1]{\begingroup% + \setbeamercolor{block body}{fg=black,bg=kit-orange15}% + \setbeamercolor{block title}{fg=white,bg=kit-orange100}% + \setbeamercolor{itemize item}{fg=kit-orange100}% + \begin{block}#2{#1}% + }{\end{block}% +\endgroup} + +\newenvironment<>{cyanblock}[1]{\begingroup% + \setbeamercolor{block body}{fg=black,bg=kit-cyan15}% + \setbeamercolor{block title}{fg=white,bg=kit-cyan100}% + \setbeamercolor{itemize item}{fg=kit-cyan100}% + \begin{block}#2{#1}% + }{\end{block}% +\endgroup} + +\newenvironment<>{maroonblock}[1]{\begingroup% +\setbeamercolor{block body}{fg=black,bg=Maroon!15}% +\setbeamercolor{block title}{fg=white,bg=Maroon}% + \setbeamercolor{itemize item}{fg=Maroon}% +\begin{block}#2{#1}% +}{\end{block}% +\endgroup} +%% ------------------------------ +%% | /Block-Definitionen | +%% ------------------------------ + +%% use this for setting the total page number +\newcommand{\beginbackup}{ + \newcounter{framenumbervorappendix} + \setcounter{framenumbervorappendix}{\value{framenumber}} +} +\newcommand{\backupend}{ + \addtocounter{framenumbervorappendix}{-\value{framenumber}} + \addtocounter{framenumber}{\value{framenumbervorappendix}} +} diff --git a/11-entwurfsheft-kolloquium/slides/apiExtension.tex b/11-entwurfsheft-kolloquium/slides/apiExtension.tex new file mode 100644 index 0000000..df1c027 --- /dev/null +++ b/11-entwurfsheft-kolloquium/slides/apiExtension.tex @@ -0,0 +1,39 @@ +\begin{frame}{API Erweiterung} + + \begin{columns}[t] + \begin{column}{.3\textwidth} + \centering{\fontsize{30pt}{36pt}\selectfont\faLock} + \vspace{.2cm} + \begin{orangeblock}{Authentication} + \begin{itemize} + \item Registrierung + \item Passwort ändern + \item Passwort vergessen + \item Passwort zurücksetzen + \item Account löschen + \end{itemize} + \end{orangeblock} + \end{column} + \begin{column}{.3\textwidth} + \centering{\fontsize{30pt}{36pt}\selectfont\faDownload} + \vspace{.2cm} + \begin{greenblock}{Subscriptions} + \begin{itemize} + \item Abrufen der Informationen aller Abonnements + \end{itemize} + \end{greenblock} + \end{column} + \begin{column}{.3\textwidth} + \centering{\fontsize{30pt}{36pt}\selectfont\faSpinner} + \vspace{.2cm} + \begin{blueblock}{Episode Actions} + \begin{itemize} + \item Episode Actions hochladen + \item Episode Actions abrufen + \end{itemize} + \end{blueblock} + \end{column} + \end{columns} + +\end{frame} + diff --git a/11-entwurfsheft-kolloquium/slides/architecture.tex b/11-entwurfsheft-kolloquium/slides/architecture.tex new file mode 100644 index 0000000..edd9f1b --- /dev/null +++ b/11-entwurfsheft-kolloquium/slides/architecture.tex @@ -0,0 +1,7 @@ +\begin{frame}{Architektur} + + \begin{figure}[h] + \includegraphics[width=0.73\textwidth]{assets/diagrams/backendComponentDiagram} + \end{figure} + +\end{frame}
\ No newline at end of file diff --git a/11-entwurfsheft-kolloquium/slides/changes.tex b/11-entwurfsheft-kolloquium/slides/changes.tex new file mode 100644 index 0000000..b3ba6de --- /dev/null +++ b/11-entwurfsheft-kolloquium/slides/changes.tex @@ -0,0 +1,22 @@ +\begin{frame}[t]{Änderungen Pflichtenheft} + + \begin{block}{Neue Kriterien} + \begin{itemize} + \item \textlangle RS11\textrangle \, Cooldown Fetch-Vorgang + \item \textlangle RC13\textrangle \, Sprache von Browserinformationen + \end{itemize} + \end{block} + + \begin{blueblock}{Abgeänderte Kriterien} + \begin{itemize} + \item \textlangle RS10\textrangle \, Sessions mit JSON Web Token + \end{itemize} + \end{blueblock} + + \begin{maroonblock}{Entfernte Kriterien} + \begin{itemize} + \item \textlangle RC5\textrangle \, Frontend kompatibel mit beliebigen Gpodder APIs + \end{itemize} + \end{maroonblock} + +\end{frame} diff --git a/11-entwurfsheft-kolloquium/slides/classdiagram.tex b/11-entwurfsheft-kolloquium/slides/classdiagram.tex new file mode 100644 index 0000000..aeecec0 --- /dev/null +++ b/11-entwurfsheft-kolloquium/slides/classdiagram.tex @@ -0,0 +1,57 @@ +\begin{frame}[t]{Überblick: Klassendiagramm} + \centering + \includegraphics[width=\textwidth]{assets/diagrams/classdiagram} + \vspace{.3cm} + \begin{greenblock}{Abhängigkeiten} + \vspace{-.2cm} + \begin{columns} + \begin{column}{.4\textwidth} + \begin{itemize} + \item Spring Web + \item Spring Security + \item Spring Mail Sender + \end{itemize} + \end{column} + \begin{column}{.4\textwidth} + \begin{itemize} + \item Spring Data JPA + \item Lombok + \item Rome (RSS parsing/fetching) + \end{itemize} + \end{column} + \end{columns} + + \end{greenblock} +\end{frame} + +% sub +% episode +% auth +% model +% util + +\begin{frame}[t]{Subscriptions-API} + \centering + \includegraphics[width=\textwidth]{assets/diagrams/classdiagram-subscriptions} +\end{frame} + +\begin{frame}[t]{EpisodeActions-API} + \centering + \includegraphics[width=\textwidth]{assets/diagrams/classdiagram-episode-actions} +\end{frame} + +\begin{frame}[t]{Authentication-API} + \centering + \includegraphics[width=.73\textwidth]{assets/diagrams/classdiagram-authentication} +\end{frame} + +\begin{frame}[t]{Model-Paket} + \centering + \includegraphics[width=\textwidth]{assets/diagrams/classdiagram-model} +\end{frame} + +\begin{frame}[t]{Util-Paket} + \centering + \includegraphics[width=\textwidth]{assets/diagrams/classdiagram-util} +\end{frame} + diff --git a/11-entwurfsheft-kolloquium/slides/frontend.tex b/11-entwurfsheft-kolloquium/slides/frontend.tex new file mode 100644 index 0000000..c49d94f --- /dev/null +++ b/11-entwurfsheft-kolloquium/slides/frontend.tex @@ -0,0 +1,21 @@ +\begin{frame}{Weboberfläche} + \begin{minipage}{.77\textwidth} + \centering + \includegraphics[width=\textwidth]{assets/diagrams/componentdiagram} + \end{minipage} + \hspace{.3cm} + \begin{minipage}{.18\textwidth} + \begin{greenblock}{Abhängigkeiten} + \begin{itemize} + \item vite + \item vue + \item vue-router + \item Pinia + \item bootstrap + \item fontawesome + \item vue-i18n + \end{itemize} + \end{greenblock} + \end{minipage} +\end{frame} + diff --git a/11-entwurfsheft-kolloquium/slides/pattern.tex b/11-entwurfsheft-kolloquium/slides/pattern.tex new file mode 100644 index 0000000..1f6366e --- /dev/null +++ b/11-entwurfsheft-kolloquium/slides/pattern.tex @@ -0,0 +1,26 @@ +\begin{frame}{Entwurfsmuster} + \begin{columns}[t] + \column{.5\textwidth} + \centering{\fontsize{30pt}{36pt}\selectfont\faSyringe} + \begin{greenblock}{Dependency Injection} + \begin{itemize} + \item Bestimmt Abhängigkeiten in Klassen + \item Speichert Instanzen dieser Abhängigkeiten an zentralem Ort + % Wichtig für Interface Abhängigkeiten: + \item Instanz in Konfiguration festlegbar + \item Setzt Instanzen während der Laufzeit an benötigter Stelle ein + \end{itemize} + \end{greenblock} + \column{.5\textwidth} + \centering{\fontsize{30pt}{36pt}\selectfont\faDatabase} + \begin{blueblock}{Data Access Object (DAO)} + \color{kit-blue100} + \begin{itemize} + \item DAO-Interface als Schnittstelle zwischen Geschäftslogik und Datenzugriffslogik + \item DAO-Implementierungen als Varianten der Datenzugriffslogik (MariaDB, MySQL, etc.) + \item[$\Rightarrow$] Austauschbare Implementierungen + \end{itemize} + \end{blueblock} + \end{columns} +\end{frame} + diff --git a/11-entwurfsheft-kolloquium/slides/sequence.tex b/11-entwurfsheft-kolloquium/slides/sequence.tex new file mode 100644 index 0000000..393e502 --- /dev/null +++ b/11-entwurfsheft-kolloquium/slides/sequence.tex @@ -0,0 +1,7 @@ +\begin{frame}{Abläufe: Abrufen aller Abonnements} + + \begin{figure}[h] + \includegraphics[width=0.83\textwidth]{assets/diagrams/sequencediagram-getSubscriptions} + \end{figure} + +\end{frame}
\ No newline at end of file |
