Browse Source

Added documentation

master
Markus Becker 5 months ago
parent
commit
5cafef4ea8
  1. 107
      data/error.php
  2. 6
      interface/exec/pulllib.php
  3. 27
      interface/panel.php

107
data/error.php

@ -5,65 +5,56 @@
<html>
<head>
<title>Error Handling</title>
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.1/dist/css/bootstrap.min.css" rel="stylesheet"
integrity="sha384-+0n0xVW2eSR5OomGNYDnhzAbDsOXxcvSN1TPprVMTNDbiYZCxYbOOl7+AMvyTG2x" crossorigin="anonymous">
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.1/dist/js/bootstrap.bundle.min.js"
integrity="sha384-gtEjrD/SeCtmISkJkNUaaKMoLD0//ElJ19smozuHV6z3Iehds+3Ulb9Bn9Plx0x4"
crossorigin="anonymous"></script>
</head>
<style type="text/css">
td input{
box-sizing:border-box;
width: 100%;
margin: 0 0;
}
table.one{
background-color: #D2D2D2;
border-radius: .3em;
}
</style>
<body>
<h2>Fehlerbehebung</h2>
<p>Die meisten Fehlerursachen kann man beheben indem mach sich erneut einloggt. Der Encrypt-Schlüssel kann beim Systemadministrator erfragt werden.</p>
<table>
<tr>
<th>Login mit "normalen" Benutzerdaten</th>
<th>Login über "encrypted" Schlüssel</th>
</tr>
<tr>
<td><form action="../interface/panel.php" method="post">
<table class="one">
<tr>
<td>Benutzer</td>
<td><input type="text" name="username" placeholder="Benutzername"></td>
</tr>
<tr>
<td>Passwort</td>
<td><input type="password" name="password" placeholder="Passwort"></td>
</tr>
<tr>
<td></td>
<td><input type="submit" value="Einloggen"></td>
</tr>
</table>
</form></td>
<td><form action="../login.php" method="GET">
<table class="one">
<tr>
<td>Benutzer</td>
<td><input type="text" name="username" placeholder="Benutzername"></td>
</tr>
<tr>
<td>Encrypt</td>
<td><input type="text" name="encrypt" placeholder="16Char Key"></td>
</tr>
<tr>
<td>FID</td>
<td><input type="text" name="fid" placeholder="Target-FID"></td>
</tr>
<tr>
<td></td>
<td><input type="submit" value="Weiterleitung"></td>
</tr>
</table>
</form></td>
</tr>
</table>
<div class="container mt-3">
<div class="card">
<div class="card-header h3">Fehlerbehandlung</div>
<div class="card-body">
<p>Die meisten Fehlerursachen kann man beheben indem mach sich erneut einloggt. Der Encrypt-Schlüssel kann beim Systemadministrator erfragt werden.</p>
<div class="row justify-content-center">
<div class="col-auto">
<form action="../interface/panel.php" method="POST" class="alert alert-primary p-3">
<h5>Einloggen mit Benutzerdaten</h5>
<div class="mb-3">
<label class="form-label">Benutzername</label>
<input type="text" class="form-control" name="username">
</div>
<div class="mb-3">
<label class="form-label">Passwort</label>
<input type="password" class="form-control" name="password">
</div>
<input type="submit" value="Einloggen" class="btn btn-primary">
</form>
</div>
<div class="col-auto">
<form action="../login.php" method="GET" class="alert alert-warning p-3">
<h5>Einloggen mit Zugriffstoken</h5>
<div class="mb-3">
<label class="form-label">Benutzername</label>
<input type="text" class="form-control" name="username">
</div>
<div class="mb-3">
<label class="form-label">Zugriffstoken</label>
<input type="text" class="form-control" name="encrypt">
<div class="form-text">16 Zeichen ASCII</div>
</div>
<div class="mb-3">
<label class="form-label">Anzeigen ID</label>
<input type="text" class="form-control" name="fid">
<div class="form-text">"FID" im Portal</div>
</div>
<input type="submit" value="Weiterleiten" class="btn btn-warning">
</form>
</div>
</div>
</div>
</div>
</div>
</body>
</html>

