Merge branch 'main' into community-labels

.phpenv

@@ -9,6 +9,16 @@
 
 	include_once "$PROJECT_ROOT/php/utils/logging.php";
 
+	// Read the -v|--verbose option increasing logging verbosity to debug.
+	$options = getopt("v", ["verbose", "fast"]);
+	if (isset($options["v"]) or isset($options["verbose"])) {
+		$LOGGING_VERBOSITY = LoggingVerbosity::Debug;
+	}
+
+	if (isset($options["fast"])) {
+		$FAST_FETCH_MODE = true;
+	}
+
 	// set timeout for file_get_contents()
 	ini_set('default_socket_timeout', 6); // in seconds, default is 60
 

Makefile

@@ -1,5 +1,7 @@
-port = 8081
-output = output
+PORT ?= 8081
+OUTPUT ?= output
+FLAGS ?=
+MAKE = make FLAGS=$(FLAGS)
 
 # First goal is the default with `make`.
 
@@ -14,54 +16,54 @@ all: fetch html
 
 # Fetch room listing.
 fetch:
-	/bin/php php/fetch-servers.php
-
-# Fetch room listing with extra verbosity.
-fetch-v:
-	/bin/php php/fetch-servers.php --verbose
+	/bin/php php/fetch-servers.php $(FLAGS)
 
 # Generate HTML from data.
 html:
-	/bin/php php/generate-html.php
-
-# Last item run in foreground to receive interrupts.
+	/bin/php php/generate-html.php $(FLAGS)
 
 # Serve a local copy which responds to file changes.
+dev: FLAGS = --verbose
 dev: open
-	make server &
-	make watchdog
+	$(MAKE) server &
+	$(MAKE) watchdog
+
+# (Last item run in foreground to receive interrupts.)
 
 # Serve a local copy on LAN which responds to file changes.
+lan-dev: FLAGS = --verbose
 lan-dev: open
-	ip addr | fgrep -e ' 192.' -e ' 10.'
-	make lan-server &
-	make watchdog
+	-which ip 1>/dev/null 2>/dev/null && ip addr | fgrep -e ' 192.' -e ' 10.' || true
+	$(MAKE) lan-server &
+	$(MAKE) watchdog
 
 # Serve a local copy.
 server:
-	/bin/php -S localhost:$(port) -t $(output)
+	/bin/php -S "localhost:$(PORT)" -t "$(OUTPUT)"
 
 # Serve a local copy on all interfaces.
 lan-server:
-	/bin/php -S 0.0.0.0:$(port) -t $(output)
+	/bin/php -S "0.0.0.0:$(PORT)" -t "$(OUTPUT)"
 
 # Open locally served page in browser.
 open:
-	xdg-open http://localhost:$(port) >/dev/null 2>/dev/null & disown
+	xdg-open "http://localhost:$(PORT)" >/dev/null 2>/dev/null & disown
 
 # Update HTML on file change. Doesn't check for new files.
 watchdog:
-	find . | entr -n -s "make html"
+	find . | grep -v ".git" | entr -n -s "$(MAKE) html"
 
 # Remove artefacts
 clean:
-	-rm -r cache
-	-rm -r output/*.html
+	-rm -r cache 2>/dev/null || true
+	-rm -r output/*.html 2>/dev/null || true
 
 # Build everything from scratch and test functionality.
+test: FLAGS = --verbose
 test: clean all open server
 
 # Build everything from scratch and test functionality on LAN.
+test-lan: FLAGS = --verbose
 test-lan: clean all open lan-server
 
 # -- Aliases --

output/styles2.css

@@ -58,7 +58,6 @@ html.js .noscript, .hidden {
 }
 
 html:not(.js) .js-only {
-	/* Dead style */
 	display: none;
 }
 
@@ -322,7 +321,7 @@ footer {
 	max-width: 100%;
 	text-align: center;
 
-	padding-top: var(--body-margin);
+	padding-bottom: var(--body-margin);
 	padding-inline: var(--body-margin);
 }
 

php/fetch-servers.php

@@ -10,8 +10,6 @@
 	// Not required
 	include_once "$LANGUAGES_ROOT/language_flags.php";
 
