Skip to content

type hints #343

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
simonLeary42 merged 5 commits into from
Nov 7, 2025
Merged

type hints #343

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a1d7a5a
update phpopenldaper
simonLeary42 Nov 7, 2025
852dfcc
update phpopenldaper
simonLeary42 Nov 7, 2025
1867d9b
type hints
simonLeary42 Nov 7, 2025
4f1c37d
leave return type unspecified
simonLeary42 Nov 7, 2025
014475f
fix types
simonLeary42 Nov 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions resources/lib/UnityConfig.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@

class UnityConfig
{
public static function getConfig($def_config_loc, $deploy_loc)
{
public static function getConfig(
string $def_config_loc,
string $deploy_loc,
): array {
$CONFIG = parse_ini_file(
$def_config_loc . "/config.ini.default",
true,
Expand All @@ -22,7 +24,7 @@ public static function getConfig($def_config_loc, $deploy_loc)
return $CONFIG;
}

private static function pullConfig($CONFIG, $loc)
private static function pullConfig(array $CONFIG, string $loc): array
{
$file_loc = $loc . "/config/config.ini";
if (file_exists($file_loc)) {
Expand Down
2 changes: 1 addition & 1 deletion resources/lib/UnityGithub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

class UnityGithub
{
public function getSshPublicKeys($username)
public function getSshPublicKeys(string $username): array
{
$url = "https://api.github.com/users/$username/keys";
$headers = ["User-Agent: Unity Cluster User Portal"];
Expand Down
140 changes: 76 additions & 64 deletions resources/lib/UnityGroup.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<?php

namespace UnityWebPortal\lib;
use PHPOpenLDAPer\LDAPEntry;

use Exception;

Expand All @@ -9,26 +10,24 @@
*/
class UnityGroup
{
public const PI_PREFIX = "pi_";

public $gid;
private $entry;

private $LDAP;
private $SQL;
private $MAILER;
private $WEBHOOK;
private $REDIS;

/**
* Constructor for the object
*
* @param string $gid PI UID in the format <PI_PREFIX><OWNER_UID>
* @param LDAP $LDAP LDAP Connection
* @param SQL $SQL SQL Connection
*/
public function __construct($gid, $LDAP, $SQL, $MAILER, $REDIS, $WEBHOOK)
{
public const string PI_PREFIX = "pi_";

public string $gid;
private LDAPEntry $entry;
private UnityLDAP $LDAP;
private UnitySQL $SQL;
private UnityMailer $MAILER;
private UnityWebhook $WEBHOOK;
private UnityRedis $REDIS;

public function __construct(
string $gid,
UnityLDAP $LDAP,
UnitySQL $SQL,
UnityMailer $MAILER,
UnityRedis $REDIS,
UnityWebhook $WEBHOOK,
) {
$gid = trim($gid);
$this->gid = $gid;
$this->entry = $LDAP->getPIGroupEntry($gid);
Expand All @@ -40,7 +39,7 @@ public function __construct($gid, $LDAP, $SQL, $MAILER, $REDIS, $WEBHOOK)
$this->WEBHOOK = $WEBHOOK;
}

public function equals($other_group)
public function equals(UnityGroup $other_group): bool
{
if (!is_a($other_group, self::class)) {
throw new Exception(
Expand All @@ -53,29 +52,27 @@ public function equals($other_group)
return $this->gid == $other_group->gid;
}

public function __toString()
public function __toString(): string
{
return $this->gid;
}

/**
* Checks if the current PI is an approved and existent group
*
* @return bool true if yes, false if no
*/
public function exists()
public function exists(): bool
{
return $this->entry->exists();
}

public function requestGroup(
$firstname,
$lastname,
$email,
$org,
$send_mail_to_admins,
$send_mail = true,
) {
string $firstname,
string $lastname,
string $email,
string $org,
bool $send_mail_to_admins,
bool $send_mail = true,
): void {
if ($this->exists()) {
return;
}
Expand Down Expand Up @@ -117,8 +114,10 @@ public function requestGroup(
/**
* This method will create the group (this is what is executed when an admin approved the group)
*/
public function approveGroup($operator = null, $send_mail = true)
{
public function approveGroup(
?UnityUser $operator = null,
bool $send_mail = true,
): void {
$uid = $this->getOwner()->uid;
$request = $this->SQL->getRequest($uid, UnitySQL::REQUEST_BECOME_PI);
if ($this->exists()) {
Expand Down Expand Up @@ -152,8 +151,10 @@ public function approveGroup($operator = null, $send_mail = true)
/**
* This method is executed when an admin denys the PI group request
*/
public function denyGroup($operator = null, $send_mail = true)
{
public function denyGroup(
?UnityUser $operator = null,
bool $send_mail = true,
): void {
$request = $this->SQL->getRequest(
$this->getOwner()->uid,
UnitySQL::REQUEST_BECOME_PI,
Expand All @@ -176,7 +177,7 @@ public function denyGroup($operator = null, $send_mail = true)
}
}

public function cancelGroupRequest($send_mail = true)
public function cancelGroupRequest(bool $send_mail = true): void
{
if (!$this->SQL->requestExists($this->getOwner()->uid)) {
return;
Expand All @@ -189,8 +190,10 @@ public function cancelGroupRequest($send_mail = true)
}
}

public function cancelGroupJoinRequest($user, $send_mail = true)
{
public function cancelGroupJoinRequest(
UnityUser $user,
bool $send_mail = true,
): void {
if (!$this->requestExists($user)) {
return;
}
Expand Down Expand Up @@ -245,8 +248,10 @@ public function cancelGroupJoinRequest($user, $send_mail = true)
* This method is executed when a user is approved to join the group
* (either by admin or the group owner)
*/
public function approveUser($new_user, $send_mail = true)
{
public function approveUser(
UnityUser $new_user,
bool $send_mail = true,
): void {
$request = $this->SQL->getRequest($new_user->uid, $this->gid);
if (!$new_user->exists()) {
$new_user->init(
Expand Down Expand Up @@ -277,7 +282,7 @@ public function approveUser($new_user, $send_mail = true)
}
}

public function denyUser($new_user, $send_mail = true)
public function denyUser(UnityUser $new_user, bool $send_mail = true): void
{
$request = $this->SQL->getRequest($new_user->uid, $this->gid);
// remove request, this will fail silently if the request doesn't exist
Expand All @@ -300,8 +305,10 @@ public function denyUser($new_user, $send_mail = true)
}
}

public function removeUser($new_user, $send_mail = true)
{
public function removeUser(
UnityUser $new_user,
bool $send_mail = true,
): void {
if (!$this->memberExists($new_user)) {
return;
}
Expand Down Expand Up @@ -333,13 +340,13 @@ public function removeUser($new_user, $send_mail = true)
}

public function newUserRequest(
$new_user,
$firstname,
$lastname,
$email,
$org,
$send_mail = true,
) {
UnityUser $new_user,
string $firstname,
string $lastname,
string $email,
string $org,
bool $send_mail = true,
): void {
if ($this->memberExists($new_user)) {
UnityHTTPD::errorLog(
"warning",
Expand Down Expand Up @@ -377,7 +384,7 @@ public function newUserRequest(
}
}

public function getRequests()
public function getRequests(): array
{
$requests = $this->SQL->getRequests($this->gid);
$out = [];
Expand All @@ -402,7 +409,7 @@ public function getRequests()
return $out;
}

public function getGroupMembers($ignorecache = false)
public function getGroupMembers(bool $ignorecache = false): array
{
$members = $this->getGroupMemberUIDs($ignorecache);
$out = [];
Expand All @@ -420,7 +427,7 @@ public function getGroupMembers($ignorecache = false)
return $out;
}

public function getGroupMemberUIDs($ignorecache = false)
public function getGroupMemberUIDs(bool $ignorecache = false): array
{
if (!$ignorecache) {
$cached_val = $this->REDIS->getCache($this->gid, "members");
Expand All @@ -440,7 +447,7 @@ public function getGroupMemberUIDs($ignorecache = false)
return $members;
}

public function requestExists($user)
public function requestExists(UnityUser $user): bool
{
$requesters = $this->getRequests();
if (count($requesters) > 0) {
Expand All @@ -453,7 +460,7 @@ public function requestExists($user)
return false;
}

private function init()
private function init(): void
{
$owner = $this->getOwner();
\ensure(!$this->entry->exists());
Expand All @@ -467,29 +474,34 @@ private function init()
// we need to update the cache here with the memberuid
}

private function addUserToGroup($new_user)
private function addUserToGroup(UnityUser $new_user): void
{
$this->entry->appendAttribute("memberuid", $new_user->uid);
$this->entry->write();
$this->REDIS->appendCacheArray($this->gid, "members", $new_user->uid);
$this->REDIS->appendCacheArray($new_user->uid, "groups", $this->gid);
}

private function removeUserFromGroup($old_user)
private function removeUserFromGroup(UnityUser $old_user): void
{
$this->entry->removeAttributeEntryByValue("memberuid", $old_user->uid);
$this->entry->write();
$this->REDIS->removeCacheArray($this->gid, "members", $old_user->uid);
$this->REDIS->removeCacheArray($old_user->uid, "groups", $this->gid);
}

public function memberExists($user)
public function memberExists(UnityUser $user): bool
{
return in_array($user->uid, $this->getGroupMemberUIDs());
}

private function addRequest($uid, $firstname, $lastname, $email, $org)
{
private function addRequest(
string $uid,
string $firstname,
string $lastname,
string $email,
string $org,
): void {
$this->SQL->addRequest(
$uid,
$firstname,
Expand All @@ -500,7 +512,7 @@ private function addRequest($uid, $firstname, $lastname, $email, $org)
);
}

public function getOwner()
public function getOwner(): UnityUser
{
return new UnityUser(
self::GID2OwnerUID($this->gid),
Expand All @@ -512,12 +524,12 @@ public function getOwner()
);
}

public static function ownerUID2GID($uid)
public static function ownerUID2GID(string $uid): string
{
return self::PI_PREFIX . $uid;
}

public static function GID2OwnerUID($gid)
public static function GID2OwnerUID(string $gid): string
{
if (substr($gid, 0, strlen(self::PI_PREFIX)) != self::PI_PREFIX) {
throw new Exception(
Expand Down
Loading