gravel
/
sessioncommunities.online
mirror of https://codeberg.org/gravel/sessioncommunities.online
1
0
Fork 0
Code Issues 2 Packages Projects Releases Wiki Activity

refactor: standalone listings parsing

Browse Source
dev
gravel 2 years ago
parent a74cbf6e38
commit e76827c6e1
Signed by: gravel
GPG Key ID: C0538F3C906B308F
2 changed files with 129 additions and 108 deletions
Show Stats Download Patch File Download Diff File

111
php/generate-listings.php
Unescape Escape View File

@ -7,121 +7,16 @@
require_once "getenv.php";
require_once "utils/logging.php";
require_once "servers/servers-rooms.php";
/**
* Represents a Community listing in the Listing Provider API.
*/
class CommunityListing implements JsonSerializable {
/**
* @var string $id
* Unique listing identifier.
*/
public readonly string $id;
/**
* @var string $name
* Human-readable listing name.
*/
public readonly string $name;
/**
* @var string $rating
* One-word content rating for Communities listed.
*/
public readonly string $rating;
/**
* @var CommunityRoom[] $rooms
* Communities included in the listing.
*/
public readonly array $rooms;
/**
* Create a new CommunityListing instance with the given parameters.
* @param string $id Unique listing identifier.
* @param string $name Human-readable listing name.
* @param string $rating One-word content rating for Communities listed.
* @param CommunityRoom[] $rooms Communities included in the listing.
*/
public function __construct(string $id, string $name, ?string $rating, array $rooms) {
$this->id = $id;
$this->name = $name;
$this->rating = $rating ?? "unknown";
$this->rooms = $rooms;
}
/**
* Produce associative listing data for JSON serialization.
*/
public function jsonSerialize(): mixed {
// TODO: Careful serialization
$details = get_object_vars($this);
$details['rooms'] = array_map(function(CommunityRoom $room){
return $room->to_listing_data();
}, $this->rooms);
return $details;
}
/**
* Produce associative data summarizing this listing.
*/
public function to_summary(): array {
return array(
'id' => $this->id,
'name' => $this->name,
'rating' => $this->rating,
'rooms' => count($this->rooms)
);
}
}
/**
* Construct Community listings from listing configuration and cached Communities.
* @return CommunityListing[]
* \todo Refactor
*/
function resolve_listings_config(): array {
global $LISTINGS_INI, $ROOMS_FILE;
$listings_raw = parse_ini_file($LISTINGS_INI, process_sections: true, scanner_mode: INI_SCANNER_RAW);
$servers_raw = file_get_contents($ROOMS_FILE);
$server_data = json_decode($servers_raw, true);
$servers = CommunityServer::from_details_array($server_data);
$rooms_all = CommunityServer::enumerate_rooms($servers);
$listings = [];
foreach ($listings_raw as $id => $listing_props) {
$filter = [...($listing_props['rooms'] ?? []), ...($listing_props['sogs'] ?? [])];
$matchees = [];
$rooms = CommunityRoom::select_rooms($rooms_all, $filter, $matchees);
foreach ($filter as $filter_item) {
if (!in_array($filter_item, $matchees)) {
log_warning("Could not find $filter_item from listing $id.");
}
}
$rooms = array_filter($rooms, function(CommunityRoom $room) {
return !$room->is_off_record();
});
$listings[] = new CommunityListing(
$id,
$listing_props['name'],
$listing_props['rating'],
$rooms
);
}
return $listings;
}
require_once "servers/room-listings-api.php";
/**
* Resolve and write configured Community listings to disk.
*/
function generate_listings() {
global $LISTING_PROVIDER_LISTING_SUMMARY, $LISTING_PROVIDER_LISTINGS;
global $LISTING_PROVIDER_LISTING_SUMMARY, $LISTING_PROVIDER_LISTINGS, $LISTINGS_INI;
log_info("Generating listings...");
$listings_resolved = resolve_listings_config();
$listings_resolved = CommunityListingDatabase::resolve_listings_from_ini($LISTINGS_INI)->get_all();
$summaries = array_map(function(CommunityListing $listing) {
return $listing->to_summary();
}, $listings_resolved);

126
php/servers/room-listings-api.php
Unescape Escape View File

@ -0,0 +1,126 @@
<?php
class CommunityListingDatabase {
private array $listings;
private function __construct(array $listings) {
$this->listings = $listings;
}
/**
* Construct Community listings from listing configuration and cached Communities.
*/
public static function resolve_listings_from_ini(string $listings_ini, array $servers = null): CommunityListingDatabase {
global $ROOMS_FILE;
$listings_raw = parse_ini_file($listings_ini, process_sections: true, scanner_mode: INI_SCANNER_RAW);
if ($servers == null) {
$servers_raw = file_get_contents($ROOMS_FILE);
$server_data = json_decode($servers_raw, true);
$servers = CommunityServer::from_details_array($server_data);
}
$rooms_all = CommunityServer::enumerate_rooms($servers);
$listings = [];
foreach ($listings_raw as $id => $listing_props) {
$filter = [...($listing_props['rooms'] ?? []), ...($listing_props['sogs'] ?? [])];
$matchees = [];
$rooms = CommunityRoom::select_rooms($rooms_all, $filter, $matchees);
foreach ($filter as $filter_item) {
if (!in_array($filter_item, $matchees)) {
log_warning("Could not find $filter_item from listing $id.");
}
}
$rooms = array_filter($rooms, function(CommunityRoom $room) {
return !$room->is_off_record();
});
$listings[$id] = new CommunityListing(
$id,
$listing_props['name'],
$listing_props['rating'],
$rooms
);
}
return new CommunityListingDatabase($listings);
}
/**
* @return CommunityListing[]
*/
public function get_all(): array {
return array_values($this->listings);
}
public function get_listing(string $id): CommunityListing {
return $this->listings[$id];
}
}
/**
* Represents a Community listing in the Listing Provider API.
*/
class CommunityListing implements JsonSerializable {
/**
* @var string $id
* Unique listing identifier.
*/
public readonly string $id;
/**
* @var string $name
* Human-readable listing name.
*/
public readonly string $name;
/**
* @var string $rating
* One-word content rating for Communities listed.
*/
public readonly string $rating;
/**
* @var CommunityRoom[] $rooms
* Communities included in the listing.
*/
public readonly array $rooms;
/**
* Create a new CommunityListing instance with the given parameters.
* @param string $id Unique listing identifier.
* @param string $name Human-readable listing name.
* @param string $rating One-word content rating for Communities listed.
* @param CommunityRoom[] $rooms Communities included in the listing.
*/
public function __construct(string $id, string $name, ?string $rating, array $rooms) {
$this->id = $id;
$this->name = $name;
$this->rating = $rating ?? "unknown";
$this->rooms = $rooms;
}
/**
* Produce associative listing data for JSON serialization.
*/
public function jsonSerialize(): mixed {
// TODO: Careful serialization
$details = get_object_vars($this);
$details['rooms'] = array_map(function(CommunityRoom $room){
return $room->to_listing_data();
}, $this->rooms);
return $details;
}
/**
* Produce associative data summarizing this listing.
*/
public function to_summary(): array {
return array(
'id' => $this->id,
'name' => $this->name,
'rating' => $this->rating,
'rooms' => count($this->rooms)
);
}
}
?>
Write Preview
Loading…
Cancel
Save