-	$FAST_FETCH_MODE = false;
-
 	/**
 	 * Fetch online Communities and write the resulting data to disk.
 	 * Communities are fetched as follows:
@@ -24,18 +22,6 @@
 	 * 6. De-dupe servers based on pubkey
 	 */
 	function main() {
-		global $LOGGING_VERBOSITY, $FAST_FETCH_MODE;
-
-		// Read the -v|--verbose option increasing logging verbosity to debug.
-		$options = getopt("v", ["verbose", "fast"]);
-		if (isset($options["v"]) or isset($options["verbose"])) {
-			$LOGGING_VERBOSITY = LoggingVerbosity::Debug;
-		}
-
-		if (isset($options["fast"])) {
-			$FAST_FETCH_MODE = true;
-		}
-
 		global $CACHE_ROOT, $ROOMS_FILE, $KNOWN_SERVERS, $KNOWN_PUBKEYS;
 
 		// Create default directories with conservative permissions.

php/generate-html.php

@@ -15,6 +15,11 @@
 		return $files;
 	}
 
+	function generate_html() {
+		global $LOGGING_VERBOSITY, $TEMPLATES_ROOT, $DOCUMENT_ROOT;
+
+		$flags = LoggingVerbosity::getVerbosityFlags($LOGGING_VERBOSITY)[1];
+
 		foreach (rglob("$TEMPLATES_ROOT/*.php") as $phppath) {
 			// Do not render auxiliary PHP files.
 			if (str_contains("$phppath", "/+") || $phppath[0] == "+")
@@ -31,10 +36,13 @@
 
 			// Same as shell_exec, except we don't have to escape quotes.
 			log_info("Generating output for $relpath.");
-		$document = `cd "$TEMPLATES_ROOT"; php $phppath`;
+			$document = `cd "$TEMPLATES_ROOT"; php $phppath $flags`;
 
 			file_put_contents($docpath, $document);
 		}
 
 		log_info("Done generating HTML.");
+	}
+
+	generate_html();
 ?>

php/utils/logging.php

@@ -44,7 +44,7 @@
 
 		/**
 		 * Returns the color marker for the given logging verbosity.
-		 * @param $verbosity Logging verbosity to used for printing.
+		 * @param int $verbosity Logging verbosity to used for printing.
 		 * @return ?string Terminal escape sequence to color foreground text.
 		 */
 		static function getVerbosityColorMarker(int $verbosity): ?string {
@@ -56,6 +56,18 @@
 				default => ''
 			};
 		}
+
+		/**
+		 * Returns a pair of optíons trigerring the given verbosity.
+		 * @param int $verbosity Logging verbosity to set using flag.
+		 * @return string[] Pair of short and long command-line verbosity flags.
+		 */
+		static function getVerbosityFlags(int $verbosity): array {
+			return match($verbosity) {
+				LoggingVerbosity::Debug => ["-v", "--verbose"],
+				default => ['', '']
+			};
+		}
 	}
 
 	/**
@@ -135,12 +147,12 @@
 	 * Only logs when `$LOGGING_VERBOSITY` is debug and below.
 	 * @param string $msg String message to log.
 	 */
-	function log_value(mixed $value) {
-		log_debug(var_export($value, true));
+	function log_value(mixed $value, int $message_verbosity = LoggingVerbosity::Debug) {
+		_log_message(var_export($value, true), $message_verbosity);
 	}
 
 	/**
-	 * @var $LOGGING_VERBOSITY
+	 * @var int $LOGGING_VERBOSITY
 	 * Global setting.
 	 * Controls how detailed the displayed logs are.
 	 */

php/utils/servers-rooms.php

@@ -1,9 +1,13 @@
 <?php
-
 	include_once "$PROJECT_ROOT/languages/language_flags.php";
 
 	include_once "$PROJECT_ROOT/php/servers/known-servers.php";
 
+	$MINUTE_SECONDS = 60;
+	$HOUR_SECONDS = 60 * $MINUTE_SECONDS;
+	$DAY_SECONDS = 24 * $HOUR_SECONDS;
+	$WEEK_SECONDS = 7 * $DAY_SECONDS;
+
 	/**
 	 * Representation of Session Community room.
 	 */
@@ -132,6 +136,33 @@
 			}, $details);
 		}
 
