Inheritance diagram for ilMailAttachmentGUI:

Collaboration diagram for ilMailAttachmentGUI:

Public Member Functions
	__construct ()

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

	manage ()

	consume ()

	executeCommand ()
	Since this is a ilCtrl aware UploadHandler executeCommand MUST be implemented. More...

	saveAttachments ()

	cancelSaveAttachments ()

	deleteAttachments ()

	confirmDeleteAttachments ()

	showAttachments ()

	getInfoResult (string $identifier)

	getInfoForExistingFiles (array $file_ids)

	getFileIdentifierParameterName ()

Public Member Functions inherited from ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareUploadHandler
	__construct ()
	ilUIDemoFileUploadHandlerGUI constructor. More...

	getFileIdentifierParameterName ()

	getUploadURL ()

	getExistingFileInfoURL ()

	getFileRemovalURL ()

	executeCommand ()
	Since this is a ilCtrl aware UploadHandler executeCommand MUST be implemented. More...

	getInfoResult (string $identifier)

	getInfoForExistingFiles (array $file_ids)

	supportsChunkedUploads ()

Protected Member Functions
	getUploadResult ()

	getRemoveResult (string $identifier)

Protected Member Functions inherited from ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareUploadHandler
	readChunkedInformation ()

	getUploadResult ()

	getRemoveResult (string $identifier)

Private Member Functions
	handleTableActions ()

Private Attributes
readonly ilGlobalTemplateInterface	$tpl

readonly ilLanguage	$lng

readonly ilObjUser	$user

readonly ilFormatMail	$umail

readonly ilFileDataMail	$mfile

readonly Refinery	$refinery

readonly ILIAS UI Factory	$ui_factory

readonly ILIAS UI Renderer	$ui_renderer

readonly ilTabsGUI	$tabs

AttachmentManagement	$mode = AttachmentManagement::MANAGE

Additional Inherited Members
Data Fields inherited from ILIAS\UI\Component\Input\Field\UploadHandler
const	DEFAULT_FILE_ID_PARAMETER = 'file_id'

Protected Attributes inherited from ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareUploadHandler
const	CMD_UPLOAD = 'upload'

const	CMD_REMOVE = 'remove'

const	CMD_INFO = 'info'

HttpServices	$http

ilCtrl	$ctrl

FileUpload	$upload

bool	$is_chunked = false

int	$chunk_index = 0

int	$amount_of_chunks = 0

string	$chunk_id = null

int	$chunk_total_size = 0

Detailed Description

Definition at line 30 of file class.ilMailAttachmentGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilMailAttachmentGUI::__construct ( )

Definition at line 43 of file class.ilMailAttachmentGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         parent::__construct();
         $this->tpl = $DIC->ui()->mainTemplate();
         $this->lng = $DIC->language();
         $this->user = $DIC->user();
         $this->tabs = $DIC->tabs();
         $this->refinery = $DIC->refinery();
         $this->ui_factory = $DIC->ui()->factory();
         $this->ui_renderer = $DIC->ui()->renderer();
 
         $this->ctrl->saveParameter($this, 'mobj_id');
 
         $this->umail = new ilFormatMail($DIC->user()->getId());
         $this->mfile = new ilFileDataMail($DIC->user()->getId());
     }

Here is the call graph for this function:

Member Function Documentation

◆ cancelSaveAttachments()

ilMailAttachmentGUI::cancelSaveAttachments ( )

Definition at line 147 of file class.ilMailAttachmentGUI.php.

References ILIAS\Repository\ctrl(), and ilMailFormGUI\MAIL_FORM_TYPE_ATTACH.

                                            : void
     {
         $this->ctrl->setParameter($this, 'type', ilMailFormGUI::MAIL_FORM_TYPE_ATTACH);
         $this->ctrl->returnToParent($this);
     }

Here is the call graph for this function:

◆ confirmDeleteAttachments()

ilMailAttachmentGUI::confirmDeleteAttachments ( )

