Page MenuHomePhorge
Differential D3071 Diff 8765 src/app/SharedFolder.php

Changeset View

Standalone View

View Options

src/app/SharedFolder.php

  • This file was copied from src/app/Resource.php.
<?php <?php
mollekopfUnsubmitted
Not Done
Inline Actions

Perhaps a Resource should become a SharedFolder (via inheritance directly, or perhaps via a baseclass to avoid including the wrong traits),? Otherwise we just duplicate code.

mollekopf: Perhaps a Resource should become a SharedFolder (via inheritance directly, or perhaps via a…
namespace App; namespace App;
use App\Traits\BelongsToTenantTrait; use App\Traits\BelongsToTenantTrait;
use App\Traits\EntitleableTrait; use App\Traits\EntitleableTrait;
use App\Traits\ResourceConfigTrait; use App\Traits\SharedFolderConfigTrait;
use App\Traits\SettingsTrait; use App\Traits\SettingsTrait;
use App\Traits\UuidIntKeyTrait; use App\Traits\UuidIntKeyTrait;
use App\Wallet; use App\Wallet;
use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes; use Illuminate\Database\Eloquent\SoftDeletes;
/** /**
* The eloquent definition of a Resource. * The eloquent definition of a SharedFolder.
* *
* @property int $id The resource identifier
* @property string $email An email address * @property string $email An email address
* @property string $name The resource name * @property int $id The folder identifier
* @property int $status The resource status * @property string $name The folder name
* @property int $status The folder status
* @property int $tenant_id Tenant identifier * @property int $tenant_id Tenant identifier
* @property string $type The folder type
*/ */
class Resource extends Model class SharedFolder extends Model
{ {
use BelongsToTenantTrait; use BelongsToTenantTrait;
use EntitleableTrait; use EntitleableTrait;
use ResourceConfigTrait; use SharedFolderConfigTrait;
use SettingsTrait; use SettingsTrait;
use SoftDeletes; use SoftDeletes;
use UuidIntKeyTrait; use UuidIntKeyTrait;
// we've simply never heard of this resource // we've simply never heard of this folder
public const STATUS_NEW = 1 << 0; public const STATUS_NEW = 1 << 0;
// resource has been activated // folder has been activated
public const STATUS_ACTIVE = 1 << 1; public const STATUS_ACTIVE = 1 << 1;
// resource has been suspended. // folder has been suspended.
// public const STATUS_SUSPENDED = 1 << 2; // public const STATUS_SUSPENDED = 1 << 2;
// resource has been deleted // folder has been deleted
public const STATUS_DELETED = 1 << 3; public const STATUS_DELETED = 1 << 3;
// resource has been created in LDAP // folder has been created in LDAP
public const STATUS_LDAP_READY = 1 << 4; public const STATUS_LDAP_READY = 1 << 4;
// resource has been created in IMAP // folder has been created in IMAP
public const STATUS_IMAP_READY = 1 << 8; public const STATUS_IMAP_READY = 1 << 8;
/** @const array Supported folder type labels */
public const SUPPORTED_TYPES = ['mail', 'event', 'contact', 'task', 'note'];
/** @var array Mass-assignable properties */
protected $fillable = [ protected $fillable = [
'email', 'email',
'name', 'name',
'status', 'status',
'type',
]; ];
/** /** @var ?string Domain name for a shared folder to be created */
* @var ?string Domain name for a resource to be created */
public $domain; public $domain;
/** /**
* Assign the resource to a wallet. * Assign the folder to a wallet.
* *
* @param \App\Wallet $wallet The wallet * @param \App\Wallet $wallet The wallet
* *
* @return \App\Resource Self * @return \App\SharedFolder Self
* @throws \Exception * @throws \Exception
*/ */
public function assignToWallet(Wallet $wallet): Resource public function assignToWallet(Wallet $wallet): SharedFolder
{ {
if (empty($this->id)) { if (empty($this->id)) {
throw new \Exception("Resource not yet exists"); throw new \Exception("Shared folder not yet exists");
} }
if ($this->entitlements()->count()) { if ($this->entitlements()->count()) {
throw new \Exception("Resource already assigned to a wallet"); throw new \Exception("Shared folder already assigned to a wallet");
} }
$sku = \App\Sku::withObjectTenantContext($this)->where('title', 'resource')->first(); $sku = \App\Sku::withObjectTenantContext($this)->where('title', 'shared-folder')->first();
$exists = $wallet->entitlements()->where('sku_id', $sku->id)->count(); $exists = $wallet->entitlements()->where('sku_id', $sku->id)->count();
\App\Entitlement::create([ \App\Entitlement::create([
'wallet_id' => $wallet->id, 'wallet_id' => $wallet->id,
'sku_id' => $sku->id, 'sku_id' => $sku->id,
'cost' => $exists >= $sku->units_free ? $sku->cost : 0, 'cost' => $exists >= $sku->units_free ? $sku->cost : 0,
'fee' => $exists >= $sku->units_free ? $sku->fee : 0, 'fee' => $exists >= $sku->units_free ? $sku->fee : 0,
'entitleable_id' => $this->id, 'entitleable_id' => $this->id,
'entitleable_type' => Resource::class 'entitleable_type' => SharedFolder::class
]); ]);
return $this; return $this;
} }
/** /**
* Returns the resource domain. * Returns the shared folder domain.
* *
* @return ?\App\Domain The domain to which the resource belongs to, NULL if it does not exist * @return ?\App\Domain The domain to which the folder belongs to, NULL if it does not exist
*/ */
public function domain(): ?Domain public function domain(): ?Domain
{ {
if (isset($this->domain)) { if (isset($this->domain)) {
$domainName = $this->domain; $domainName = $this->domain;
} else { } else {
list($local, $domainName) = explode('@', $this->email); list($local, $domainName) = explode('@', $this->email);
} }
return Domain::where('namespace', $domainName)->first(); return Domain::where('namespace', $domainName)->first();
} }
/** /**
* Find whether an email address exists as a resource (including deleted resources). * Find whether an email address exists as a shared folder (including deleted folders).
* *
* @param string $email Email address * @param string $email Email address
* @param bool $return_resource Return Resource instance instead of boolean * @param bool $return_folder Return SharedFolder instance instead of boolean
* *
* @return \App\Resource|bool True or Resource model object if found, False otherwise * @return \App\SharedFolder|bool True or Resource model object if found, False otherwise
*/ */
public static function emailExists(string $email, bool $return_resource = false) public static function emailExists(string $email, bool $return_folder = false)
{ {
if (strpos($email, '@') === false) { if (strpos($email, '@') === false) {
return false; return false;
} }
$email = \strtolower($email); $email = \strtolower($email);
$resource = self::withTrashed()->where('email', $email)->first(); $folder = self::withTrashed()->where('email', $email)->first();
if ($resource) { if ($folder) {
return $return_resource ? $resource : true; return $return_folder ? $folder : true;
} }
return false; return false;
} }
/** /**
* Returns whether this resource is active. * Returns whether this folder is active.
* *
* @return bool * @return bool
*/ */
public function isActive(): bool public function isActive(): bool
{ {
return ($this->status & self::STATUS_ACTIVE) > 0; return ($this->status & self::STATUS_ACTIVE) > 0;
} }
/** /**
* Returns whether this resource is deleted. * Returns whether this folder is deleted.
* *
* @return bool * @return bool
*/ */
public function isDeleted(): bool public function isDeleted(): bool
{ {
return ($this->status & self::STATUS_DELETED) > 0; return ($this->status & self::STATUS_DELETED) > 0;
} }
/** /**
* Returns whether this resource's folder exists in IMAP. * Returns whether this folder exists in IMAP.
* *
* @return bool * @return bool
*/ */
public function isImapReady(): bool public function isImapReady(): bool
{ {
return ($this->status & self::STATUS_IMAP_READY) > 0; return ($this->status & self::STATUS_IMAP_READY) > 0;
} }
/** /**
* Returns whether this resource is registered in LDAP. * Returns whether this folder is registered in LDAP.
* *
* @return bool * @return bool
*/ */
public function isLdapReady(): bool public function isLdapReady(): bool
{ {
return ($this->status & self::STATUS_LDAP_READY) > 0; return ($this->status & self::STATUS_LDAP_READY) > 0;
} }
/** /**
* Returns whether this resource is new. * Returns whether this folder is new.
* *
* @return bool * @return bool
*/ */
public function isNew(): bool public function isNew(): bool
{ {
return ($this->status & self::STATUS_NEW) > 0; return ($this->status & self::STATUS_NEW) > 0;
} }
/** /**
* Resource status mutator * Folder status mutator
* *
* @throws \Exception * @throws \Exception
*/ */
public function setStatusAttribute($status) public function setStatusAttribute($status)
{ {
$new_status = 0; $new_status = 0;
$allowed_values = [ $allowed_values = [
self::STATUS_NEW, self::STATUS_NEW,
self::STATUS_ACTIVE, self::STATUS_ACTIVE,
self::STATUS_DELETED, self::STATUS_DELETED,
self::STATUS_IMAP_READY, self::STATUS_IMAP_READY,
self::STATUS_LDAP_READY, self::STATUS_LDAP_READY,
]; ];
foreach ($allowed_values as $value) { foreach ($allowed_values as $value) {
if ($status & $value) { if ($status & $value) {
$new_status |= $value; $new_status |= $value;
$status ^= $value; $status ^= $value;
} }
} }
if ($status > 0) { if ($status > 0) {
throw new \Exception("Invalid resource status: {$status}"); throw new \Exception("Invalid shared folder status: {$status}");
} }
$this->attributes['status'] = $new_status; $this->attributes['status'] = $new_status;
} }
/**
* Folder type mutator
*
* @throws \Exception
*/
public function setTypeAttribute($type)
{
if (!in_array($type, self::SUPPORTED_TYPES)) {
throw new \Exception("Invalid shared folder type: {$type}");
}
$this->attributes['type'] = $type;
}
} }