Skip to content
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

Jump to bottom

Allow custom storage disk & config for attachment storage #65

Merged
merged 2 commits into from
Jun 18, 2024
Merged

Allow custom storage disk & config for attachment storage #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79e5d9a
Allow custom storage disk & config for attachment storage
Jun 18, 2024
a8069ee
Update README.md
RickDBCN Jun 18, 2024
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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@ return [
10, 25, 50, 'all',
],

'attachments_disk' => 'local',
'store_attachments' => true,

//Use this option for customize tenant model class
//'tenant_model' => \App\Models\Team::class,
];
Expand Down
3 changes: 3 additions & 0 deletions config/filament-email.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@
10, 25, 50, 'all',
],

'attachments_disk' => 'local',
'store_attachments' => true,

//Use this option for customize tenant model class
//'tenant_model' => \App\Models\Team::class,
];
43 changes: 22 additions & 21 deletions src/Filament/Resources/EmailResource.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ public static function form(Form $form): Form
->label(__('filament-email::filament-email.created_at')),
])->columns(4),
Fieldset::make('attachments')
->hidden(fn(): bool => !config('filament-email.store_attachments'))
->label(__('filament-email::filament-email.attachments'))
->schema([
View::make('filament-email::attachments')
Expand Down Expand Up @@ -136,7 +137,7 @@ public static function table(Table $table): Table
->icon('heroicon-o-eye')
->iconSize(IconSize::Medium)
->modalFooterActions(
fn ($action): array => [
fn($action): array => [
$action->getModalCancelAction(),
])
->fillForm(function ($record) {
Expand Down Expand Up @@ -193,29 +194,29 @@ public static function table(Table $table): Table
->nestedRecursiveRules([
'email',
])
->default(fn ($record): array => ! empty($record->to) ? explode(',', $record->to) : [])
->default(fn($record): array => !empty($record->to) ? explode(',', $record->to) : [])
->required(),
TagsInput::make('cc')
->label(__('filament-email::filament-email.cc'))
->placeholder(__('filament-email::filament-email.insert_multiple_email_placelholder'))
->nestedRecursiveRules([
'email',
])
->default(fn ($record): array => ! empty($record->cc) ? explode(',', $record->cc) : []),
->default(fn($record): array => !empty($record->cc) ? explode(',', $record->cc) : []),
TagsInput::make('bcc')
->label(__('filament-email::filament-email.bcc'))
->placeholder(__('filament-email::filament-email.insert_multiple_email_placelholder'))
->nestedRecursiveRules([
'email',
])
->default(fn ($record): array => ! empty($record->bcc) ? explode(',', $record->bcc) : []),
->default(fn($record): array => !empty($record->bcc) ? explode(',', $record->bcc) : []),
Toggle::make('attachments')
->label(__('filament-email::filament-email.add_attachments'))
->onColor('success')
->offColor('danger')
->inline(false)
->disabled(fn ($record): bool => empty($record->attachments))
->default(fn ($record): bool => ! empty($record->attachments))
->disabled(fn($record): bool => empty($record->attachments))
->default(fn($record): bool => !empty($record->attachments))
->required(),
])
->action(function (Email $record, array $data) {
Expand All @@ -242,10 +243,10 @@ public static function table(Table $table): Table
])
->columns([
TextColumn::make('from')
->prefix(__('filament-email::filament-email.from').': ')
->suffix(fn (Email $record): string => ! empty($record->attachments) ? ' ('.trans_choice('filament-email::filament-email.attachments_number', count($record->attachments)).')' : '')
->prefix(__('filament-email::filament-email.from') . ': ')
->suffix(fn(Email $record): string => !empty($record->attachments) ? ' (' . trans_choice('filament-email::filament-email.attachments_number', count($record->attachments)) . ')' : '')
->label(__('filament-email::filament-email.header'))
->description(fn (Email $record): string => Str::limit(__('filament-email::filament-email.to').': '.$record->to, 40))
->description(fn(Email $record): string => Str::limit(__('filament-email::filament-email.to') . ': ' . $record->to, 40))
->searchable(),
TextColumn::make('subject')
->label(__('filament-email::filament-email.subject'))
Expand Down Expand Up @@ -292,16 +293,16 @@ public static function table(Table $table): Table
$indicators = [];
$format = config('filament-email.resource.filter_date_format');

if (! empty($data['created_from'])) {
if (!empty($data['created_from'])) {
$from = Carbon::parse($data['created_from'])->format($format);
$indicators['created'] = __('filament-email::filament-email.from_filter')." $from";
$indicators['created'] = __('filament-email::filament-email.from_filter') . " $from";
}

if (! empty($data['created_until'])) {
if (!empty($data['created_until'])) {
$to = Carbon::parse($data['created_until'])->format($format);
$toText = __('filament-email::filament-email.to_filter');
if (! empty($indicators['created'])) {
$indicators['created'] .= ' '.strtolower($toText)." $to";
if (!empty($indicators['created'])) {
$indicators['created'] .= ' ' . strtolower($toText) . " $to";
} else {
$indicators['created'] = "$toText $to";
}
Expand All @@ -323,30 +324,30 @@ public static function table(Table $table): Table
return $query
->when(
$data['to'],
fn (Builder $query, $value): Builder => $query->where('to', 'like', "%$value%"),
fn(Builder $query, $value): Builder => $query->where('to', 'like', "%$value%"),
)
->when(
$data['cc'],
fn (Builder $query, $value): Builder => $query->where('cc', 'like', "%$value%"),
fn(Builder $query, $value): Builder => $query->where('cc', 'like', "%$value%"),
)
->when(
$data['bcc'],
fn (Builder $query, $value): Builder => $query->where('bcc', 'like', "%$value%"),
fn(Builder $query, $value): Builder => $query->where('bcc', 'like', "%$value%"),
)
->when(
$data['created_from'],
fn (Builder $query, $value): Builder => $query->where('created_at', '>=', $value),
fn(Builder $query, $value): Builder => $query->where('created_at', '>=', $value),
)
->when(
$data['created_until'],
fn (Builder $query, $value): Builder => $query->where('created_at', '<=', $value),
fn(Builder $query, $value): Builder => $query->where('created_at', '<=', $value),
);
}),
])
->paginationPageOptions(function (Table $table) {
$options = config('filament-email.pagination_page_options');

return ! empty($options) && is_array($options) ? $options : $table->getPaginationPageOptions();
return !empty($options) && is_array($options) ? $options : $table->getPaginationPageOptions();
});
}

Expand All @@ -362,7 +363,7 @@ public static function canAccess(): bool
{
$roles = config('filament-email.can_access.role', []);

if (method_exists(auth()->user(), 'hasRole') && ! empty($roles)) {
if (method_exists(auth()->user(), 'hasRole') && !empty($roles)) {
return auth()->user()->hasRole($roles);
}

Expand Down
6 changes: 3 additions & 3 deletions src/Filament/Resources/EmailResource/Pages/ViewEmail.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ public function downloadAction(): Action
->icon('heroicon-c-arrow-down-tray')
->size(ActionSize::ExtraSmall)
->action(function (array $arguments) {
$filePath = storage_path('app'.DIRECTORY_SEPARATOR.$arguments['path']);
if (file_exists($filePath)) {
return Storage::download($arguments['path'], $arguments['name']);
$fileExists = Storage::disk(config('filament-email.attachments_disk'))->exists($arguments['path']);
if ($fileExists) {
return Storage::disk(config('filament-email.attachments_disk'))->download($arguments['path'], $arguments['name']);
} else {
Notification::make()
->title(__('filament-email::filament-email.download_attachment_error'))
Expand Down
40 changes: 24 additions & 16 deletions src/Listeners/FilamentEmailLogger.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,27 +27,35 @@ public function handle(object $event): void
$rawMessage = $event->sent->getSymfonySentMessage();
$email = $event->message;

$attachmentsDisk = config('filament-email.attachments_disk', 'local');
$storeAttachments = config('filament-email.store_attachments', true);

$model = config('filament-email.resource.model') ?? Email::class;

$attachments = [];
$savePath = 'filament-email-log'.DIRECTORY_SEPARATOR.date('YmdHis').'_'.Str::random(5).DIRECTORY_SEPARATOR;
$savePath = 'filament-email-log' . DIRECTORY_SEPARATOR . date('YmdHis') . '_' . Str::random(5) . DIRECTORY_SEPARATOR;

foreach ($event->message->getAttachments() as $attachment) {
$filePath = $savePath.Str::random(5).'_'.$attachment->getFilename();
Storage::disk('local')
->put($filePath, $attachment->getBody());
$attachments[] = [
'name' => $attachment->getFilename(),
'contentType' => $attachment->getContentType(),
'path' => $filePath,
];
}
if ($storeAttachments) {

$savePathRaw = $savePath.$rawMessage->getMessageId().'.eml';
foreach ($event->message->getAttachments() as $attachment) {
$filePath = $savePath . Str::random(5) . '_' . $attachment->getFilename();
Storage::disk($attachmentsDisk)
->put($filePath, $attachment->getBody());
$attachments[] = [
'name' => $attachment->getFilename(),
'contentType' => $attachment->getContentType(),
'path' => $filePath,
];
}

Storage::disk('local')
->put($savePathRaw, $rawMessage->getMessage()->toString());
$savePathRaw = $savePath . $rawMessage->getMessageId() . '.eml';

Storage::disk($attachmentsDisk)
->put($savePathRaw, $rawMessage->getMessage()->toString());

} else {
$savePathRaw = null;
}
$model::create([
'team_id' => Filament::getTenant()?->id ?? null,
'from' => $this->recipientsToString($email->getFrom()),
Expand All @@ -59,7 +67,7 @@ public function handle(object $event): void
'text_body' => $email->getTextBody(),
'raw_body' => $savePathRaw,
'sent_debug_info' => $rawMessage->getDebug(),
'attachments' => ! empty($attachments) ? $attachments : null,
'attachments' => !empty($attachments) ? $attachments : null,
]);

}
Expand All @@ -69,7 +77,7 @@ private function recipientsToString(array $recipients): string
return implode(
',',
array_map(function ($email) {
return "{$email->getAddress()}".($email->getName() ? " <{$email->getName()}>" : '');
return "{$email->getAddress()}" . ($email->getName() ? " <{$email->getName()}>" : '');
}, $recipients)
);
}
Expand Down