Merge pull request #61 from hakasapl/main

1.1.1 Patch to add Redis Support

Author: hakasapl

Diff for: .gitignore

@@ -13,4 +13,6 @@ vendor
 composer.lock
 
 # don't track site configs
-config/**/*.ini
+deployment/*
+!deployment/**/README.md
+!deployment/deploy.sh

Diff for: CHANGELOG.md

@@ -1,3 +1,13 @@
+# 1.1.1
+
+2023-3-15
+
+* [Feature] Added Redis support for caching
+* [Feature] Added new deployment folder
+* [Feature] Added workers folder with flush cache script
+* [Dev] Added many more test users
+* [Bug] Fixes admin page styles
+
 # 1.1.0
 
 2023-3-13

Diff for: README.md

@@ -23,6 +23,10 @@ Unity Web Portal is a PHP application built in top of MariaDB and LDAP which act
     1. PHP Extensions
         1. `php-ldap`
         2. `php-curl`
+        3. `php-redis`
+        4. `php-cli`
+        5. `php-mysql`
+        6. `php-pdo`
 2. Composer packages
     1. `cd` to this repository
     2. Install packages `composer update`
@@ -43,7 +47,7 @@ The update process is similar to the installation process:
 1. Clone the release and follow installation instructions 1 and 2 from above.
 2. Copy the following folders from the old installation to the new one:
     1. `config`
-    2. `webroot/res/footer_logos`
+    2. `webroot/assets/footer_logos`
 
 We recommend a deployment where each version of the portal is its own clone, then just change a symlink to point to the new version. This way a rollback is much easier.
 

Diff for: config/branding/overrides/unity.uri.edu.ini.example

@@ -1,11 +1,46 @@
-; Branding Defaults
-; DO NOT EDIT THIS FILE. Instead make a config.ini in the same location as this file
+; Config file for Site
+; DO NOT EDIT THIS FILE. Instead make a config.ini file in the config folder.
 ;
+[upstream]
+version = "1.1.1"  ; Current upstream version of the web portal
+repo = "https://github.com/UnityHPC/unity-web-portal"  ; Upstream URL for the web portal
+
 [site]
+prefix = ""  ; prefix of website, no ending / should be included
 name = "Unity Cluster"  ; Name of the website
 url = "https://127.0.0.1:8000/"  ; URL of the website
 description = "The Unity Web Portal is a lightweight HPC cluster front-end"  ; Description of the website
-logo = "logo.png"  ; path to logo file, in the webroot/res/branding folder
+logo = "logo.png"  ; path to logo file, in the webroot/assets/branding folder
+
+[ldap]
+uri = "ldap://identity"  ; URI of remote LDAP server
+user = "cn=admin,dc=unityhpc,dc=test"  ; Admin bind DN LDAP user
+pass = "password"  ; Admin bind password
+basedn = "dc=unityhpc,dc=test"  ; Base search DN
+user_ou = "ou=users,dc=unityhpc,dc=test"  ; User organizational unit
+group_ou = "ou=groups,dc=unityhpc,dc=test"  ; Group organizational unit
+pigroup_ou = "ou=pi_groups,dc=unityhpc,dc=test"  ; PI Group organizational unit
+orggroup_ou = "ou=org_groups,dc=unityhpc,dc=test"  ; ORG group organizational unit
+admin_group = "cn=sudo,dc=unityhpc,dc=test"  ; admin dn (members of this group are admins on the web portal)
+def_user_shell = "/bin/bash"  ; Default shell for new users
+
+[sql]
+host = "sql"  ; mariadb hostname
+user = "unity"  ; mariadb username
+pass = "password"  ; mariadb password
+dbname = "unity"  ; mariadb database name
+
+[smtp]
+host = "smtp"  ; hostname of remote smtp server
+port = "1025"  ; port of remote smtp server
+security = ""  ; leave blank for no encryption, "ssl", or "tls"
+user = ""  ; smtp username, if exists
+pass = ""  ; smtp password, if exists
+ssl_verify = "false"  ; set to true to verify ssl certificates
+
+[redis]
+host = "redis"
+port = "6379"
 
 [colors]
 light_background = "#ffffff"  ; Background color when in light mode

Diff for: config/config.ini.default

@@ -0,0 +1,5 @@
+# Config
+
+In this folder only one file can be created at this time: `config.ini`.
+
+In this file you can override any of the config from the default file in `defaults/config.ini.default`. **Every deployment needs this**

Diff for: config/branding/config.ini.default renamed to defaults/config.ini.default

@@ -0,0 +1,13 @@
+# Overrides
+
+In this location you can make folders which have the hostname of the portal.
+
+For example, if the primary virtual host is `example.com`, but you wanted to host `example.org` as well, create an `example.org` folder in this location and structure it like the main deployment folder is structured. For now, you can override the following:
+
+```
+<override_hostname>
+    config
+        config.ini
+```
+
+Everything else in the deployment folder cannot be overridden.

Diff for: deployment/config/README.md

@@ -16,7 +16,8 @@
 require_once __DIR__ . "/lib/UnityMailer.php";
 require_once __DIR__ . "/lib/UnitySSO.php";
 require_once __DIR__ . "/lib/UnitySite.php";
-require_once __DIR__ . "/lib/UnityBranding.php";
+require_once __DIR__ . "/lib/UnityConfig.php";
+require_once __DIR__ . "/lib/UnityRedis.php";
 
 // run init script
 require __DIR__ . "/init.php";

Diff for: config/custom_user_mappings/README renamed to deployment/custom_user_mappings/README.md