6
interface/exec/pulllib.php

@ -34,12 +34,12 @@ function getFolderArray(){
function buildMenu(){
$folders = getFolderArray();
echo '<div class="card"><div class="h3 card-header">Men&uuml;</div><div class="card-body"><h4>Ordner</h4><ul>';
echo '<div class="card"><div class="h3 card-header">Men&uuml;</div><div class="card-body"><ul><li><a href="panel.php">Home</a></li></ul></div><hr><div class="card-body"><h4>Anzeigen</h4><ul>';
foreach ($folders as $num => $dir) {
echo "<li><a href=\"?folder=$dir%20$num&fid=$num\">$dir</a></li>";
}
echo '</ul></div><hr><div class="card-body"><h3>Funktionen</h3><ul><li><a href="?i=no&folder=neuer%20Ordner">neuer Ordner</a></li>
<li><a href="?i=nu&folder=neuer%20Benutzer">neuer Benutzer</a></li>
echo '</ul></div><hr><div class="card-body"><h4>Funktionen</h4><ul><li><a href="?i=no&folder=neuer%20Ordner">Anzeige erstellen</a></li>
<li><a href="?i=nu&folder=neuer%20Benutzer">Benutzer erstellen</a></li>
</ul></div></div>';
}

27
interface/panel.php

@ -19,8 +19,8 @@ if (!$login){
<body>
<div class="container">
<div class="row mt-3">
<div class="col-2"><?php buildMenu(); ?></div>
<div class="col-10">
<div class="col-auto"><?php buildMenu(); ?></div>
<div class="col-9">
<?php
if(isset($_GET["folder"])){
echo "<h2>Ordner: ".$_GET["folder"]."</h2>";
@ -32,7 +32,28 @@ if (!$login){
}
} else {
echo "<h2>WMS-Interface</h2>";
println("<p>Willkommen auf dem WMS-Interface.<br>Das Weather Monitoring System (WMS) besteht aus mehreren Ordnern. Um die Bilder in den Ordnern zu bearbeiten findet Ihr auf der linken Seite eine Menü.</p>");
println("<p>Willkommen auf dem WMS-Interface.<br>
Das Weather Monitoring System (WMS) besteht aus mehreren Anzeigen.
Um Bilder den Anzeigen zuzuordenen findet Ihr auf der linken Seite eine Menü.</p>
<p>Dieses Portal und das Anzeigesystem im Schulzentrum Kühlungsborn wurde von
<a href='mailto:mtib.becker+szkborn@gmail.com'>Markus Becker</a>
und Ronald Eixmann unter der Flagge von Campus Pro in PHP und Python entwickelt.
Für die Übergabe 2021 wurden ein paar letzte Kleinigkeiten nochmal aufgearbeitet,
allerdings hält es sich hier immernoch nur um einen Proof-of-Concept, mit einem
Maßstab der Stabilität
und Security die dem Best-Effort eines 10. Klässlers entspricht.</p>
<p>Bei Fragen zum System meldet euch am besten bei demjenigen der
euch die Zugangsdaten gegeben hat, zu technischen Details kontaktiert mich.
</p><p>Der Code ist <a href='https://mtib.dev/jufo/apewms'>open-source</a>,
und für die API kann ich Zugriff ermöglichen um programmatisch den Inhalt zu ändern
oder auszulesen, wenn ihr wisst was ihr tut. Eine Python-Implementation für die API
und eine Beispielanwendung kann
<a href='https://mtib.dev/jufo/autowkid'>hier</a> gefunden werden (Geburtstagsgrafikgenerator).
Für die meisten modernen Programmiersprachen könnte ich auch in kurzer Zeit eine API
Implementation zuarbeiten.</p>
<p>Weitere Dokumentation zur Erstellung dieses Portals kann in Kapitel 2 meiner
<a href='https://github.com/mtib/auvi-hub/releases/download/v0.5.0/bll.pdf'>Besonderen Lernleistung</a>
gefunden werden.</p>");
}
if(isset($_GET["i"])){
$include = htmlspecialchars($_GET["i"]);

Loading…
Cancel
Save