+		/**
+		 * Sorts Community rooms in-place by the given string property.
+		 * @param \CommunityRoom[] $rooms Rooms to sort by given key.
+		 * @param string $key String property of CommunityRoom to sort by.
+		 */
+		public static function sort_rooms_str(array &$rooms, string $key) {
+			usort($rooms, function(\CommunityRoom $a, \CommunityRoom $b) use ($key) {
+				return strcmp(
+					$a->$key,
+					$b->$key
+				);
+			});
+		}
+
+		/**
+		 * Sorts Community rooms in-place by their server's public key.
+		 * @param \CommunityRoom[] $rooms Rooms to sort by server pubkey.
+		 */
+		public static function sort_rooms_by_pubkey(array &$rooms) {
+			usort($rooms, function(\CommunityRoom $a, \CommunityRoom $b) {
+				return strcmp(
+					$a->server->get_pubkey(),
+					$b->server->get_pubkey()
+				);
+			});
+		}
+
 		/**
 		 * Returns array of staff Session IDs.
 		 * @return string[]
@@ -149,6 +180,32 @@
 			return time() - $this->created;
 		}
 
+		/**
+		 * Formats the period over which active users are counted as a duration string.
+		 * @return string Active user cutoff period for this room, expressed in days.
+		 */
+		function format_user_cutoff_period(): ?string {
+			global $WEEK_SECONDS, $DAY_SECONDS, $HOUR_SECONDS, $MINUTE_SECONDS;
+
+			$active_users_cutoff = $this->active_users_cutoff;
+
+			if ($active_users_cutoff >= $WEEK_SECONDS) {
+				return floor($active_users_cutoff / $WEEK_SECONDS) . ' week(s)';
+			}
+			if ($active_users_cutoff >= $DAY_SECONDS) {
+				return floor($active_users_cutoff / $DAY_SECONDS) . ' day(s)';
+			}
+			if ($active_users_cutoff >= $HOUR_SECONDS) {
+				return floor($active_users_cutoff / $HOUR_SECONDS) . ' hour(s)';
+			}
+			if ($active_users_cutoff >= $MINUTE_SECONDS) {
+				return floor($active_users_cutoff / $MINUTE_SECONDS) . 'minute(s)';
+			}
+
+			return floor($active_users_cutoff) . 's';
+			
+		}
+
 		/**
 		 * Return the browser preview URL for this room.
 		 */

sites/+components/tbl_communities.php

@@ -9,15 +9,15 @@
 	// Once handlers are attached in JS, this check ceases to be useful.
 	function column_sortable($id) {
 		// Join URL contents are not guaranteed to have visible text.
-		return $id != "qr" && $id != "preview" && $id != "join_url";
+		return $id != "qr_code" && $id != "preview" && $id != "join_url";
 	}
 
 	function sort_onclick($colno) {
 		global $TABLE_COLUMNS;
 		$column = $TABLE_COLUMNS[$colno];
 		$name = isset($column['name_long']) ? $column['name_long'] : $column['name'];
-		if (!column_sortable($column['id'])) return " title='Column: $name'";
-		return " title='Click to sort by $name'";
+		if (!column_sortable($column['id'])) return " title='$name'";
+		return " title='Click to sort by $name'.";
 	}
 
 	// Note: Changing the names displayed requires updating
@@ -28,11 +28,11 @@
 		['id' => "language", 'name' => "L", 'name_long' => "Language"],
 		['id' => "name", 'name' => "Name"],
 		['id' => "description", 'name' => "About", 'name_long' => "Description"],
-		['id' => "users", 'name' => "#", 'name_long' => "Weekly Active Users"],
+		['id' => "users", 'name' => "#", 'name_long' => "Active Users"],
 		['id' => "preview", 'name' => "Preview"],
-		['id' => "qr_code", 'name' => "QR"],
+		['id' => "qr_code", 'name' => "QR", 'name_long' => "QR Code (for use in-app)"],
 		['id' => "server_icon", 'name' => "Host", 'name_long' => "Server host"],
-		['id' => "join_url", 'name' => "URL", 'name_long' => "In-app Join URL"],
+		['id' => "join_url", 'name' => "URL", 'name_long' => "Join URL (for use in-app)"],
 	];
 ?>
 
