getURL(), getHyperlink() (#385)

Author: simonLeary42

defaults/config.ini.default

@@ -8,7 +8,7 @@ repo = "https://github.com/UnityHPC/unity-web-portal"  ; Upstream URL for the we
 [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
+url = "http://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/assets/branding folder
 terms_of_service_url = "https://github.com" ; this can be external or a portal page created with "content management"

resources/lib/UnityHTTPD.php

@@ -42,8 +42,7 @@ public static function die(mixed $x = null, bool $show_user = false): never
     */
     public static function redirect(?string $dest = null): never
     {
-        $dest ??= pathJoin(CONFIG["site"]["prefix"], $_SERVER["REQUEST_URI"]);
-        $dest = htmlspecialchars($dest);
+        $dest ??= getURL($_SERVER["REQUEST_URI"]);
         header("Location: $dest");
         http_response_code(302);
         if (CONFIG["site"]["enable_redirect_message"]) {

resources/lib/UnityMailer.php

@@ -13,7 +13,6 @@ class UnityMailer extends PHPMailer
     private string $template_dir = __DIR__ . "/../mail"; // location of all email templates
     private string $override_template_dir = __DIR__ . "/../../deployment/mail_overrides";
 
-    private string $MSG_LINKREF;
     private string $MSG_SENDER_EMAIL;
     private string $MSG_SENDER_NAME;
     private string $MSG_SUPPORT_EMAIL;
@@ -28,7 +27,6 @@ public function __construct()
         parent::__construct();
         $this->isSMTP();
 
-        $this->MSG_LINKREF = CONFIG["site"]["url"] . CONFIG["site"]["prefix"];
         $this->MSG_SENDER_EMAIL = CONFIG["mail"]["sender"];
         $this->MSG_SENDER_NAME = CONFIG["mail"]["sender_name"];
         $this->MSG_SUPPORT_EMAIL = CONFIG["mail"]["support"];

resources/lib/UnityWebhook.php

@@ -7,13 +7,8 @@ class UnityWebhook
     private string $template_dir = __DIR__ . "/../mail";
     private string $override_template_dir = __DIR__ . "/../../deployment/mail_overrides";
     private string $url = CONFIG["webhook"]["url"];
-    private string $MSG_LINKREF;
     private string $Subject; // set by template
 
-    public function __construct()
-    {
-        $this->MSG_LINKREF = CONFIG["site"]["url"] . CONFIG["site"]["prefix"];
-    }
     public function htmlToMarkdown(string $html): string
     {
         // Define regex patterns for each markdown format

resources/lib/utils.php

@@ -72,13 +72,27 @@ function mbDetectEncoding(string $string, ?array $encodings = null, mixed $_ = n
 }
 
 /* https://stackoverflow.com/a/15575293/18696276 */
-function pathJoin()
+function pathNormalize(string $path)
 {
-    $paths = [];
-    foreach (func_get_args() as $arg) {
-        if ($arg !== "") {
-            $paths[] = $arg;
-        }
+    return preg_replace("#/+#", "/", $path);
+}
+
+function getURL(...$relative_url_components)
+{
+    if (!preg_match("#^\w+://#", CONFIG["site"]["url"])) {
+        throw new RuntimeException('CONFIG[site][url] does not have a scheme! (ex: "https://")');
     }
-    return preg_replace("#/+#", "/", join("/", $paths));
+    $matches = [];
+    preg_match("#(^\w+://)(.*)#", CONFIG["site"]["url"], $matches);
+    [$_, $site_url_scheme, $site_url_noscheme] = $matches;
+    $path = join("/", [$site_url_noscheme, CONFIG["site"]["prefix"], ...$relative_url_components]);
+    $path_normalized = pathNormalize($path);
+    return $site_url_scheme . $path_normalized;
+}
+
+function getHyperlink($text, ...$url_components)
+{
+    $text = htmlspecialchars($text);
+    $url = getURL(...$url_components);
+    return "<a href='$url'>$text</a>";
 }

resources/mail/footer.php

@@ -3,7 +3,7 @@
 >
   <span>
     You are receiving this email because you have an account
-    on the <a target='_blank' href='<?php echo $this->MSG_LINKREF; ?>'>Unity Cluster</a>.
+    on the <?php echo getHyperlink("Unity Cluster", "/"); ?>.
     If you would like to stop receiving these emails,
     you may request to close your account by replying to this email.
   </span>

resources/mail/group_created.php

@@ -8,7 +8,7 @@
 <p>
 Your request for a PI account on the Unity cluster has been approved.
 You can access the management page for your group
-<a href="<?php echo $this->MSG_LINKREF; ?>/panel/pi.php">on this page</a>.
+<?php echo getHyperlink("on this page", "panel/pi.php"); ?>.
 </p>
 
 <p>Do not hesitate to reply if you have any questions!</p>

resources/mail/group_request_admin.php

@@ -19,6 +19,6 @@
 
 <p>
 You can approve this account
-<a href="<?php echo $this->MSG_LINKREF; ?>/admin/pi-mgmt.php">here</a>
+<?php echo getHyperlink("here", "admin/pi-mgmt.php"); ?>
 .
 </p>

resources/mail/group_user_added.php

@@ -6,7 +6,7 @@
 <p>Hello,</p>
 
 <p>You have been approved to join the PI group <?php echo $data["group"]; ?>.
-Navigate to the <a href="<?php echo $this->MSG_LINKREF; ?>/panel/groups.php">my groups</a>
+Navigate to the <?php echo getHyperlink("my groups", "panel/groups.php"); ?>
 page to see your PI groups.</p>
 
 <p>If you believe this to be a mistake, please reply to this email as soon as possible.</p>

resources/mail/group_user_request_owner.php

@@ -22,4 +22,4 @@
 </p>
 
 <p>You can approve or deny this user on the
-    <a href="<?php echo $this->MSG_LINKREF; ?>/panel/pi.php">my users</a> page</p>
+    <?php echo getHyperlink("my users", "panel/pi.php"); ?> page</p>