Definition at line 192 of file class.ilMailAttachmentGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and showAttachments().

                                               : void
     {
         $files = $this->http->wrapper()->post()->retrieve(
             'filename',
             $this->refinery->byTrying([
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string()),
                 $this->refinery->always([])
             ])
         );
 
         if ($files === []) {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt('mail_select_one_mail'));
             $this->showAttachments();
             return;
         }
 
         $decoded_files = [];
         foreach ($files as $value) {
             $decoded_files[] = urldecode((string) $value);
         }
 
         $error = $this->mfile->unlinkFiles($decoded_files);
         if ($error !== '') {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('mail_error_delete_file') . ' ' . $error, true);
         } else {
             $mail_data = $this->umail->retrieveFromStage();
             if (is_array($mail_data['attachments'])) {
                 $tmp = [];
                 foreach ($mail_data['attachments'] as $attachment) {
                     if (!in_array($attachment, $decoded_files, true)) {
                         $tmp[] = $attachment;
                     }
                 }
                 $this->umail->saveAttachments($tmp);
             }
 
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('mail_files_deleted'), true);
         }
 
         $this->ctrl->redirect($this);
     }

Here is the call graph for this function:

◆ consume()

ilMailAttachmentGUI::consume ( )

Definition at line 80 of file class.ilMailAttachmentGUI.php.

References ILIAS\Mail\Attachments\CONSUME.

                              : self
     {
         $this->mode = AttachmentManagement::CONSUME;
         return $this;
     }

◆ deleteAttachments()

ilMailAttachmentGUI::deleteAttachments ( )

Definition at line 153 of file class.ilMailAttachmentGUI.php.

References $filename, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilUtil\stripSlashes().

Referenced by handleTableActions().

                                        : void
     {
         $files = $this->http->wrapper()->query()->retrieve(
             'mail_attachments_filename',
             $this->refinery->byTrying([
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string()),
                 $this->refinery->always([])
             ])
         );
 
         if ($files !== [] && $files[0] === 'ALL_OBJECTS') {
             $files = array_map(static fn(array $file): string => $file['name'], $this->mfile->getUserFilesData());
         }
 
         if ($files === []) {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt('select_one'), true);
             $this->ctrl->redirect($this);
         }
 
         $this->tpl->setTitle($this->lng->txt('mail'));
 
         $confirmation = new ilConfirmationGUI();
         $confirmation->setFormAction($this->ctrl->getFormAction($this, 'confirmDeleteAttachments'));
         $confirmation->setConfirm($this->lng->txt('confirm'), 'confirmDeleteAttachments');
         $confirmation->setCancel($this->lng->txt('cancel'), 'showAttachments');
         $confirmation->setHeaderText($this->lng->txt('mail_sure_delete_file'));
 
         foreach ($files as $filename) {
             $confirmation->addItem(
                 'filename[]',
                 ilUtil::stripSlashes($filename),
                 ilUtil::stripSlashes(urldecode((string) $filename))
             );
         }
 
         $this->tpl->setContent($confirmation->getHTML());
         $this->tpl->printToStdout();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilMailAttachmentGUI::executeCommand ( )

Since this is a ilCtrl aware UploadHandler executeCommand MUST be implemented.

The Implementation MUST make sure, the Upload and the Removal Command are handled correctly

Implements ILIAS\MetaData\OERExposer\OAIPMH\Handler\ilCtrlAwareUploadHandler.

Definition at line 86 of file class.ilMailAttachmentGUI.php.

References ILIAS\Repository\ctrl().

                                     : void
     {
         if (!($cmd = $this->ctrl->getCmd())) {
             $cmd = 'showAttachments';
         }
 
         match ($cmd) {
             AbstractCtrlAwareUploadHandler::CMD_UPLOAD,
             AbstractCtrlAwareUploadHandler::CMD_INFO,
             AbstractCtrlAwareUploadHandler::CMD_REMOVE => parent::executeCommand(),
             default => $this->$cmd()
         };
     }

Here is the call graph for this function:

◆ getFileIdentifierParameterName()

ilMailAttachmentGUI::getFileIdentifierParameterName ( )

Returns: string defaults to self::DEFAULT_FILE_ID_PARAMETER

Implements ILIAS\UI\Component\Input\Field\UploadHandler.

Definition at line 369 of file class.ilMailAttachmentGUI.php.

Referenced by getUploadResult().

                                                     : string
     {
         return 'userfile';
     }

Here is the caller graph for this function:

◆ getInfoForExistingFiles()

ilMailAttachmentGUI::getInfoForExistingFiles ( array $file_ids )

Parameters

array $file_ids

Returns: BasicFileInfoResult[]

Implements ILIAS\UI\Component\Input\Field\UploadHandler.

Definition at line 364 of file class.ilMailAttachmentGUI.php.

                                                             : array
     {
         throw new DomainException('Not necessary for this handler');
     }

