ILIAS  release_4-3 Revision
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
ilMailSearchGUI Class Reference
Services/Mail
+ Collaboration diagram for ilMailSearchGUI:

Public Member Functions

 __construct ($wsp_access_handler=null, $wsp_node_id=null)
 executeCommand ()
 adopt ()
 cancel ()
 search ()
 showResults ()

Protected Member Functions

 initSearchForm ()
 addPermission ($a_obj_ids)

Private Member Functions

 saveMailData ()

Private Attributes

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

Detailed Description

Author
Jens Conze
Version
$Id$

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

Constructor & Destructor Documentation

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

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

References $ilCtrl, $ilUser, $lng, and $tpl.

{
global $tpl, $ilCtrl, $lng, $ilUser;
$this->tpl = $tpl;
$this->ctrl = $ilCtrl;
$this->lng = $lng;
// 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($ilUser->getId());
}

Member Function Documentation

ilMailSearchGUI::addPermission (   $a_obj_ids)
protected

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

References ilUtil\sendSuccess().

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 call graph for this function:

+ Here is the caller graph for this function:

ilMailSearchGUI::adopt ( )

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

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

{
// necessary because of select all feature of ilTable2GUI
$recipients = array();
$recipients = array_merge($recipients, (array)$_POST['search_name_to_addr']);
$recipients = array_merge($recipients, (array)$_POST['search_name_to_usr']);
$recipients = array_merge($recipients, (array)$_POST['search_name_to_grp']);
$recipients = array_unique($recipients);
$_SESSION["mail_search_results_to"] = $recipients;
$_SESSION["mail_search_results_cc"] = $_POST["search_name_cc"];
$_SESSION["mail_search_results_bcc"] = $_POST["search_name_bcc"];
if($_GET["ref"] != "wsp")
{
$this->saveMailData();
}
else
{
$this->addPermission($recipients);
}
$this->ctrl->returnToParent($this);
}

+ Here is the call graph for this function:

ilMailSearchGUI::cancel ( )

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

{
$this->ctrl->returnToParent($this);
}
ilMailSearchGUI::executeCommand ( )

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

References $cmd.

{
$forward_class = $this->ctrl->getNextClass($this);
switch($forward_class)
{
default:
if (!($cmd = $this->ctrl->getCmd()))
{
$cmd = "showResults";
}
$this->$cmd();
break;
}
return true;
}
ilMailSearchGUI::initSearchForm ( )
protected

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

References $_GET, $_SESSION, $ilCtrl, $title, ilUtil\prepareFormOutput(), saveMailData(), ilCheckboxInputGUI\setChecked(), and ilTextInputGUI\setSize().

Referenced by showResults().

{
global $ilCtrl;
if($_GET["ref"] != "wsp")
{
$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($ilCtrl->getFormAction($this, 'search'));
$inp = new ilTextInputGUI($this->lng->txt("search_for"), 'search');
$inp->setSize(30);
if (strlen(trim($_SESSION["mail_search_search"])) > 0)
{
$inp->setValue(ilUtil::prepareFormOutput(trim($_SESSION["mail_search_search"]), true));
}
$form->addItem($inp);
$chb = new ilCheckboxInputGUI($this->lng->txt("mail_search_addressbook"), 'type_addressbook');
if ($_SESSION['mail_search_type_addressbook'])
$chb->setChecked(true);
$inp->addSubItem($chb);
$chb = new ilCheckboxInputGUI($this->lng->txt("mail_search_system"), 'type_system');
if ($_SESSION['mail_search_type_system'])
$chb->setChecked(true);
$inp->addSubItem($chb);
$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:

ilMailSearchGUI::saveMailData ( )
private

Definition at line 107 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_type"],
$mail_data["m_email"],
$mail_data["m_subject"],
$mail_data["m_message"],
$mail_data["use_placeholders"]
);
}

+ Here is the caller graph for this function:

ilMailSearchGUI::search ( )

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

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