@@ -5,13 +5,13 @@
  */
 
 use UnityWebPortal\lib\{
-    UnityBranding,
-    UnitySite,
+    UnityConfig,
     UnityLDAP,
     UnityMailer,
     UnitySQL,
     UnitySSO,
-    UnityUser
+    UnityUser,
+    UnityRedis
 };
 
 //
@@ -22,19 +22,24 @@
 //
 // Config INIT
 //
-$CONFIG = UnitySite::getConfig(__DIR__ . "/../config");
-$BRANDING = UnityBranding::getBranding(__DIR__ . "/../config/branding");
+$CONFIG = UnityConfig::getConfig(__DIR__ . "/../defaults", __DIR__ . "/../deployment");
 
 //
 // Service Init
 //
 
+// Creates REDIS service
+$REDIS = new UnityRedis(
+    $CONFIG["redis"]["host"],
+    $CONFIG["redis"]["port"]
+);
+
 // Creates LDAP service
 $LDAP = new UnityLDAP(
     $CONFIG["ldap"]["uri"],
     $CONFIG["ldap"]["user"],
     $CONFIG["ldap"]["pass"],
-    __DIR__ . "/../config/custom_user_mappings",
+    __DIR__ . "/../deployment/custom_user_mappings",
     $CONFIG["ldap"]["user_ou"],
     $CONFIG["ldap"]["group_ou"],
     $CONFIG["ldap"]["pigroup_ou"],
@@ -54,22 +59,22 @@
 // Creates SMTP service
 $MAILER = new UnityMailer(
     __DIR__ . "/mail",
-    __DIR__ . "/../config/mail_overrides",
+    __DIR__ . "/../deployment/mail_overrides",
     $CONFIG["smtp"]["host"],
     $CONFIG["smtp"]["port"],
     $CONFIG["smtp"]["security"],
     $CONFIG["smtp"]["user"],
     $CONFIG["smtp"]["pass"],
     $CONFIG["smtp"]["ssl_verify"],
-    $BRANDING["site"]["url"] . $CONFIG["site"]["prefix"],
-    $BRANDING["mail"]["sender"],
-    $BRANDING["mail"]["sender_name"],
-    $BRANDING["mail"]["support"],
-    $BRANDING["mail"]["support_name"],
-    $BRANDING["mail"]["admin"],
-    $BRANDING["mail"]["admin_name"],
-    $BRANDING["mail"]["pi_approve"],
-    $BRANDING["mail"]["pi_approve_name"]
+    $CONFIG["site"]["url"] . $CONFIG["site"]["prefix"],
+    $CONFIG["mail"]["sender"],
+    $CONFIG["mail"]["sender_name"],
+    $CONFIG["mail"]["support"],
+    $CONFIG["mail"]["support_name"],
+    $CONFIG["mail"]["admin"],
+    $CONFIG["mail"]["admin_name"],
+    $CONFIG["mail"]["pi_approve"],
+    $CONFIG["mail"]["pi_approve_name"]
 );
 
 //
@@ -81,24 +86,23 @@
     // SSO is available
     $_SESSION["SSO"] = $SSO;
 
-// add sso login entry to mysql table
-    $SQL->addSSOEntry(
-        $SSO["user"],
-        $SSO["org"],
-        $SSO["firstname"],
-        $SSO["lastname"],
-        $SSO["mail"]
-    );
-
-    $USER = new UnityUser($SSO["user"], $LDAP, $SQL, $MAILER);
+    $USER = new UnityUser($SSO["user"], $LDAP, $SQL, $MAILER, $REDIS);
     $_SESSION["is_admin"] = $USER->isAdmin();
 
     if (isset($_SESSION["viewUser"]) && $_SESSION["is_admin"]) {
-        $USER = new UnityUser($_SESSION["viewUser"], $LDAP, $SQL, $MAILER);
+        $USER = new UnityUser($_SESSION["viewUser"], $LDAP, $SQL, $MAILER, $REDIS);
     }
 
     $_SESSION["user_exists"] = $USER->exists();
     $_SESSION["is_pi"] = $USER->isPI();
+
+    if (!$_SESSION["user_exists"]) {
+        // populate cache
+        $REDIS->setCache($SSO["user"], "org", $SSO["org"]);
+        $REDIS->setCache($SSO["user"], "firstname", $SSO["firstname"]);
+        $REDIS->setCache($SSO["user"], "lastname", $SSO["lastname"]);
+        $REDIS->setCache($SSO["user"], "mail", $SSO["mail"]);
+    }
 }
 
 //

Diff for: config/mail_overrides/README renamed to deployment/mail_overrides/README.md

@@ -0,0 +1,36 @@
+<?php
+
+namespace UnityWebPortal\lib;
+
+class UnityConfig
+{
+    public static function getConfig($def_config_loc, $deploy_loc)
+    {
+        // Loading branding
+        $CONFIG = parse_ini_file($def_config_loc . "/config.ini.default", true);
+
+        $CONFIG = self::pullConfig($CONFIG, $deploy_loc);
+
+        // URL-based override
+        if (array_key_exists("HTTP_HOST", $_SERVER)) {
+            $cur_url = $_SERVER['HTTP_HOST'];
+            $url_override_path = $deploy_loc . "/overrides/" . $cur_url;
+            if (is_dir($url_override_path)) {
+                $CONFIG = self::pullConfig($CONFIG, $url_override_path);
+            }
+        }
+
+        return $CONFIG;
+    }
+
+    private static function pullConfig($CONFIG, $loc)
+    {
+        $file_loc = $loc . "/config/config.ini";
+        if (file_exists(($file_loc))) {
+            $CONFIG_override = parse_ini_file($file_loc, true);
+            return array_replace_recursive($CONFIG, $CONFIG_override);
+        } else {
+            return $CONFIG;
+        }
+    }
+}