◆ getInfoResult()

ilMailAttachmentGUI::getInfoResult ( string $identifier )

Returns: null|FileInfoResult for the file with the given identifier or null if the file does not exist.

Implements ILIAS\UI\Component\Input\Field\UploadHandler.

Definition at line 359 of file class.ilMailAttachmentGUI.php.

                                                      : ?FileInfoResult
     {
         throw new DomainException('Not necessary for this handler');
     }

◆ getRemoveResult()

ilMailAttachmentGUI::getRemoveResult ( string $identifier )

protected

Definition at line 354 of file class.ilMailAttachmentGUI.php.

                                                           : HandlerResult
     {
         throw new DomainException('Not necessary for this handler');
     }

◆ getSafePostCommands()

ilMailAttachmentGUI::getSafePostCommands ( )

This method must return a list of safe POST commands.

Safe post commands returned by this method will no longer be CSRF protected and will NOT be appended by an ilCtrlToken.

Returns: string[]

Implements ilCtrlSecurityInterface.

Definition at line 69 of file class.ilMailAttachmentGUI.php.

                                          : array
     {
         return [];
     }

◆ getUnsafeGetCommands()

ilMailAttachmentGUI::getUnsafeGetCommands ( )

This method must return a list of unsafe GET commands.

Unsafe get commands returned by this method will now be CSRF protected, which means an ilCtrlToken is appended each time a link-target is generated to the class implementing this interface with a command from that list.

Tokens will be validated in

See also: ilCtrlInterface::getCmd(), whereas the fallback command will be used if the CSRF validation fails.

Returns: string[]

Implements ilCtrlSecurityInterface.

Definition at line 62 of file class.ilMailAttachmentGUI.php.

                                           : array
     {
         return [
             'handleTableActions',
         ];
     }

◆ getUploadResult()

ilMailAttachmentGUI::getUploadResult ( )

protected

Definition at line 334 of file class.ilMailAttachmentGUI.php.

References $message, getFileIdentifierParameterName(), ILIAS\FileUpload\DTO\UploadResult\isOK(), ILIAS\Repository\lng(), and ILIAS\Repository\upload().

                                         : HandlerResult
     {
         $this->upload->process();
         $array = $this->upload->getResults();
         $result = end($array);
 
         if ($result instanceof UploadResult && $result->isOK()) {
             $identifier = $this->mfile->storeUploadedFile($result);
             $status = HandlerResult::STATUS_OK;
             $message = $this->lng->txt('saved_successfully');
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
         } else {
             $status = HandlerResult::STATUS_FAILED;
             $identifier = '';
             $message = $result->getStatus()->getMessage();
         }
 
         return new BasicHandlerResult($this->getFileIdentifierParameterName(), $status, $identifier, $message);
     }

Here is the call graph for this function:

◆ handleTableActions()

ilMailAttachmentGUI::handleTableActions ( )

private

Definition at line 319 of file class.ilMailAttachmentGUI.php.

References ILIAS\Repository\ctrl(), deleteAttachments(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), and saveAttachments().

                                          : void
     {
         $query = $this->http->wrapper()->query();
         if (!$query->has('mail_attachments_table_action')) {
             return;
         }
 
         $action = $query->retrieve('mail_attachments_table_action', $this->refinery->to()->string());
         match ($action) {
             'saveAttachments' => $this->saveAttachments(),
             'deleteAttachments' => $this->deleteAttachments(),
             default => $this->ctrl->redirect($this),
         };
     }

Here is the call graph for this function:

◆ manage()

ilMailAttachmentGUI::manage ( )

Definition at line 74 of file class.ilMailAttachmentGUI.php.

                             : self
     {
         $this->mode = AttachmentManagement::MANAGE;
         return $this;
     }

◆ saveAttachments()

ilMailAttachmentGUI::saveAttachments ( )

Definition at line 100 of file class.ilMailAttachmentGUI.php.

References ILIAS\Repository\ctrl(), ilUtil\formatSize(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), null, ILIAS\Repository\refinery(), showAttachments(), and ILIAS\Repository\user().

