From 5c3b4af1bd09833feccb14b74f77d8168c37fbd0 Mon Sep 17 00:00:00 2001 From: marko Date: Fri, 29 Nov 2024 21:18:02 +0100 Subject: [PATCH] adjusted config paths, WIP: messages handling --- .../www/participo/admin.inc.php | 2 +- .../www/participo/api.starter.add.php | 2 +- .../www/participo/api.starter.remove.php | 2 +- .../www/participo/api.user.add.php | 2 +- .../www/participo/attendance.php | 2 +- .../cwsvjudo@bplaced/www/participo/event.php | 13 +-- .../www/participo/events.inc.php | 2 +- .../www/participo/events.sidenav.inc.php | 2 +- .../www/participo/index.inc.php | 2 +- .../www/participo/infoZettel.php | 2 +- .../participo/lib/participoLib/eventPage.php | 2 +- .../participo/lib/participoLib/participo.php | 96 +++++++++++++++---- .../cwsvjudo@bplaced/www/participo/login.php | 8 +- .../cwsvjudo@bplaced/www/participo/user.php | 2 +- homepage/cwsvJudo/participo/test/config.toml | 4 + homepage/cwsvJudo/participo/test/helper.py | 22 ++++- homepage/cwsvJudo/participo/test/test_main.py | 2 +- 17 files changed, 121 insertions(+), 46 deletions(-) diff --git a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/admin.inc.php b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/admin.inc.php index 8cc2610..8d987e3 100644 --- a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/admin.inc.php +++ b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/admin.inc.php @@ -20,7 +20,7 @@ dbConnector::connect( ); // authentication of the current user -participo::authentificate(); +participo::authenticate(); if (!participo::isUserAdmin()) { header('Location: /participo', true, 301); } diff --git a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/api.starter.add.php b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/api.starter.add.php index 5af7aef..027b5d0 100644 --- a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/api.starter.add.php +++ b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/api.starter.add.php @@ -14,7 +14,7 @@ dbConnector::connect( $cwsvJudoConfig['db']['password'] ); -participo::authentificate(); +participo::authenticate(); $eventId = $_POST['eventId'] ?? null; $startingTypeId = $_POST['type'] ?? null; diff --git a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/api.starter.remove.php b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/api.starter.remove.php index 6087eae..4373ffe 100644 --- a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/api.starter.remove.php +++ b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/api.starter.remove.php @@ -14,7 +14,7 @@ dbConnector::connect( $cwsvJudoConfig['db']['password'] ); -participo::authentificate(); +participo::authenticate(); $starterId = $_POST['starterId'] ?? null; $returnToUrl = $_POST['returnToUrl'] ?? 'participo/'; diff --git a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/api.user.add.php b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/api.user.add.php index 9bb60da..e16d289 100644 --- a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/api.user.add.php +++ b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/api.user.add.php @@ -15,7 +15,7 @@ dbConnector::connect( $cwsvJudoConfig['db']['password'] ); -participo::authentificate(); +participo::authenticate(); $loginName = $_POST['loginName'] ?? null; $name = $_POST['name'] ?? null; diff --git a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/attendance.php b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/attendance.php index 546b4e9..6c17f06 100644 --- a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/attendance.php +++ b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/attendance.php @@ -21,7 +21,7 @@ setlocale(LC_ALL, 'de_DE@euro', 'de_DE', 'de', 'ge'); $cwsvJudoConfig['db']['password'] ); - participo::authentificate(); + participo::authenticate(); $user = participo::sessionUser(); $usersKids = getUsersKids(dbConnector::getDbConnection(), $_SESSION['user']['userId']); diff --git a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/event.php b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/event.php index 2da7d96..5c2eda5 100644 --- a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/event.php +++ b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/event.php @@ -6,7 +6,8 @@ require_once 'participoLib/event.php'; // Configs require_once 'config/participo.php'; -require_once $config['basePath'] . '/config/cwsvJudo.config.php'; +// @todo Switch to json saved settings +require_once $config['home'] . '/.local/cwsvJudo.config.php'; participo::init($cwsvJudoConfig); @@ -24,12 +25,12 @@ participo::init($cwsvJudoConfig); - <?php echo($meta['title']); ?> + <?php echo ($meta['title'] ?? "title missing"); ?> + content="" /> - - + + @@ -44,4 +45,4 @@ participo::init($cwsvJudoConfig); - + \ No newline at end of file diff --git a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/events.inc.php b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/events.inc.php index df4fb02..f535202 100644 --- a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/events.inc.php +++ b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/events.inc.php @@ -22,7 +22,7 @@ dbConnector::connect( $cwsvJudoConfig["db"]["password"] ); -participo::authentificate(); +participo::authenticate(); $meta = [ "title" => "Event Planer", diff --git a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/events.sidenav.inc.php b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/events.sidenav.inc.php index 431bad5..2089fb2 100644 --- a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/events.sidenav.inc.php +++ b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/events.sidenav.inc.php @@ -4,7 +4,7 @@
cwsvJudo-Apps - + diff --git a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/index.inc.php b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/index.inc.php index 38afc3f..0f9de76 100644 --- a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/index.inc.php +++ b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/index.inc.php @@ -32,4 +32,4 @@ dbConnector::connect( ); // authentication of the current user -participo::authentificate(); +participo::authenticate(); diff --git a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/infoZettel.php b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/infoZettel.php index 2078e0a..a0c8c72 100644 --- a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/infoZettel.php +++ b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/infoZettel.php @@ -14,7 +14,7 @@ require_once $basePath . '/ressourcen/phpLib/parsedown/Parsedown.php'; require_once $basePath . '/ressourcen/phpLib/Spyc/Spyc.php'; - participo::authentificate(); + participo::authenticate(); // get a list of all infoZettel $fileList = glob($basePath . '/infoZettel/*.md'); diff --git a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/lib/participoLib/eventPage.php b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/lib/participoLib/eventPage.php index 177cae9..5ef28ea 100644 --- a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/lib/participoLib/eventPage.php +++ b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/lib/participoLib/eventPage.php @@ -24,7 +24,7 @@ class EventPage public function getHtmlNotFound() { return '
Der Event "' . - $this->id . + $this->eventId . '" existiert leider nicht!
' . "

