Compare commits

..

No commits in common. "main" and "v0.2.1" have entirely different histories.
main ... v0.2.1

11 changed files with 29 additions and 145 deletions

View File

@ -12,7 +12,7 @@ steps:
environment: environment:
COMPOSER_CACHE_DIR: /tmp/cache COMPOSER_CACHE_DIR: /tmp/cache
commands: commands:
- composer install --no-progress --no-interaction --ignore-platform-reqs - composer install --no-progress --no-interaction
- name: run unit tests - name: run unit tests
image: php:7.4 image: php:7.4

View File

@ -99,7 +99,7 @@ open-coverage:
# Create VERSION file from current git tag # Create VERSION file from current git tag
version: version:
git describe --tags | tee VERSION git describe | tee VERSION
# Clean up # Clean up

View File

@ -27,10 +27,6 @@ a:hover, a:focus {
text-decoration: underline; text-decoration: underline;
} }
.monospace {
font-family: monospace;
}
.gray { .gray {
color: gray; color: gray;
} }
@ -252,6 +248,7 @@ details > summary {
details > p { details > p {
margin: 0.75rem 1rem; margin: 0.75rem 1rem;
font-family: monospace;
} }
/* -- Detail columns -- */ /* -- Detail columns -- */

View File

@ -35,12 +35,11 @@ CREATE TABLE `mail_users`
CREATE TABLE `mail_aliases` CREATE TABLE `mail_aliases`
( (
`alias_id` int(10) unsigned NOT NULL AUTO_INCREMENT, `alias_id` int(10) unsigned NOT NULL AUTO_INCREMENT,
`user_id` int(10) unsigned NOT NULL, `user_id` int(10) unsigned NOT NULL,
`mail_address` varchar(255) NOT NULL, `mail_address` varchar(255) NOT NULL,
`wildcard_priority` smallint(6) NOT NULL DEFAULT 0, `created_at` datetime NOT NULL DEFAULT NOW(),
`created_at` datetime NOT NULL DEFAULT NOW(), `modified_at` datetime NOT NULL DEFAULT NOW(),
`modified_at` datetime NOT NULL DEFAULT NOW(),
PRIMARY KEY (`alias_id`), PRIMARY KEY (`alias_id`),
UNIQUE KEY `mail_address` (`mail_address`), UNIQUE KEY `mail_address` (`mail_address`),
KEY `user_id` (`user_id`), KEY `user_id` (`user_id`),

View File

@ -44,42 +44,25 @@ abstract class FormData
// Input validation - Application specific validators // Input validation - Application specific validators
private static function validateMailAddress(string $address, bool $required = true, string $fieldName = 'Mail address'): ?string protected static function validateUsername(string $username, bool $required = true, string $fieldName = 'Username'): ?string
{ {
// Note: This validator allows '%' as wildcard character inside mail addresses. if (!$required && $username === '') {
if (!$required && $address === '') {
return null; return null;
} }
$address = strtolower( $username = strtolower(
self::validateString($address, 3, 100, $fieldName) self::validateString($username, 3, 100, $fieldName)
); );
if (!preg_match('/^[a-z0-9%._+-]+@[a-z0-9%.-]+$/', $address) || preg_match('/^\\.|\\.\\.|\\.@|@\\.|\\.$/', $address)) { if (!preg_match('/^[a-z0-9._+-]+@[a-z0-9.-]+$/', $username) || preg_match('/^\\.|\\.\\.|\\.@|@\\.|\\.$/', $username)) {
throw new InputValidationError("$fieldName is not valid (must be a valid mail address)."); throw new InputValidationError("$fieldName is not valid (must be a valid mail address).");
} }
return $address;
}
protected static function validateUsername(string $username, bool $required = true): ?string
{
$username = self::validateMailAddress($username, $required, 'Username');
if ($username !== null && strpos($username, '%') !== false) {
throw new InputValidationError('Username must not contain the wildcard character "%" (use a wildcard alias instead).');
}
return $username; return $username;
} }
protected static function validateAliasAddress(string $aliasAddress, bool $isWildcard): string protected static function validateAliasAddress(string $aliasAddress): string
{ {
$aliasAddress = self::validateMailAddress($aliasAddress, true, 'Alias address'); return self::validateUsername($aliasAddress, true, 'Alias address');
// Check if the address contains a wildcard character
if (!$isWildcard && strpos($aliasAddress, '%') !== false) {
throw new InputValidationError('Non-wildcard alias address must not contain "%" character.');
}
return $aliasAddress;
} }
protected static function validatePassword(string $password, string $passwordRepeat, bool $required = true): ?string protected static function validatePassword(string $password, string $passwordRepeat, bool $required = true): ?string

View File

@ -4,34 +4,20 @@ declare(strict_types=1);
namespace MailAccountAdmin\Frontend\Accounts; namespace MailAccountAdmin\Frontend\Accounts;
use MailAccountAdmin\Common\FormData; use MailAccountAdmin\Common\FormData;
use MailAccountAdmin\Exceptions\InputValidationError;
class AccountAddAliasData extends FormData class AccountAddAliasData extends FormData
{ {
private string $aliasAddress; private string $aliasAddress;
private bool $isWildcard;
private int $wildcardPriority;
private function __construct(string $aliasAddress, bool $isWildcard, int $wildcardPriority) private function __construct(string $aliasAddress)
{ {
if ($isWildcard && $wildcardPriority === 0) {
throw new InputValidationError('Wildcard alias must have a wildcard priority other than 0.');
} elseif (!$isWildcard) {
$wildcardPriority = 0;
}
$this->aliasAddress = $aliasAddress; $this->aliasAddress = $aliasAddress;
$this->isWildcard = $isWildcard;
$this->wildcardPriority = $wildcardPriority;
} }
public static function createFromArray(array $raw): self public static function createFromArray(array $raw): self
{ {
$isWildcard = self::validateBoolOption(trim($raw['is_wildcard'] ?? ''));
return new self( return new self(
self::validateAliasAddress(trim($raw['alias_address'] ?? ''), $isWildcard), self::validateAliasAddress(trim($raw['alias_address'] ?? '')),
$isWildcard,
self::validateInteger(trim($raw['wildcard_priority'] ?? '')),
); );
} }
@ -39,14 +25,4 @@ class AccountAddAliasData extends FormData
{ {
return $this->aliasAddress; return $this->aliasAddress;
} }
public function isWildcard(): bool
{
return $this->isWildcard;
}
public function getWildcardPriority(): int
{
return $this->wildcardPriority;
}
} }

View File

@ -278,22 +278,14 @@ class AccountHandler
// Check if account exists // Check if account exists
$this->ensureAccountExists($accountId); $this->ensureAccountExists($accountId);
$unescapedAddress = $address = $aliasAddData->getAliasAddress();
$wildcardPriority = 0;
if ($aliasAddData->isWildcard()) {
// If it's a wildcard alias, escape underscores
$address = str_replace('_', '\\_', $address);
$wildcardPriority = $aliasAddData->getWildcardPriority();
}
// Check if alias address is still available // Check if alias address is still available
$address = $aliasAddData->getAliasAddress();
if (!$this->accountRepository->checkUsernameAvailable($address) || !$this->aliasRepository->checkAliasAvailable($address)) { if (!$this->accountRepository->checkUsernameAvailable($address) || !$this->aliasRepository->checkAliasAvailable($address)) {
throw new InputValidationError("Alias address \"$unescapedAddress\" is not available."); throw new InputValidationError("Alias address \"$address\" is not available.");
} }
// Create alias in database // Create alias in database
$this->aliasRepository->createNewAlias($accountId, $address, $wildcardPriority); $this->aliasRepository->createNewAlias($accountId, $address);
} }