Referenced by handleTableActions().

                                      : void
     {
         $files = [];
 
         // Important: Do not check for uploaded files here,
         // otherwise it is no more possible to remove files (please ignore bug reports like 10137)
 
         $size_of_affected_files = 0;
         $files_of_request = $this->http->wrapper()->query()->retrieve(
             'mail_attachments_filename',
             $this->refinery->byTrying([
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string()),
                 $this->refinery->always([])
             ])
         );
 
         if ($files_of_request !== [] && $files_of_request[0] === 'ALL_OBJECTS') {
             $files_of_request = array_map(static fn(array $file): string => $file['name'], $this->mfile->getUserFilesData());
         }
 
         foreach ($files_of_request as $file) {
             if (is_file($this->mfile->getMailPath() . '/' . basename($this->user->getId() . '_' . urldecode((string) $file)))) {
                 $files[] = urldecode((string) $file);
                 $size_of_affected_files += filesize(
                     $this->mfile->getMailPath() . '/' .
                     basename($this->user->getId() . '_' . urldecode((string) $file))
                 );
             }
         }
 
         if ($files !== [] &&
             $this->mfile->getAttachmentsTotalSizeLimit() !== null &&
             $size_of_affected_files > $this->mfile->getAttachmentsTotalSizeLimit()) {
             $this->tpl->setOnScreenMessage(
                 'failure',
                 $this->lng->txt('mail_max_size_attachments_total_error') . ' ' .
                 ilUtil::formatSize((int) $this->mfile->getAttachmentsTotalSizeLimit())
             );
             $this->showAttachments();
             return;
         }
 
         $this->umail->saveAttachments($files);
 
         $this->ctrl->returnToParent($this);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showAttachments()

ilMailAttachmentGUI::showAttachments ( )

Definition at line 234 of file class.ilMailAttachmentGUI.php.

References $components, $mode, ILIAS\Mail\Attachments\CONSUME, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

Referenced by confirmDeleteAttachments(), and saveAttachments().

                                      : void
     {
         $this->tpl->setTitle($this->lng->txt('mail'));
 
         if ($this->mode === AttachmentManagement::CONSUME) {
             $this->tabs->clearTargets();
             $this->tabs->setBackTarget(
                 $this->lng->txt('mail_manage_attachments_back_to_compose'),
                 $this->ctrl->getLinkTarget($this, 'cancelSaveAttachments')
             );
         }
 
         $components = [];
         if ($this->mode === AttachmentManagement::MANAGE) {
             $dropzone = $this->ui_factory
                 ->dropzone()
                 ->file()
                 ->standard(
                     $this->lng->txt('mail_manage_attachments'),
                     $this->lng->txt('mail_manage_attachments_drop_files_msg'),
                     '#',
                     $this->ui_factory->input()->field()->file(
                         $this,
                         $this->lng->txt('file')
                     )->withMaxFiles(42) // The answer to life, universe and the rest
                 )
                 ->withBulky(true)
                 ->withUploadButton(
                     $this->ui_factory->button()->shy(
                         $this->lng->txt('upload'),
                         '#'
                     )
                 );
             $components[] = $dropzone;
         }
 
         $mail_data = $this->umail->retrieveFromStage();
         $files = $this->mfile->getUserFilesData();
         $records = [];
         $checked_items = [];
         foreach ($files as $file) {
             if (is_array($mail_data['attachments']) && in_array($file['name'], $mail_data['attachments'], true)) {
                 $checked_items[] = urlencode($file['name']);
             }
 
             $records[] = [
                 'filename' => $file['name'],
                 'filesize' => (int) $file['size'],
                 'filecreatedate' => (int) $file['ctime'],
             ];
         }
 
         $table = new MailAttachmentTableGUI(
             $this,
             $this->user,
             $records,
             $this->ui_factory,
             $this->ui_renderer,
             $this->lng,
             $this->ctrl,
             $this->http->request(),
             new ILIAS\Data\Factory(),
             'handleTableActions',
             $this->mode
         );
         $components[] = $table->get();
 
         $this->tpl->setContent($this->ui_renderer->render($components));
 
         if ($this->mode === AttachmentManagement::CONSUME) {
             // The table above has to be rendered first, because it deselects all checkboxes
             $this->tpl->addOnLoadCode('
                 const checked_items = ' . json_encode($checked_items, JSON_THROW_ON_ERROR) . ';
                 for (const item of checked_items) {
                     const checkbox = document.querySelector("input[type=\'checkbox\'][value=\'" + item + "\']");
                     if (checkbox) {
                         checkbox.checked = true;
                     }
                 }
             ');
         }
 
         $this->tpl->printToStdout();
     }