Anstehende Termine

" . eventPlaner::getHtmlEventTable(eventPlaner::getComingWkEvents()); diff --git a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/lib/participoLib/participo.php b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/lib/participoLib/participo.php index 42c0da9..b4d6e8b 100644 --- a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/lib/participoLib/participo.php +++ b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/lib/participoLib/participo.php @@ -7,6 +7,7 @@ require_once "participoLib/eventPage.php"; require_once "participoLib/starter.php"; require_once "participoLib/planer.php"; + /** * FrameWork for the participoApp */ @@ -123,7 +124,7 @@ class participo * * @retval void */ - public static function authentificate($action = "login") + public static function authenticate($action = "login") { // Ensure a session is started session_start(); @@ -147,15 +148,17 @@ class participo logLoginsToJsonFile($user->getLoginName()); // we're not logged in, but authorized for the stuff we want to do. So don't redirect return; + } else { + participo::addMessage("error", "Api key invalid (e.g., deprecated)"); } } - // if not returned yet: no login, no valid apiKey -> redirect to login page + // if not returned yet: no login, no valid apiKey -> redirect to login page but remove the api key rom the query if (!self::isLoginValid()) { header( "Location: login?returnToUrl=" . urlencode( - $_SERVER["REQUEST_URI"] . ($_POST["fragment"] ?? "") + participo::removeQueryParameter($_SERVER["REQUEST_URI"], "apiKey") . ($_POST["fragment"] ?? "") ), true, 301 @@ -164,6 +167,38 @@ class participo } } + /** + * remove query parameter from an url + * + * @param [string] $url url to clean of a query parameter + * @param [string] $param query parameter to remove + * + * @return [string] input url with query parameter (key and value) removed + */ + public static function removeQueryParameter(string $url, string $param): string + { + if (str_contains($url, "?")) { + + list($baseUrl, $urlQuery) = explode('?', $url, 2); + parse_str($urlQuery, $urlQueryArr); + unset($urlQueryArr[$param]); + + if (count($urlQueryArr)) { + return $baseUrl . '?' . http_build_query($urlQueryArr); + } + } + return $url; + } + + /** + * Store persistent data in the session data + */ + public static function shutdown(){ + $_SESSION["participo"] = [ + "messages" => participo::getMessages() + ]; + } + /** Initialize the participoApp * * - validate the login @@ -174,13 +209,33 @@ class participo */ public static function init($config) { - self::authentificate(); + // setup the storing of + register_shutdown_function("participo::shutdown"); + // set up a database connection self::initDb( $config["db"]["host"], $config["db"]["name"], $config["db"]["user"], $config["db"]["password"] ); + // authenticate the user + self::authenticate(); + + // init the participo app + // - get stored messages from the session data + self::initMessages(); + } + + /** + * Move the messages from the session data into the participo app + * + * - move means the source gets deleted after copying + */ + private static function initMessages() : void + { + self::$message = $_SESSION["participo"]["messages"] ?? ["error" => null, "success" => null, "notice" => null]; + + unset($_SESSION["participo"]["messages"]); } private static function initDb($host, $name, $user, $password) @@ -194,28 +249,28 @@ class participo * - Params in the request that aren't in given a parsing function aren't parsed and hence not returned. * * @param [array(paramName => parseFunction)] $params array of the name of the param and a sanitizer/parsing/input function - * @return array(parsedParam=>paramValue) Associative array of the name of the param and its parsed value + * @return [array(parsedParam=>paramValue)] Associative array of the name of the param and its parsed value */ public static function parseParams($params) { $method = $_SERVER["REQUEST_METHOD"]; - $request = explode("/", substr(@$_SERVER["PATH_INFO"], 1)); + // $request = explode("/", substr($_SERVER["PATH_INFO"], 1)); $parsedParams = []; foreach ($params as $paramName => $parseFunction) { $parsedParams[$paramName] = null; switch ($method) { - // case 'PUT': - // do_something_with_put($request); - // break; + // case 'PUT': + // do_something_with_put($request); + // break; case "POST": $parsedParams[$paramName] = $parseFunction( - $_POST[$paramName] + $_POST[$paramName] ?? null ); break; case "GET": $parsedParams[$paramName] = $parseFunction( - $_GET[$paramName] + $_GET[$paramName] ?? null ); break; default: @@ -236,6 +291,11 @@ class participo self::$message[$type] = (self::$message[$type] ?? "") . $message; } + // public static function htmlEchoMessages(){ + // echo(htmlRetMessage(participo::getMessages())); + // self::$message = null; + // } + /** check password for user * * @param string $loginName user who wants to get in @@ -296,9 +356,7 @@ class participo return self::hasUserAttribute($userId, "isAdmin"); } - public static function getUserId() - { - } + public static function getUserId() {} /** get current logged in users kids */ public static function getKids($userId = null) @@ -510,10 +568,10 @@ class AppCard ($this->link != null ? "" : "") . ($this->imgUrl != null ? '' . - $this->title . - '' + $this->title . + '" style="display:block;margin-left:auto;margin-right:auto;max-height:10vh;" class="responsive-img" src="' . + $this->imgUrl . + '" />' : "") . "

