ilMailSearchGUI Class Reference

Collaboration diagram for ilMailSearchGUI:

Public Member Functions
	__construct ($wsp_access_handler=null, $wsp_node_id=null)
	executeCommand ()
	adopt ()
	cancel ()
	search ()
	lookupRecipientAsync ()
	showResults ()

Protected Member Functions
	initSearchForm ()
	addPermission ($a_obj_ids)

Protected Attributes
	$rbacreview
	$object_data_cache

Private Member Functions
	isDefaultRequestContext ()
	saveMailData ()
	appendRecipientSelection (array &$result, int $index, string $search_type, string $recipient_type, string $value)

Private Attributes
	$tpl
	$ctrl
	$lng
	$umail = null
	$errorDelete = false

Detailed Description

Author

Jens Conze

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilMailSearchGUI::__construct	(		$wsp_access_handler = null,
			$wsp_node_id = null
	)

Definition at line 61 of file class.ilMailSearchGUI.php.

References $DIC.

    {
        global $DIC;

        $this->tpl = $DIC['tpl'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->lng = $DIC['lng'];
        $this->rbacreview = $DIC['rbacreview'];
        $this->object_data_cache = $DIC['ilObjDataCache'];

        // personal workspace
        $this->wsp_access_handler = $wsp_access_handler;
        $this->wsp_node_id = $wsp_node_id;

        $this->ctrl->saveParameter($this, "mobj_id");
        $this->ctrl->saveParameter($this, "ref");

        $this->umail = new ilFormatMail($DIC->user()->getId());
    }

Member Function Documentation

addPermission()

ilMailSearchGUI::addPermission (   $a_obj_ids )

protected

Definition at line 592 of file class.ilMailSearchGUI.php.

Referenced by adopt().

    {
        if (!is_array($a_obj_ids)) {
            $a_obj_ids = array($a_obj_ids);
        }

        $existing = $this->wsp_access_handler->getPermissions($this->wsp_node_id);
        $added = false;
        foreach ($a_obj_ids as $object_id) {
            if (!in_array($object_id, $existing)) {
                $added = $this->wsp_access_handler->addPermission($this->wsp_node_id, $object_id);
            }
        }

        if ($added) {
            ilUtil::sendSuccess($this->lng->txt("wsp_share_success"), true);
        }
    }

Here is the caller graph for this function:

adopt()

ilMailSearchGUI::adopt

(

)

Definition at line 104 of file class.ilMailSearchGUI.php.

References $_POST, $_SESSION, addPermission(), isDefaultRequestContext(), and saveMailData().

    {
        $to_recipients = [];
        foreach (['to', 'cc', 'bcc'] as $recipient_type) {
            $recipients = [];
            $recipients = array_merge($recipients, (array) $_POST['search_name_' . $recipient_type . '_addr']);
            $recipients = array_merge($recipients, (array) $_POST['search_name_' . $recipient_type . '_usr']);
            $recipients = array_merge($recipients, (array) $_POST['search_name_' . $recipient_type . '_grp']);
            $recipients = array_unique($recipients);
            $_SESSION["mail_search_results_" . $recipient_type] = $recipients;

            if ('to' === $recipient_type) {
                $to_recipients = $recipients;
            }
        }

        if ($this->isDefaultRequestContext()) {
            $this->saveMailData();
        } else {
            $this->addPermission($to_recipients);
        }

        $this->ctrl->returnToParent($this);
    }

Here is the call graph for this function:

appendRecipientSelection()

ilMailSearchGUI::appendRecipientSelection ( array &  $result, int  $index, string  $search_type, string  $recipient_type, string  $value  )

private

Parameters

array<int,array<string,mixed>>

$result

Definition at line 249 of file class.ilMailSearchGUI.php.

References $index, and ilUtil\formCheckbox().

Referenced by showResults().

      : void {
        $result[$index]['check_' . $recipient_type] = ilUtil::formCheckbox(
            false,
            'search_name_' . $recipient_type . '_' . $search_type . '[' . $index . ']',
            $value
        );

        $result[$index]['id_' . $recipient_type] = 'search_name_' . $search_type . '_' . $index;
        $result[$index]['txt_' . $recipient_type] = $this->lng->txt('mail_' . $recipient_type);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cancel()

ilMailSearchGUI::cancel

(

)

Definition at line 148 of file class.ilMailSearchGUI.php.

    {
        $this->ctrl->returnToParent($this);
    }

executeCommand()

ilMailSearchGUI::executeCommand

(

)

Definition at line 81 of file class.ilMailSearchGUI.php.

    {
        $forward_class = $this->ctrl->getNextClass($this);
        switch ($forward_class) {
            default:
                if (!($cmd = $this->ctrl->getCmd())) {
                    $cmd = "showResults";
                }

                $this->$cmd();
                break;
        }
        return true;
    }

initSearchForm()

ilMailSearchGUI::initSearchForm ( )

protected

Definition at line 169 of file class.ilMailSearchGUI.php.

References $_SESSION, isDefaultRequestContext(), ilUtil\prepareFormOutput(), and saveMailData().

Referenced by showResults().

    {
        if ($this->isDefaultRequestContext()) {
            $this->saveMailData();
            $title = $this->lng->txt('search_recipients');
        } else {
            $this->lng->loadLanguageModule("wsp");
            $title = $this->lng->txt("wsp_share_search_users");
        }

        // searchform
        include_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();
        $form->setTitle($title);
        $form->setId('search_rcp');
        $form->setFormAction($this->ctrl->getFormAction($this, 'search'));

        $inp = new ilTextInputGUI($this->lng->txt("search_for"), 'search');
        $inp->setSize(30);
        $dsDataLink = $this->ctrl->getLinkTarget($this, 'lookupRecipientAsync', '', true, false);
        $inp->setDataSource($dsDataLink);

        if (
            isset($_SESSION["mail_search_search"]) &&
            is_string($_SESSION["mail_search_search"]) &&
            strlen(trim($_SESSION["mail_search_search"])) > 0
        ) {
            $inp->setValue(ilUtil::prepareFormOutput(trim($_SESSION["mail_search_search"]), true));
        }
        $form->addItem($inp);

        $form->addCommandButton('search', $this->lng->txt("search"));
        $form->addCommandButton('cancel', $this->lng->txt("cancel"));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isDefaultRequestContext()

ilMailSearchGUI::isDefaultRequestContext ( )

private

Returns

bool

Definition at line 99 of file class.ilMailSearchGUI.php.

References $_GET.

Referenced by adopt(), initSearchForm(), lookupRecipientAsync(), and showResults().

                                               : bool
    {
        return !isset($_GET['ref']) || $_GET['ref'] !== 'wsp';
    }

Here is the caller graph for this function:

lookupRecipientAsync()

ilMailSearchGUI::lookupRecipientAsync

(

)

Definition at line 206 of file class.ilMailSearchGUI.php.

References $_GET, $_POST, $result, exit, isDefaultRequestContext(), ilUtil\stripSlashes(), and ilStr\strLen().

    {
        include_once 'Services/JSON/classes/class.ilJsonUtil.php';
        include_once 'Services/Mail/classes/class.ilMailForm.php';
        include_once 'Services/Utilities/classes/class.ilStr.php';

        $search = '';
        if (isset($_GET["term"]) && is_string($_GET["term"])) {
            $search = $_GET["term"];
        }
        if (isset($_POST["term"]) && is_string($_POST["term"])) {
            $search = $_POST["term"];
        }

        $search = trim($search);

        $result = array();
        if (\ilStr::strLen($search) < 3) {
            echo json_encode($result);
            exit;
        }

        // #14768
        $quoted = ilUtil::stripSlashes($search);
        $quoted = str_replace('%', '\%', $quoted);
        $quoted = str_replace('_', '\_', $quoted);

        $search_recipients = ($this->isDefaultRequestContext());

        $mailFormObj = new ilMailForm;
        $result = $mailFormObj->getRecipientAsync(
            "%" . $quoted . "%",
            ilUtil::stripSlashes($search),
            $search_recipients
        );

        echo json_encode($result);
        exit;
    }

Here is the call graph for this function:

saveMailData()

ilMailSearchGUI::saveMailData ( )

private

Definition at line 129 of file class.ilMailSearchGUI.php.

Referenced by adopt(), and initSearchForm().

    {
        $mail_data = $this->umail->getSavedData();

        $this->umail->savePostData(
            $mail_data["user_id"],
            $mail_data["attachments"],
            $mail_data["rcp_to"],
            $mail_data["rcp_cc"],
            $mail_data["rcp_bcc"],
            $mail_data["m_email"],
            $mail_data["m_subject"],
            $mail_data["m_message"],
            $mail_data["use_placeholders"],
            $mail_data['tpl_ctx_id'],
            $mail_data['tpl_ctx_params']
        );
    }

Here is the caller graph for this function:

search()

ilMailSearchGUI::search

(

)

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

References $_POST, $_SESSION, ilUtil\sendInfo(), and showResults().

    {
        $_SESSION["mail_search_search"] = (string) $_POST["search"];

        if (strlen(trim($_SESSION["mail_search_search"])) == 0) {
            ilUtil::sendInfo($this->lng->txt("mail_insert_query"));
        } elseif (strlen(trim($_SESSION["mail_search_search"])) < 3) {
            $this->lng->loadLanguageModule('search');
            ilUtil::sendInfo($this->lng->txt('search_minimum_three'));
        }

        $this->showResults();

        return true;
    }

Here is the call graph for this function:

showResults()

ilMailSearchGUI::showResults

(

)

Definition at line 266 of file class.ilMailSearchGUI.php.

References $_SESSION, $login, $name, $result, ilObjectSearchFactory\_getObjectSearchInstance(), ilObjectSearchFactory\_getUserSearchInstance(), ilObjUser\_lookupEmail(), ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), ilObjUser\_lookupPref(), appendRecipientSelection(), ilUtil\getImagePath(), ilUserFilter\getInstance(), ilBuddyList\getInstanceByGlobalUser(), ilParticipants\hasParticipantListAccess(), initSearchForm(), isDefaultRequestContext(), QP_COMBINATION_AND, ROOT_FOLDER_ID, and ilUtil\sendInfo().

Referenced by search().

    {
        $form = $this->initSearchForm();

        $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.mail_search.html", "Services/Contact");
        $this->tpl->setVariable("ACTION", $this->ctrl->getFormAction($this));
        $this->tpl->setTitle($this->lng->txt("mail"));
        $this->tpl->setVariable('SEARCHFORM', $form->getHtml());

        // #14109
        if (
            !isset($_SESSION["mail_search_search"]) ||
            !is_string($_SESSION["mail_search_search"]) ||
            strlen(trim($_SESSION["mail_search_search"])) < 3
        ) {
            if ($this->isDefaultRequestContext()) {
                $this->tpl->printToStdout();
            }
            return;
        }

        require_once 'Services/Contact/BuddySystem/classes/class.ilBuddyList.php';
        $relations = ilBuddyList::getInstanceByGlobalUser()->getLinkedRelations();
        if (count($relations)) {
            $contacts_search_result = new ilSearchResult();

            $query_parser = new ilQueryParser(addcslashes($_SESSION['mail_search_search'], '%_'));
            $query_parser->setCombination(QP_COMBINATION_AND);
            $query_parser->setMinWordLength(3);
            $query_parser->parse();

            $user_search = ilObjectSearchFactory::_getUserSearchInstance($query_parser);
            $user_search->enableActiveCheck(true);
            $user_search->setFields(array('login'));
            $result_obj = $user_search->performSearch();
            $contacts_search_result->mergeEntries($result_obj);

            $user_search->setFields(array('firstname'));
            $result_obj = $user_search->performSearch();
            $contacts_search_result->mergeEntries($result_obj);

            $user_search->setFields(array('lastname'));
            $result_obj = $user_search->performSearch();
            $contacts_search_result->mergeEntries($result_obj);

            $contacts_search_result->setMaxHits(100000);
            $contacts_search_result->preventOverwritingMaxhits(true);
            $contacts_search_result->filter(ROOT_FOLDER_ID, true);

            // Filter users (depends on setting in user accounts)
            include_once 'Services/User/classes/class.ilUserFilter.php';
            $users = ilUserFilter::getInstance()->filter($contacts_search_result->getResultIds());
            $users = array_intersect($users, $relations->getKeys());

            $tbl_contacts = new ilMailSearchResultsTableGUI($this, 'contacts');
            $tbl_contacts->setTitle($this->lng->txt('mail_addressbook'));
            $tbl_contacts->setRowTemplate('tpl.mail_search_addr_row.html', 'Services/Contact');

            $has_mail_addr = false;
            $result = array();
            $counter = 0;
            foreach ($users as $user) {
                $login = ilObjUser::_lookupLogin($user);

                if ($this->isDefaultRequestContext()) {
                    foreach (['to', 'cc', 'bcc'] as $recipient_type) {
                        $this->appendRecipientSelection($result, $counter, 'addr', $recipient_type, $login);
                    }
                } else {
                    $this->appendRecipientSelection($result, $counter, 'addr', 'to', (string) $user);
                }

                $result[$counter]['login'] = $login;
                if (ilObjUser::_lookupPref($user, 'public_email') == 'y') {
                    $has_mail_addr = true;
                    $result[$counter]['email'] = ilObjUser::_lookupEmail($user, 'email');
                }

                if (in_array(ilObjUser::_lookupPref($user, 'public_profile'), array('y', "g"))) {
                    $name = ilObjUser::_lookupName($user);
                    $result[$counter]['firstname'] = $name['firstname'];
                    $result[$counter]['lastname'] = $name['lastname'];
                } else {
                    $result[$counter]['firstname'] = '';
                    $result[$counter]['lastname'] = '';
                }

                ++$counter;
            }

            if ($this->isDefaultRequestContext()) {
                $tbl_contacts->addColumn(
                    $this->lng->txt('mail_to') . '/' . $this->lng->txt('mail_cc') . '/' . $this->lng->txt('mail_bcc'),
                    '',
                    '10%'
                );
            } else {
                $tbl_contacts->addColumn("", "", "1%", true);
            }
            $tbl_contacts->addColumn($this->lng->txt('login'), 'login', '15%');
            $tbl_contacts->addColumn($this->lng->txt('firstname'), 'firstname', '15%');
            $tbl_contacts->addColumn($this->lng->txt('lastname'), 'lastname', '15%');
            if ($has_mail_addr) {
                foreach ($result as $key => $val) {
                    if ($val['email'] == '') {
                        $result[$key]['email'] = '&nbsp;';
                    }
                }

                $tbl_contacts->addColumn($this->lng->txt('email'), 'email', "15%");
            }
            $tbl_contacts->setData($result);

            $tbl_contacts->setDefaultOrderField('login');
            $tbl_contacts->enable('select_all');
            $tbl_contacts->setSelectAllCheckbox('search_name_to_addr');
            $tbl_contacts->setFormName('recipients');

            $this->tpl->setVariable('TABLE_ADDR', $tbl_contacts->getHTML());
        }

        $all_results = new ilSearchResult();

        $query_parser = new ilQueryParser(addcslashes($_SESSION['mail_search_search'], '%_'));
        $query_parser->setCombination(QP_COMBINATION_AND);
        $query_parser->setMinWordLength(3);
        $query_parser->parse();

        $user_search = ilObjectSearchFactory::_getUserSearchInstance($query_parser);
        $user_search->enableActiveCheck(true);
        $user_search->setFields(array('login'));
        $result_obj = $user_search->performSearch();
        $all_results->mergeEntries($result_obj);

        $user_search->setFields(array('firstname'));
        $result_obj = $user_search->performSearch();
        $all_results->mergeEntries($result_obj);

        $user_search->setFields(array('lastname'));
        $result_obj = $user_search->performSearch();
        $all_results->mergeEntries($result_obj);

        $all_results->setMaxHits(100000);
        $all_results->preventOverwritingMaxhits(true);
        $all_results->filter(ROOT_FOLDER_ID, true);

        // Filter users (depends on setting in user accounts)
        $has_mail_usr = false;
        include_once 'Services/User/classes/class.ilUserFilter.php';
        $users = ilUserFilter::getInstance()->filter($all_results->getResultIds());
        if (count($users)) {
            $tbl_users = new ilMailSearchResultsTableGUI($this, 'usr');
            $tbl_users->setTitle($this->lng->txt('system') . ': ' . $this->lng->txt('persons'));
            $tbl_users->setRowTemplate('tpl.mail_search_users_row.html', 'Services/Contact');

            $result = array();
            $counter = 0;
            foreach ($users as $user) {
                $login = ilObjUser::_lookupLogin($user);

                if ($this->isDefaultRequestContext()) {
                    foreach (['to', 'cc', 'bcc'] as $recipient_type) {
                        $this->appendRecipientSelection($result, $counter, 'usr', $recipient_type, $login);
                    }
                } else {
                    $this->appendRecipientSelection($result, $counter, 'usr', 'to', (string) $user);
                }
                $result[$counter]['login'] = $login;

                if (in_array(ilObjUser::_lookupPref($user, 'public_profile'), array('y', "g"))) {
                    $name = ilObjUser::_lookupName($user);
                    $result[$counter]['firstname'] = $name['firstname'];
                    $result[$counter]['lastname'] = $name['lastname'];
                } else {
                    $result[$counter]['firstname'] = '';
                    $result[$counter]['lastname'] = '';
                }

                if (ilObjUser::_lookupPref($user, 'public_email') == 'y') {
                    $has_mail_usr = true;
                    $result[$counter]['email'] = ilObjUser::_lookupEmail($user);
                }

                ++$counter;
            }

            if ($this->isDefaultRequestContext()) {
                $tbl_users->addColumn(
                    $this->lng->txt('mail_to') . '/' . $this->lng->txt('mail_cc') . '/' . $this->lng->txt('mail_bcc'),
                    '',
                    '10%'
                );
            } else {
                $tbl_users->addColumn("", "", "1%");
            }
            $tbl_users->addColumn($this->lng->txt('login'), 'login', '15%');
            $tbl_users->addColumn($this->lng->txt('firstname'), 'firstname', '15%');
            $tbl_users->addColumn($this->lng->txt('lastname'), 'lastname', '15%');
            if ($has_mail_usr == true) {
                foreach ($result as $key => $val) {
                    if ($val['email'] == '') {
                        $result[$key]['email'] = '&nbsp;';
                    }
                }

                $tbl_users->addColumn($this->lng->txt('email'), 'email', '15%');
            }
            $tbl_users->setData($result);

            $tbl_users->setDefaultOrderField('login');
            $tbl_users->enable('select_all');
            $tbl_users->setSelectAllCheckbox('search_name_to_usr');
            $tbl_users->setFormName('recipients');

            $this->tpl->setVariable('TABLE_USERS', $tbl_users->getHTML());
        }

        include_once 'Services/Search/classes/class.ilQueryParser.php';
        include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
        include_once 'Services/Search/classes/class.ilSearchResult.php';
        include_once 'Services/Membership/classes/class.ilParticipants.php';

        $group_results = new ilSearchResult();

        $query_parser = new ilQueryParser(addcslashes($_SESSION['mail_search_search'], '%_'));
        $query_parser->setCombination(QP_COMBINATION_AND);
        $query_parser->setMinWordLength(3);
        $query_parser->parse();

        $search = ilObjectSearchFactory::_getObjectSearchInstance($query_parser);
        $search->setFilter(array('grp'));
        $result = $search->performSearch();
        $group_results->mergeEntries($result);
        $group_results->setMaxHits(PHP_INT_MAX);
        $group_results->preventOverwritingMaxhits(true);
        $group_results->setRequiredPermission('read');
        $group_results->filter(ROOT_FOLDER_ID, true);

        $visible_groups = array();
        if ($group_results->getResults()) {
            $tbl_grp = new ilMailSearchResultsTableGUI($this, 'grp');
            $tbl_grp->setTitle($this->lng->txt('system') . ': ' . $this->lng->txt('groups'));
            $tbl_grp->setRowTemplate('tpl.mail_search_groups_row.html', 'Services/Contact');

            $result = array();
            $counter = 0;

            $this->object_data_cache->preloadReferenceCache(array_keys($group_results->getResults()));

            $groups = $group_results->getResults();
            foreach ($groups as $grp) {
                if (!ilParticipants::hasParticipantListAccess($grp['obj_id'])) {
                    continue;
                }

                if ($this->isDefaultRequestContext()) {
                    $members = array();
                    $roles = $this->rbacreview->getAssignableChildRoles($grp['ref_id']);
                    foreach ($roles as $role) {
                        if (substr($role['title'], 0, 14) == 'il_grp_member_' ||
                            substr($role['title'], 0, 13) == 'il_grp_admin_'
                        ) {
                            // FIX for Mantis: 7523
                            array_push($members, '#' . $role['title']);
                        }
                    }
                    $str_members = implode(',', $members);

                    foreach (['to', 'cc', 'bcc'] as $recipient_type) {
                        $this->appendRecipientSelection($result, $counter, 'grp', $recipient_type, $str_members);
                    }
                } else {
                    $this->appendRecipientSelection($result, $counter, 'grp', 'to', (string) $grp['obj_id']);
                }
                $result[$counter]['title'] = $this->object_data_cache->lookupTitle($grp['obj_id']);
                $result[$counter]['description'] = $this->object_data_cache->lookupDescription($grp['obj_id']);

                ++$counter;
                $visible_groups[] = $grp;
            }

            if ($visible_groups) {
                $tbl_grp->setData($result);

                if ($this->isDefaultRequestContext()) {
                    $tbl_grp->addColumn(
                        $this->lng->txt('mail_to') . '/' . $this->lng->txt('mail_cc') . '/' . $this->lng->txt('mail_bcc'),
                        '',
                        '10%'
                    );
                } else {
                    $tbl_grp->addColumn("", "", "1%");
                }
                $tbl_grp->addColumn($this->lng->txt('title'), 'title', '15%');
                $tbl_grp->addColumn($this->lng->txt('description'), 'description', '15%');

                $tbl_grp->setDefaultOrderField('title');
                $tbl_grp->enable('select_all');
                $tbl_grp->setSelectAllCheckbox('search_name_to_grp');
                $tbl_grp->setFormName('recipients');

                $this->tpl->setVariable('TABLE_GRP', $tbl_grp->getHTML());
            }
        }

        if (count($users) || count($visible_groups) || count($relations)) {
            $this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("arrow_downright.svg"));
            $this->tpl->setVariable("ALT_ARROW", '');
            $this->tpl->setVariable("IMG_ARROW_UP", ilUtil::getImagePath("arrow_upright.svg"));
            $this->tpl->setVariable("ALT_ARROW_UP", '');

            if ($this->isDefaultRequestContext()) {
                $this->tpl->setVariable('BUTTON_ADOPT', $this->lng->txt('adopt'));
            } else {
                $this->tpl->setVariable('BUTTON_ADOPT', $this->lng->txt('wsp_share_with_users'));
            }
        } else {
            $this->lng->loadLanguageModule('search');
            ilUtil::sendInfo($this->lng->txt('search_no_match'));
        }

        if ($this->isDefaultRequestContext()) {
            $this->tpl->printToStdout();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilMailSearchGUI::$ctrl

private

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

$errorDelete

ilMailSearchGUI::$errorDelete = false

private

Definition at line 59 of file class.ilMailSearchGUI.php.

$lng

ilMailSearchGUI::$lng

private

Definition at line 55 of file class.ilMailSearchGUI.php.

$object_data_cache

ilMailSearchGUI::$object_data_cache

protected

Definition at line 50 of file class.ilMailSearchGUI.php.

$rbacreview

ilMailSearchGUI::$rbacreview

protected

Definition at line 45 of file class.ilMailSearchGUI.php.

$tpl

ilMailSearchGUI::$tpl

private

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

$umail

ilMailSearchGUI::$umail = null

private

Definition at line 57 of file class.ilMailSearchGUI.php.

---

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

• Services/Contact/classes/class.ilMailSearchGUI.php