ilMailAttachmentGUI Class Reference

Inheritance diagram for ilMailAttachmentGUI:

Collaboration diagram for ilMailAttachmentGUI:

Public Member Functions
	__construct ()
	ilUIDemoFileUploadHandlerGUI constructor. More...
	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...
	getInfoResult (string $identifier)
	getInfoForExistingFiles (array $file_ids)
	getFileIdentifierParameterName ()
	@inheritDoc More...
Public Member Functions inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler
	__construct ()
	ilUIDemoFileUploadHandlerGUI constructor. More...
	getFileIdentifierParameterName ()
	@inheritDoc More...
	getUploadURL ()
	@inheritDoc More...
	getExistingFileInfoURL ()
	@inheritDoc More...
	getFileRemovalURL ()
	@inheritDoc More...
	executeCommand ()
	Since this is a ilCtrl aware UploadHandler executeCommand MUST be implemented. More...
	getInfoResult (string $identifier)
	getInfoForExistingFiles (array $file_ids)
	supportsChunkedUploads ()
	executeCommand ()
	Since this is a ilCtrl aware UploadHandler executeCommand MUST be implemented. More...
	getFileIdentifierParameterName ()
	getUploadURL ()
	getFileRemovalURL ()
	getExistingFileInfoURL ()
	getInfoForExistingFiles (array $file_ids)
	getInfoResult (string $identifier)
	supportsChunkedUploads ()
	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...
	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

Protected Member Functions
	getUploadResult ()
	getRemoveResult (string $identifier)
Protected Member Functions inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler
	readChunkedInformation ()
	getUploadResult ()
	getRemoveResult (string $identifier)

Private Member Functions
	saveAttachments ()
	cancelSaveAttachmentsCommand ()
	confirmDeleteAttachments ()
	deleteAttachmentsCommand ()
	showAttachmentsCommand ()
	handleTableActionsCommand ()

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'
Data Fields inherited from ILIAS\Mail\Attachments\MailAttachmentCommands
const string	CMD_SHOW_ATTACHMENTS = 'showAttachments'
const string	CMD_CANCEL_SAVE_ATTACHMENTS = 'cancelSaveAttachments'
const string	CMD_DELETE_ATTACHMENTS = 'deleteAttachments'
const string	CMD_HANDLE_TABLE_ACTIONS = 'handleTableActions'
const string	DEFAULT_CMD = self::CMD_SHOW_ATTACHMENTS
const string	TABLE_CONFIRM_DELETE_ATTACHMENTS = 'confirmDeleteAttachments'
const string	TABLE_ACTION_SAVE_ATTACHMENTS = 'saveAttachments'
Protected Attributes inherited from ILIAS\FileUpload\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 31 of file class.ilMailAttachmentGUI.php.

Constructor & Destructor Documentation

__construct()

ilMailAttachmentGUI::__construct

(

)

ilUIDemoFileUploadHandlerGUI constructor.

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

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

    {
        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());
    }

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

Here is the call graph for this function:

Member Function Documentation

cancelSaveAttachmentsCommand()

ilMailAttachmentGUI::cancelSaveAttachmentsCommand ( )

private

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

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

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

Here is the call graph for this function:

confirmDeleteAttachments()

ilMailAttachmentGUI::confirmDeleteAttachments ( )

private

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

                                               : 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($this->tpl::MESSAGE_TYPE_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, self::CMD_DELETE_ATTACHMENTS));
        $confirmation->setConfirm($this->lng->txt('confirm'), self::CMD_DELETE_ATTACHMENTS);
        $confirmation->setCancel($this->lng->txt('cancel'), self::CMD_SHOW_ATTACHMENTS);
        $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();
    }

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

Referenced by handleTableActionsCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

consume()

ilMailAttachmentGUI::consume

(

)

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

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

References ILIAS\Mail\Attachments\CONSUME.

deleteAttachmentsCommand()

ilMailAttachmentGUI::deleteAttachmentsCommand ( )

private

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

                                               : 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($this->tpl::MESSAGE_TYPE_INFO, $this->lng->txt('mail_select_one_mail'));
            $this->showAttachmentsCommand();
            return;
        }
 
        $decoded_files = [];
        foreach ($files as $value) {
            $decoded_files[] = urldecode((string) $value);
        }
 
        $error = $this->mfile->unlinkFiles($decoded_files);
        if ($error !== '') {
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $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($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('mail_files_deleted'), true);
        }
 
        $this->ctrl->redirect($this);
    }

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

