ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
class.ilMailSearchGUI.php
Go to the documentation of this file.
1 <?php
2 /*
3  +-----------------------------------------------------------------------------+
4  | ILIAS open source |
5  +-----------------------------------------------------------------------------+
6  | Copyright (c) 1998-2006 ILIAS open source, University of Cologne |
7  | |
8  | This program is free software; you can redistribute it and/or |
9  | modify it under the terms of the GNU General Public License |
10  | as published by the Free Software Foundation; either version 2 |
11  | of the License, or (at your option) any later version. |
12  | |
13  | This program is distributed in the hope that it will be useful, |
14  | but WITHOUT ANY WARRANTY; without even the implied warranty of |
15  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16  | GNU General Public License for more details. |
17  | |
18  | You should have received a copy of the GNU General Public License |
19  | along with this program; if not, write to the Free Software |
20  | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
21  +-----------------------------------------------------------------------------+
22 */
23 
24 require_once './Services/User/classes/class.ilObjUser.php';
25 require_once "Services/Mail/classes/class.ilMailbox.php";
26 require_once "Services/Mail/classes/class.ilFormatMail.php";
27 require_once "Services/Mail/classes/class.ilAddressbook.php";
28 include_once('Services/Table/classes/class.ilTable2GUI.php');
29 
36 class ilMailSearchGUI
37 {
38  private $tpl = null;
39  private $ctrl = null;
40  private $lng = null;
41 
42  private $umail = null;
43 
44  private $errorDelete = false;
45 
46  public function __construct()
47  {
48  global $tpl, $ilCtrl, $lng, $ilUser;
49 
50  $this->tpl = $tpl;
51  $this->ctrl = $ilCtrl;
52  $this->lng = $lng;
53 
54  $this->ctrl->saveParameter($this, "mobj_id");
55 
56  $this->umail = new ilFormatMail($ilUser->getId());
57  }
58 
59  public function executeCommand()
60  {
61  $forward_class = $this->ctrl->getNextClass($this);
62  switch($forward_class)
63  {
64  default:
65  if (!($cmd = $this->ctrl->getCmd()))
66  {
67  $cmd = "showResults";
68  }
69 
70  $this->$cmd();
71  break;
72  }
73  return true;
74  }
75 
76  public function adopt()
77  {
78  // necessary because of select all feature of ilTable2GUI
79  $recipients = array();
80  $recipients = array_merge($recipients, (array)$_POST['search_name_to_addr']);
81  $recipients = array_merge($recipients, (array)$_POST['search_name_to_usr']);
82  $recipients = array_merge($recipients, (array)$_POST['search_name_to_grp']);
83 
84  $recipients = array_unique($recipients);
85 
86  $_SESSION["mail_search_results_to"] = $recipients;
87  $_SESSION["mail_search_results_cc"] = $_POST["search_name_cc"];
88  $_SESSION["mail_search_results_bcc"] = $_POST["search_name_bcc"];
89 
90  $this->saveMailData();
91 
92  $this->ctrl->returnToParent($this);
93  }
94 
95  private function saveMailData()
96  {
97  $mail_data = $this->umail->getSavedData();
98 
99  $this->umail->savePostData(
100  $mail_data["user_id"],
101  $mail_data["attachments"],
102  $mail_data["rcp_to"],
103  $mail_data["rcp_cc"],
104  $mail_data["rcp_bcc"],
105  $mail_data["m_type"],
106  $mail_data["m_email"],
107  $mail_data["m_subject"],
108  $mail_data["m_message"],
109  $mail_data["use_placeholders"]
110  );
111  }
112 
113  public function cancel()
114  {
115  $this->ctrl->returnToParent($this);
116  }
117 
118  function search()
119  {
120  $_SESSION["mail_search_search"] = $_POST["search"];
121  $_SESSION["mail_search_type_system"] = $_POST["type_system"];
122  $_SESSION["mail_search_type_addressbook"] = $_POST["type_addressbook"];
123 
124  // IF NO TYPE IS GIVEN SEARCH IN BOTH 'system' and 'addressbook'
125  if(!$_SESSION["mail_search_type_system"] &&
126  !$_SESSION["mail_search_type_addressbook"])
127  {
128  $_SESSION["mail_search_type_system"] = 1;
129  $_SESSION["mail_search_type_addressbook"] = 1;
130  }
131  if (strlen(trim($_SESSION["mail_search_search"])) == 0)
132  {
133  ilUtil::sendInfo($this->lng->txt("mail_insert_query"));
134  }
135  else if(strlen(trim($_SESSION["mail_search_search"])) < 3)
136  {
137  $this->lng->loadLanguageModule('search');
138  ilUtil::sendInfo($this->lng->txt('search_minimum_three'));
139  }
140 
141  $this->showResults();
142 
143  return true;
144  }
145 
146  public function showResults()
147  {
148  global $rbacsystem, $lng, $ilUser,$rbacreview;
149 
150  $this->saveMailData();
151 
152  $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.mail_search.html", "Services/Mail");
153  $this->tpl->setVariable("HEADER", $this->lng->txt("mail"));
154 
155  $this->tpl->setVariable("ACTION", $this->ctrl->getFormAction($this));
156  $this->ctrl->clearParameters($this);
157 
158  $this->tpl->setVariable("TXT_SEARCH_FOR",$this->lng->txt("search_for"));
159  $this->tpl->setVariable("TXT_SEARCH_SYSTEM",$this->lng->txt("mail_search_system"));
160  $this->tpl->setVariable("TXT_SEARCH_ADDRESS",$this->lng->txt("mail_search_addressbook"));
161  $this->tpl->setVariable("BUTTON_SEARCH",$this->lng->txt("search"));
162  $this->tpl->setVariable("BUTTON_CANCEL",$this->lng->txt("cancel"));
163 
164  if (strlen(trim($_SESSION["mail_search_search"])) > 0)
165  {
166  $this->tpl->setVariable("VALUE_SEARCH_FOR", ilUtil::prepareFormOutput(trim($_SESSION["mail_search_search"]), true));
167  }
168 
169  if (!$_SESSION['mail_search_type_system'] && !$_SESSION['mail_search_type_addressbook'])
170  {
171  $this->tpl->setVariable('CHECKED_TYPE_SYSTEM', "checked=\"checked\"");
172  }
173  else
174  {
175  if ($_SESSION['mail_search_type_addressbook']) $this->tpl->setVariable('CHECKED_TYPE_ADDRESSBOOK', "checked=\"checked\"");
176  if ($_SESSION['mail_search_type_system'])$this->tpl->setVariable('CHECKED_TYPE_SYSTEM', "checked=\"checked\"");
177  }
178 
179  if ($_SESSION['mail_search_type_addressbook'] && strlen(trim($_SESSION["mail_search_search"])) >= 3)
180  {
181  $abook = new ilAddressbook($ilUser->getId());
182  $entries = $abook->searchUsers(addslashes(urldecode($_SESSION['mail_search_search'])));
183 
184  if (count($entries))
185  {
186  $tbl_addr = new ilTable2GUI($this);
187  $tbl_addr->setTitle($lng->txt('mail_addressbook'));
188  $tbl_addr->setRowTemplate('tpl.mail_search_addr_row.html', 'Services/Mail');
189 
190  $result = array();
191  $counter = 0;
192  foreach ($entries as $entry)
193  {
194  $result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_addr[]', ($entry['login'] ? $entry['login'] : $entry['email'])) .
195  ilUtil::formCheckbox(0, 'search_name_cc[]', ($entry['login'] ? $entry['login'] : $entry['email'])) .
196  ilUtil::formCheckbox(0, 'search_name_bcc[]', ($entry['login'] ? $entry['login'] : $entry['email']));
197  $result[$counter]['login'] = $entry['login'];
198  $result[$counter]['firstname'] = $entry['firstname'];
199  $result[$counter]['lastname'] = $entry['lastname'];
200 
201  $id = ilObjUser::_lookupId($entry['login']);
202  if (ilObjUser::_lookupPref($id, 'public_email') == 'y' || !$entry['login'])
203  {
204  $has_mail_addr = true;
205  $result[$counter]['email'] = $entry['email'];
206  }
207 
208  ++$counter;
209  }
210 
211  $tbl_addr->addColumn($this->lng->txt('mail_to') . '/' . $this->lng->txt('cc') . '/' . $this->lng->txt('bc'), 'check', '10%');
212  $tbl_addr->addColumn($this->lng->txt('login'), 'login', "15%");
213  $tbl_addr->addColumn($this->lng->txt('firstname'), 'firstname', "15%");
214  $tbl_addr->addColumn($this->lng->txt('lastname'), 'lastname', "15%");
215  if ($has_mail_addr)
216  {
217  foreach ($result as $key => $val)
218  {
219  if ($val['email'] == '') $result[$key]['email'] = '&nbsp;';
220  }
221 
222  $tbl_addr->addColumn($this->lng->txt('email'), 'email', "15%");
223  }
224  $tbl_addr->setData($result);
225 
226  $tbl_addr->setDefaultOrderField('login');
227  $tbl_addr->setPrefix('addr_');
228  $tbl_addr->enable('select_all');
229  $tbl_addr->setSelectAllCheckbox('search_name_to_addr');
230  $tbl_addr->setFormName('recipients');
231 
232  $this->tpl->setVariable('TABLE_ADDR', $tbl_addr->getHTML());
233  }
234  }
235  if ($_SESSION['mail_search_type_system'] && strlen(trim($_SESSION["mail_search_search"])) >= 3)
236  {
237  include_once 'Services/Search/classes/class.ilQueryParser.php';
238  include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
239  include_once 'Services/Search/classes/class.ilSearchResult.php';
240 
241  $all_results = new ilSearchResult();
242 
243  $query_parser = new ilQueryParser(ilUtil::stripSlashes($_SESSION['mail_search_search']));
244  $query_parser->setCombination(QP_COMBINATION_OR);
245  $query_parser->setMinWordLength(3);
246  $query_parser->parse();
247 
248  $user_search =& ilObjectSearchFactory::_getUserSearchInstance($query_parser);
249  $user_search->enableActiveCheck(true);
250  $user_search->setFields(array('login'));
251  $result_obj = $user_search->performSearch();
252  $all_results->mergeEntries($result_obj);
253 
254  $user_search->setFields(array('firstname'));
255  $result_obj = $user_search->performSearch();
256  $all_results->mergeEntries($result_obj);
257 
258  $user_search->setFields(array('lastname'));
259  $result_obj = $user_search->performSearch();
260  $all_results->mergeEntries($result_obj);
261 
262  $all_results->setMaxHits(100000);
263  $all_results->preventOverwritingMaxhits(true);
264  $all_results->filter(ROOT_FOLDER_ID,QP_COMBINATION_OR);
265 
266  $users = $all_results->getResults();
267  if (count($users))
268  {
269  $tbl_users = new ilTable2GUI($this);
270  $tbl_users->setTitle($lng->txt('system').': '.$lng->txt('persons'));
271  $tbl_users->setRowTemplate('tpl.mail_search_users_row.html','Services/Mail');
272 
273  $result = array();
274  $counter = 0;
275  foreach ($users as $user)
276  {
277  $login = ilObjUser::_lookupLogin($user['obj_id']);
278 
279  $result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_usr[]', $login) .
280  ilUtil::formCheckbox(0, 'search_name_cc[]', $login) .
281  ilUtil::formCheckbox(0, 'search_name_bcc[]', $login);
282  $result[$counter]['login'] = $login;
283 
284  if (ilObjUser::_lookupPref($user['obj_id'], 'public_profile') == 'y')
285  {
286  $name = ilObjUser::_lookupName($user['obj_id']);
287  $result[$counter]['firstname'] = $name['firstname'];
288  $result[$counter]['lastname'] = $name['lastname'];
289  }
290  else
291  {
292  $result[$counter]['firstname'] = '';
293  $result[$counter]['lastname'] = '';
294  }
295 
296  if (ilObjUser::_lookupPref($user['obj_id'], 'public_email') == 'y')
297  {
298  $has_mail_usr = true;
299  $result[$counter]['email'] = ilObjUser::_lookupEmail($user['obj_id']);
300  }
301 
302  ++$counter;
303  }
304 
305  $tbl_users->addColumn($this->lng->txt('mail_to') . '/' . $this->lng->txt('cc') . '/' . $this->lng->txt('bc'), 'check', '10%');
306  $tbl_users->addColumn($this->lng->txt('login'), 'login', '15%');
307  $tbl_users->addColumn($this->lng->txt('firstname'), 'firstname', '15%');
308  $tbl_users->addColumn($this->lng->txt('lastname'), 'lastname', '15%');
309  if ($has_mail_usr == true)
310  {
311  foreach ($result as $key => $val)
312  {
313  if ($val['email'] == '') $result[$key]['email'] = '&nbsp;';
314  }
315 
316  $tbl_users->addColumn($this->lng->txt('email'), 'email', '15%');
317  }
318  $tbl_users->setData($result);
319 
320  $tbl_users->setDefaultOrderField('login');
321  $tbl_users->setPrefix('usr_');
322  $tbl_users->enable('select_all');
323  $tbl_users->setSelectAllCheckbox('search_name_to_usr');
324  $tbl_users->setFormName('recipients');
325 
326  $this->tpl->setVariable('TABLE_USERS', $tbl_users->getHTML());
327  }
328 
329  $groups = ilUtil::searchGroups(addslashes(urldecode($_SESSION['mail_search_search'])));
330  if (count($groups))
331  {
332  $tbl_grp = new ilTable2GUI($this);
333  $tbl_grp->setTitle($lng->txt('system').': '.$lng->txt('groups'));
334  $tbl_grp->setRowTemplate('tpl.mail_search_groups_row.html','Services/Mail');
335 
336  $result = array();
337  $counter = 0;
338  foreach ($groups as $grp)
339  {
340  $members = array();
341 
342  // get roles
343  $roles = $rbacreview->getAssignableChildRoles($grp['ref_id']);
344  foreach ($roles as $role)
345  {
346  if (substr($role['title'], 0, 14) == 'il_grp_member_' ||
347  substr($role['title'], 0, 13) == 'il_grp_admin_')
348  {
349  array_push($members, $rbacreview->getRoleMailboxAddress($role['obj_id']));
350  }
351  }
352 
353  $str_members = implode(',', $members);
354 
355  $result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_grp[]', $str_members) .
356  ilUtil::formCheckbox(0, 'search_name_cc[]', $str_members) .
357  ilUtil::formCheckbox(0, 'search_name_bcc[]', $str_members);
358  $result[$counter]['title'] = $grp['title'];
359  $result[$counter]['description'] = $grp['description'];
360  ++$counter;
361  }
362  $tbl_grp->setData($result);
363 
364  $tbl_grp->addColumn($this->lng->txt('mail_to') . '/' . $this->lng->txt('cc') . '/' . $this->lng->txt('bc'), 'check', '10%');
365  $tbl_grp->addColumn($this->lng->txt('title'), 'title', '15%');
366  $tbl_grp->addColumn($this->lng->txt('description'), 'description', '15%');
367 
368  $tbl_grp->setDefaultOrderField('title');
369  $tbl_grp->setPrefix('grp_');
370  $tbl_grp->enable('select_all');
371  $tbl_grp->setSelectAllCheckbox('search_name_to_grp');
372  $tbl_grp->setFormName('recipients');
373 
374  $this->tpl->setVariable('TABLE_GRP', $tbl_grp->getHTML());
375  }
376  }
377 
378  if (count($users) || count($groups) || count($entries))
379  {
380  $this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("arrow_downright.gif"));
381  $this->tpl->setVariable("ALT_ARROW", '');
382  $this->tpl->setVariable('BUTTON_ADOPT', $this->lng->txt('adopt'));
383  }
384  else if (strlen(trim($_SESSION["mail_search_search"])) >= 3)
385  {
386  $this->lng->loadLanguageModule('search');
387  ilUtil::sendInfo($this->lng->txt('search_no_match'));
388  }
389 
390  $this->tpl->show();
391  }
392 }
393 ?>