" . $this->description . @@ -619,7 +677,7 @@ function loadMarkdownFile($fileName) { // load the whole file $fileText = file_get_contents($fileName); - // split at '---' to get ((),yamls,array) + // split at '---' to get ((),yaml,array) $fileParts = preg_split('/[\n]*[-]{3}[\n]/', $fileText, 3); // not all mdFiles have a yamlHeader, so the mdText can be at different indices $yaml = []; diff --git a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/login.php b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/login.php index eea6f35..b17d9ca 100644 --- a/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/login.php +++ b/homepage/cwsvJudo/participo/cwsvjudo@bplaced/www/participo/login.php @@ -1,12 +1,10 @@ None: from selenium.webdriver import Firefox, FirefoxOptions - options = FirefoxOptions() - options.add_argument("-headless") - self.config = load_config() + + options = FirefoxOptions() + if self.config["settings"]["headless"]: + options.add_argument("-headless") + self.driver = Firefox(options=options) self.delay = 5 @@ -33,8 +35,20 @@ class Participo: self.driver.get(url=self.config["url"]["home"]) def load_section(self, section: str): + from urllib3.exceptions import ReadTimeoutError + section_url = "/".join((self.config["url"]["home"], section)) - self.driver.get(url=section_url) + try: + self.driver.get(url=section_url) + except ReadTimeoutError as e: + logging.warning( + "\n".join( + ( + f"TimeoutError loading {section} ({e} - {repr(e)})", + f"- Check for missing resources on section/page {section}", + ) + ) + ) def login(self): credentials = self.config["credentials"] diff --git a/homepage/cwsvJudo/participo/test/test_main.py b/homepage/cwsvJudo/participo/test/test_main.py index e578a6d..052904d 100644 --- a/homepage/cwsvJudo/participo/test/test_main.py +++ b/homepage/cwsvJudo/participo/test/test_main.py @@ -27,7 +27,7 @@ class TestParticipo(unittest.TestCase): expr=participo.check_for_xdebug_msgs(), msg=f"php errors on section {section}", ) - + if __name__ == "__main__": logging.basicConfig(level=logging.INFO)