Here is the call 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

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

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

                                    : void
    {
        $cmd = $this->ctrl->getCmd();
        switch ($cmd) {
            case AbstractCtrlAwareUploadHandler::CMD_UPLOAD:
            case AbstractCtrlAwareUploadHandler::CMD_INFO:
            case AbstractCtrlAwareUploadHandler::CMD_REMOVE:
                parent::executeCommand();
                break;
 
            default:
                if ($cmd === null || $cmd === '' || !method_exists($this, $cmd . 'Command')) {
                    $cmd = self::DEFAULT_CMD;
                }
                $verified_command = $cmd . 'Command';
                $this->$verified_command();
                break;
        }
    }

References ILIAS\Repository\ctrl(), and ILIAS\Mail\Attachments\MailAttachmentCommands\DEFAULT_CMD.

Here is the call graph for this function:

getFileIdentifierParameterName()

ilMailAttachmentGUI::getFileIdentifierParameterName

(

)

@inheritDoc

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

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

                                                    : string
    {
        return 'userfile';
    }

Referenced by getUploadResult().

Here is the caller graph for this function:

getInfoForExistingFiles()

ilMailAttachmentGUI::getInfoForExistingFiles

(

array

$file_ids

)

Parameters

array

$file_ids

Returns

BasicFileInfoResult[]

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 373 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.

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

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

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

getRemoveResult()

ilMailAttachmentGUI::getRemoveResult ( string  $identifier )

protected

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 363 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 72 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 65 of file class.ilMailAttachmentGUI.php.

                                          : array
    {
        return [
            self::CMD_HANDLE_TABLE_ACTIONS,
        ];
    }

References ILIAS\Mail\Attachments\MailAttachmentCommands\CMD_HANDLE_TABLE_ACTIONS.

getUploadResult()

ilMailAttachmentGUI::getUploadResult ( )

protected

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

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

                                        : 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($this->tpl::MESSAGE_TYPE_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);
    }

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

Here is the call graph for this function:

handleTableActionsCommand()

ilMailAttachmentGUI::handleTableActionsCommand ( )

private

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

                                                : 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) {
            self::TABLE_ACTION_SAVE_ATTACHMENTS => $this->saveAttachments(),
            self::TABLE_CONFIRM_DELETE_ATTACHMENTS => $this->confirmDeleteAttachments(),
            default => $this->ctrl->redirect($this),
        };
    }

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

Here is the call graph for this function:

manage()

ilMailAttachmentGUI::manage

(

)

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

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

saveAttachments()

ilMailAttachmentGUI::saveAttachments ( )

private

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

                                      : 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(
                $this->tpl::MESSAGE_TYPE_FAILURE,
                $this->lng->txt('mail_max_size_attachments_total_error') . ' ' .
                ilUtil::formatSize((int) $this->mfile->getAttachmentsTotalSizeLimit())
            );
            $this->showAttachmentsCommand();
            return;
        }
 
        $this->umail->saveAttachments($files);
 
        $this->ctrl->returnToParent($this);
    }

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

Referenced by handleTableActionsCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

showAttachmentsCommand()

ilMailAttachmentGUI::showAttachmentsCommand ( )

private

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

                                             : 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, self::CMD_CANCEL_SAVE_ATTACHMENTS)
            );
        }
 
        $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(),
            self::CMD_HANDLE_TABLE_ACTIONS,
            $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();
    }

References $components, 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 deleteAttachmentsCommand(), and saveAttachments().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$lng

readonly ilLanguage ilMailAttachmentGUI::$lng

private

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

$mfile

readonly ilFileDataMail ilMailAttachmentGUI::$mfile

private

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

$mode

AttachmentManagement ilMailAttachmentGUI::$mode = AttachmentManagement::MANAGE

private

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

$refinery

readonly Refinery ilMailAttachmentGUI::$refinery

private

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

$tabs

readonly ilTabsGUI ilMailAttachmentGUI::$tabs

private

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

$tpl

readonly ilGlobalTemplateInterface ilMailAttachmentGUI::$tpl

private

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

$ui_factory

readonly ILIAS UI Factory ilMailAttachmentGUI::$ui_factory

private

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

$ui_renderer

readonly ILIAS UI Renderer ilMailAttachmentGUI::$ui_renderer

private

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

$umail

readonly ilFormatMail ilMailAttachmentGUI::$umail

private

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

$user

readonly ilObjUser ilMailAttachmentGUI::$user

private

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

---

The documentation for this class was generated from the following file:

• components/ILIAS/Mail/classes/class.ilMailAttachmentGUI.php