View File

@ -10,23 +10,14 @@ class Alias
private int $id; private int $id;
private int $userId; private int $userId;
private string $mailAddress; private string $mailAddress;
private int $wildcardPriority;
private DateTimeImmutable $createdAt; private DateTimeImmutable $createdAt;
private DateTimeImmutable $modifiedAt; private DateTimeImmutable $modifiedAt;
private function __construct( private function __construct(int $id, int $userId, string $mailAddress, DateTimeImmutable $createdAt, DateTimeImmutable $modifiedAt)
int $id,
int $userId,
string $mailAddress,
int $wildcardPriority,
DateTimeImmutable $createdAt,
DateTimeImmutable $modifiedAt
)
{ {
$this->id = $id; $this->id = $id;
$this->userId = $userId; $this->userId = $userId;
$this->mailAddress = $mailAddress; $this->mailAddress = $mailAddress;
$this->wildcardPriority = $wildcardPriority;
$this->createdAt = $createdAt; $this->createdAt = $createdAt;
$this->modifiedAt = $modifiedAt; $this->modifiedAt = $modifiedAt;
} }
@ -37,7 +28,6 @@ class Alias
(int)$data['alias_id'], (int)$data['alias_id'],
(int)$data['user_id'], (int)$data['user_id'],
$data['mail_address'], $data['mail_address'],
(int)$data['wildcard_priority'],
new DateTimeImmutable($data['created_at']), new DateTimeImmutable($data['created_at']),
new DateTimeImmutable($data['modified_at']), new DateTimeImmutable($data['modified_at']),
); );
@ -53,24 +43,11 @@ class Alias
return $this->userId; return $this->userId;
} }
public function getMailAddress(bool $unescape = true): string public function getMailAddress(): string
{ {
if ($this->isWildcard() && $unescape) {
return str_replace('\\_', '_', $this->mailAddress);
}
return $this->mailAddress; return $this->mailAddress;
} }
public function isWildcard(): bool
{
return $this->wildcardPriority !== 0;
}
public function getWildcardPriority(): int
{
return $this->wildcardPriority;
}
public function getCreatedAt(): DateTimeImmutable public function getCreatedAt(): DateTimeImmutable
{ {
return $this->createdAt; return $this->createdAt;

View File

@ -11,11 +11,11 @@ class AliasRepository extends BaseRepository
{ {
public function fetchAliasesForUserId(int $userId): array public function fetchAliasesForUserId(int $userId): array
{ {
$statement = $this->pdo->prepare('SELECT * FROM mail_aliases WHERE user_id = :user_id ORDER BY wildcard_priority, mail_address'); $statement = $this->pdo->prepare('SELECT * FROM mail_aliases WHERE user_id = :user_id ORDER BY mail_address');
$statement->execute(['user_id' => $userId]); $statement->execute(['user_id' => $userId]);
$rows = $statement->fetchAll(PDO::FETCH_ASSOC); $rows = $statement->fetchAll(PDO::FETCH_ASSOC);
// Create Alias models from rows // Create Account models from rows
$aliasList = []; $aliasList = [];
foreach ($rows as $row) { foreach ($rows as $row) {
$aliasList[] = Alias::createFromArray($row); $aliasList[] = Alias::createFromArray($row);
@ -43,20 +43,12 @@ class AliasRepository extends BaseRepository
return $statement->rowCount() === 0; return $statement->rowCount() === 0;
} }
public function createNewAlias(int $userId, string $mailAddress, int $wildcardPriority = 0): void public function createNewAlias(int $userId, string $mailAddress): void
{ {
$query = ' $statement = $this->pdo->prepare('INSERT INTO mail_aliases (user_id, mail_address) VALUES (:user_id, :mail_address)');
INSERT INTO mail_aliases
(user_id, mail_address, wildcard_priority)
VALUES
(:user_id, :mail_address, :wildcard_priority)
';
$statement = $this->pdo->prepare($query);
$statement->execute([ $statement->execute([
'user_id' => $userId, 'user_id' => $userId,
'mail_address' => $mailAddress, 'mail_address' => $mailAddress,
'wildcard_priority' => $wildcardPriority,
]); ]);
} }

View File

@ -24,7 +24,7 @@
</p> </p>
<details> <details>
<summary>Show list of known domains</summary> <summary>Show list of known domains</summary>
<p class="monospace">{{ domainList ? domainList | join(', ') : 'No domains exist yet.' }}</p> <p>{{ domainList ? domainList | join(', ') : 'No domains exist yet.' }}</p>
</details> </details>
<table> <table>
<tr> <tr>

View File

@ -71,21 +71,13 @@
<table class="bordered_table"> <table class="bordered_table">
<tr> <tr>
<th></th> <th></th>
<th style="min-width: 16em">Address</th> <th>Address</th>
<th>Wildcard (priority)</th>
<th>Created at</th> <th>Created at</th>
</tr> </tr>
{% for alias in aliases %} {% for alias in aliases %}
<tr> <tr>
<td><input type="checkbox" id="delete_selected_{{ alias.getId() }}" name="selected_aliases[]" value="{{ alias.getId() }}"/></td> <td><input type="checkbox" id="delete_selected_{{ alias.getId() }}" name="selected_aliases[]" value="{{ alias.getId() }}"/></td>
<td><label for="delete_selected_{{ alias.getId() }}">{{ alias.getMailAddress() }}</label></td> <td><label for="delete_selected_{{ alias.getId() }}">{{ alias.getMailAddress() }}</label></td>
<td>
{% if alias.isWildcard() %}
Yes ({{ alias.getWildcardPriority() }})
{% else %}
<span class="gray">No</span>
{% endif %}
</td>
<td>{{ alias.getCreatedAt() | date }}</td> <td>{{ alias.getCreatedAt() | date }}</td>
</tr> </tr>
{% endfor %} {% endfor %}
@ -103,18 +95,7 @@
<tr> <tr>
<td><label for="add_alias_address">New alias:</label></td> <td><label for="add_alias_address">New alias:</label></td>
<td> <td>
<input id="add_alias_address" name="alias_address" value="{{ formData['alias_address'] | default('') }}" {{ success is defined or error is defined ? 'autofocus': '' }}/> <input id="add_alias_address" name="alias_address" value="{{ formData['new_alias'] | default('') }}" {{ success is defined or error is defined ? 'autofocus': '' }}/>
</td>
</tr>
<tr>
<td style="vertical-align: top">Wildcard:</td>
<td style="vertical-align: top">
<label>
<input type="checkbox" name="is_wildcard" {{ formData is defined and formData['is_wildcard'] | default() ? 'checked' : '' }}/>
Create wildcard alias,
</label>
<label for="add_alias_wildcard_priority">priority:</label>
<input type="number" id="add_alias_wildcard_priority" name="wildcard_priority" value="{{ formData['wildcard_priority'] | default('1') }}" style="width: 6em"/>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -123,18 +104,5 @@
</td> </td>
</tr> </tr>
</table> </table>
<details>
<summary>How to define wildcard aliases?</summary>
<p>
Wildcard aliases use <code>%</code> as a placeholder for any amount of characters (zero or more),
e.g. <code>%@example.com</code> or <code>example-%@example.com</code>.
</p>
<p>
Additionally, a <b>wildcard priority</b> must be specified. When a mail address is looked up that
matches multiple (wildcard) aliases, the alias with the <b>lowest</b> wildcard priority will be used.
The priority must not be 0 (internally, the value 0 stands for regular non-wildcard aliases).
</p>
</details>
</form> </form>
{% endblock %} {% endblock %}