@@ -58,6 +58,7 @@
 		$name = html_sanitize($room->name);
 		$desc = html_sanitize($room->description);
 		$users = html_sanitize($room->active_users);
+		$users_cutoff = html_sanitize($room->format_user_cutoff_period());
 		$preview_link = html_sanitize($room->get_preview_url());
 		$join_link = html_sanitize($room->get_join_url());
 		$pubkey = html_sanitize($pubkey);
@@ -70,15 +71,16 @@
 		data-hostname="<?=$hostname?>"
 	>
 		<td class="td_identifier" itemprop="identifier"><?=$id?></td>
-		<td class="td_language"><?=$language?></td>
+		<td class="td_language" title="Language flag for '<?=$name?>'"><?=$language?></td>
 		<td class="td_name"
+			title="Click here to preview '<?=$name?>'"
 			data-sort-by="<?=strtolower($name)?>"
 			itemprop="name"
 		>
 			<a
-				href="<?=$room->get_preview_url()?>"
+				href="<?=$preview_link?>"
 				target="_blank"
-				title="'<?=$room->name?>' preview"
+				title="'<?=$name?>' preview"
 				rel="noopener noreferrer"
 			><?=
 				$name
@@ -94,10 +96,24 @@
 <?php endforeach; ?>
 			</span>
 		</td>
-		<td class="td_description" itemprop="description"><?=$desc?></td>
-		<td class="td_users"><?=$users?></td>
+		<td
+			class="td_description"
+			title="Description for '<?=$name?>':
+
+<?=$desc?>"
+			itemprop="description"
+		><?=$desc?></td>
+		<td
+			class="td_users"
+			title="'<?=$name?>' has had <?=$users?> active users in the last <?=$users_cutoff?>."
+		><?=$users?></td>
 		<td class="td_preview" itemprop="url">
-			<a href="<?=$preview_link?>" target="_blank" rel="noopener noreferrer nofollow">
+			<a 
+				href="<?=$preview_link?>" 
+				title="Click here to preview '<?=$name?>'" 
+				target="_blank" 
+				rel="noopener noreferrer nofollow"
+			>
 				<span class="protocol-indicator"></span>
 			</a>
 		</td>
@@ -106,11 +122,12 @@
 				class="qr-code-icon"
 				src="qrcode-solid.svg"
 				alt="Pictogram of a QR code"
+				title="Click here to view the QR Code for '<?=$name?>'"
 			>
 		</td>
 		<td class="td_server_icon"
 			data-sort-by="<?=$pubkey?>"
-			title="<?=$hostname?> (<?=$pubkey?>)"
+			title="Host: <?=$hostname?> (<?=$pubkey?>)"
 			item="image"
 		>
 			<div class="td_server_icon-circle" style="background-color: <?=$icon_color?>">
@@ -121,7 +138,11 @@
 			<div class="join_url_container" data-url="<?=$join_link?>">
 				<a class="join_url show-from-w5" title="<?=$join_link?>"
 					><?=truncate($join_link, 32)?></a>
-				<a class="noscript" href="<?=$join_link?>" rel="external nofollow"
+				<a
+					class="noscript"
+					title="Copy this link to join '<?=$name?>'."
+					href="<?=$join_link?>"
+					rel="external nofollow"
 				>Copy link</a>
 			</div>
 		</td>

sites/index.php

@@ -16,6 +16,10 @@
 	// List all rooms from the cached servers.
 	$rooms = CommunityServer::enumerate_rooms($servers);
 
+	// Sort rooms by name and then host.
+	CommunityRoom::sort_rooms_str($rooms, 'name');
+	CommunityRoom::sort_rooms_by_pubkey($rooms);
+
 	// Set the last-updated timestamp
 	// to the time the server data file was last modified.
 	$timestamp = filemtime($ROOMS_FILE);
@@ -92,9 +96,15 @@
 						target="_blank"
 					>various sources</a>.
 					<br>
+					<span class="js-only">
 						We make an attempt to hide communities containing
 						objectionable or illegal content, but
 						you should still proceed with caution.
+					</span>	
+					<span class="noscript">
+						Proceed with caution when joining unofficial communities.
+						As JavaScript is disabled, no communities are filtered from the list.
+					</span>			
 			</p>
 			<p class="noscript">
 				This site works fine without JavaScript.