{
$_SESSION["mail_search_search"] = $_POST["search"];
$_SESSION["mail_search_type_system"] = $_POST["type_system"];
$_SESSION["mail_search_type_addressbook"] = $_POST["type_addressbook"];
if (strlen(trim($_SESSION["mail_search_search"])) == 0)
{
ilUtil::sendInfo($this->lng->txt("mail_insert_query"));
}
else if(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:

ilMailSearchGUI::showResults ( )

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

References $_GET, $_SESSION, $ilCtrl, $ilUser, $lng, $result, ilObjectSearchFactory\_getObjectSearchInstance(), ilObjectSearchFactory\_getUserSearchInstance(), ilObjUser\_loginExists(), ilObjUser\_lookupEmail(), ilObjUser\_lookupId(), ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), ilObjUser\_lookupPref(), ilUtil\formCheckbox(), ilUtil\getImagePath(), ilUserFilter\getInstance(), ilParticipants\hasParticipantListAccess(), initSearchForm(), ilUtil\prepareFormOutput(), QP_COMBINATION_AND, ilAddressbook\searchUsers(), ilUtil\sendFailure(), and ilUtil\sendInfo().

Referenced by search().

{
global $rbacsystem, $lng, $ilUser, $ilCtrl, $rbacreview, $ilObjDataCache;
$form = $this->initSearchForm();
$this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.mail_search.html", "Services/Contact");
$this->tpl->setTitle($this->lng->txt("mail"));
$this->tpl->setVariable("ACTION", $this->ctrl->getFormAction($this));
$this->tpl->setVariable('SEARCHFORM', $form->getHtml());
// #14109
if(strlen($_SESSION['mail_search_search']) < 3)
{
if($_GET["ref"] != "wsp")
{
$this->tpl->show();
}
return;
}
if (strlen(trim($_SESSION["mail_search_search"])) > 0)
{
$this->tpl->setVariable("VALUE_SEARCH_FOR", ilUtil::prepareFormOutput(trim($_SESSION["mail_search_search"]), true));
}
if ($_SESSION['mail_search_type_addressbook']) $this->tpl->setVariable('CHECKED_TYPE_ADDRESSBOOK', "checked=\"checked\"");
if ($_SESSION['mail_search_type_system'])$this->tpl->setVariable('CHECKED_TYPE_SYSTEM', "checked=\"checked\"");
if ($_SESSION['mail_search_type_addressbook'] == NULL && $_SESSION['mail_search_type_system'] == NULL)
{
$this->lng->loadLanguageModule('search');
ilUtil::sendFailure($this->lng->txt('search_one_action'));
}
if ($_SESSION['mail_search_type_addressbook'] && strlen(trim($_SESSION["mail_search_search"])) >= 3)
{
$abook = new ilAddressbook($ilUser->getId());
$entries = $abook->searchUsers(addslashes(urldecode($_SESSION['mail_search_search'])));
// remove all contacts who are not registered users for personal workspace
if($_GET["ref"] == "wsp")
{
foreach($entries as $idx => $entry)
{
if(!$entry["login"])
{
unset($entries[$idx]);
}
}
}
if (count($entries))
{
$tbl_addr = new ilTable2GUI($this);
$tbl_addr->setTitle($lng->txt('mail_addressbook'));
$tbl_addr->setRowTemplate('tpl.mail_search_addr_row.html', 'Services/Contact');
$result = array();
$counter = 0;
foreach ($entries as $entry)
{
if($_GET["ref"] != "wsp")
{
$result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_addr[]', ($entry['login'] ? $entry['login'] : $entry['email'])) .
ilUtil::formCheckbox(0, 'search_name_cc[]', ($entry['login'] ? $entry['login'] : $entry['email'])) .
ilUtil::formCheckbox(0, 'search_name_bcc[]', ($entry['login'] ? $entry['login'] : $entry['email']));
}
else
{
$user_id = ilObjUser::_loginExists($entry["login"]);
$result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_addr[]', $user_id);
}
$result[$counter]['login'] = $entry['login'];
$result[$counter]['firstname'] = $entry['firstname'];
$result[$counter]['lastname'] = $entry['lastname'];
$id = ilObjUser::_lookupId($entry['login']);
if (ilObjUser::_lookupPref($id, 'public_email') == 'y' || !$entry['login'])
{
$has_mail_addr = true;
$result[$counter]['email'] = $entry['email'];
}
++$counter;
}
if($_GET["ref"] != "wsp")
{
$tbl_addr->addColumn($this->lng->txt('mail_to') . '/' . $this->lng->txt('cc') . '/' . $this->lng->txt('bc'), 'check', '10%');
}
else
{
$tbl_addr->addColumn("", "", "1%");
}
$tbl_addr->addColumn($this->lng->txt('login'), 'login', "15%");
$tbl_addr->addColumn($this->lng->txt('firstname'), 'firstname', "15%");
$tbl_addr->addColumn($this->lng->txt('lastname'), 'lastname', "15%");
if ($has_mail_addr)
{
foreach ($result as $key => $val)
{
if ($val['email'] == '') $result[$key]['email'] = '&nbsp;';
}
$tbl_addr->addColumn($this->lng->txt('email'), 'email', "15%");
}
$tbl_addr->setData($result);
$tbl_addr->setDefaultOrderField('login');
$tbl_addr->setPrefix('addr_');
$tbl_addr->enable('select_all');
$tbl_addr->setSelectAllCheckbox('search_name_to_addr');
$tbl_addr->setFormName('recipients');
$this->tpl->setVariable('TABLE_ADDR', $tbl_addr->getHTML());
}
}
if ($_SESSION['mail_search_type_system'] && strlen(trim($_SESSION["mail_search_search"])) >= 3)
{
include_once 'Services/Search/classes/class.ilQueryParser.php';
include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
include_once 'Services/Search/classes/class.ilSearchResult.php';
$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);
//$users = $all_results->getResults();
// Filter users (depends on setting in user accounts)
include_once './Services/User/classes/class.ilUserFilter.php';
$users = ilUserFilter::getInstance()->filter($all_results->getResultIds());
if (count($users))
{
$tbl_users = new ilTable2GUI($this);
$tbl_users->setTitle($lng->txt('system').': '.$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($_GET["ref"] != "wsp")
{
$result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_usr[]', $login) .
ilUtil::formCheckbox(0, 'search_name_cc[]', $login) .
ilUtil::formCheckbox(0, 'search_name_bcc[]', $login);
}
else
{
$result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_usr[]', $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($_GET["ref"] != "wsp")
{
$tbl_users->addColumn($this->lng->txt('mail_to') . '/' . $this->lng->txt('cc') . '/' . $this->lng->txt('bc'), 'check', '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->setPrefix('usr_');
$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 ilTable2GUI($this);
$tbl_grp->setTitle($lng->txt('system').': '.$lng->txt('groups'));
$tbl_grp->setRowTemplate('tpl.mail_search_groups_row.html','Services/Contact');
$result = array();
$counter = 0;
$ilObjDataCache->preloadReferenceCache(array_keys($group_results->getResults()));
$groups = $group_results->getResults();
foreach ($groups as $grp)
{
if(!ilParticipants::hasParticipantListAccess($grp['obj_id']))
{
continue;
}
if($_GET["ref"] != "wsp")
{
$members = array();
$roles = $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_')
{
// does not work if Pear is enabled and Mailbox Address contain special chars!!
//array_push($members, $rbacreview->getRoleMailboxAddress($role['obj_id']));
// FIX for Mantis: 7523
array_push($members, '#'.$role['title']);
}
}
$str_members = implode(',',$members);
$result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_grp[]', $str_members) .
ilUtil::formCheckbox(0, 'search_name_cc[]', $str_members) .
ilUtil::formCheckbox(0, 'search_name_bcc[]',$str_members);
}
else
{
$result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_grp[]', $grp['obj_id']);
}
$result[$counter]['title'] = $ilObjDataCache->lookupTitle($grp['obj_id']);
$result[$counter]['description'] = $ilObjDataCache->lookupDescription($grp['obj_id']);
$visible_groups[] = $grp;
++$counter;
}
if($visible_groups)
{
$tbl_grp->setData($result);
if($_GET["ref"] != "wsp")
{
$tbl_grp->addColumn($this->lng->txt('mail_to') . '/' . $this->lng->txt('cc') . '/' . $this->lng->txt('bc'), 'check', '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->setPrefix('grp_');
$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($entries))
{
$this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("arrow_downright.png"));
$this->tpl->setVariable("ALT_ARROW", '');
if($_GET["ref"] != "wsp")
{
$this->tpl->setVariable('BUTTON_ADOPT', $this->lng->txt('adopt'));
}
else
{
$this->tpl->setVariable('BUTTON_ADOPT', $this->lng->txt('wsp_share_with_users'));
}
}
else if (strlen(trim($_SESSION["mail_search_search"])) >= 3
&& ($_SESSION['mail_search_type_addressbook'] != NULL || $_SESSION['mail_search_type_system'] != NULL))
{
$this->lng->loadLanguageModule('search');
ilUtil::sendInfo($this->lng->txt('search_no_match'));
}
if($_GET["ref"] != "wsp")
{
$this->tpl->show();
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Field Documentation

ilMailSearchGUI::$ctrl = null
private

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

ilMailSearchGUI::$errorDelete = false
private

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

ilMailSearchGUI::$lng = null
private

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

Referenced by __construct(), and showResults().

ilMailSearchGUI::$tpl = null
private

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

Referenced by __construct().

ilMailSearchGUI::$umail = null
private

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

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