ILIAS  Release_4_4_x_branch Revision 61816
 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/Contact/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($wsp_access_handler = null, $wsp_node_id = null)
47  {
48  global $tpl, $ilCtrl, $lng, $ilUser;
49 
50  $this->tpl = $tpl;
51  $this->ctrl = $ilCtrl;
52  $this->lng = $lng;
53 
54  // personal workspace
55  $this->wsp_access_handler = $wsp_access_handler;
56  $this->wsp_node_id = $wsp_node_id;
57 
58  $this->ctrl->saveParameter($this, "mobj_id");
59  $this->ctrl->saveParameter($this, "ref");
60 
61  $this->umail = new ilFormatMail($ilUser->getId());
62  }
63 
64  public function executeCommand()
65  {
66  $forward_class = $this->ctrl->getNextClass($this);
67  switch($forward_class)
68  {
69  default:
70  if (!($cmd = $this->ctrl->getCmd()))
71  {
72  $cmd = "showResults";
73  }
74 
75  $this->$cmd();
76  break;
77  }
78  return true;
79  }
80 
81  public function adopt()
82  {
83  // necessary because of select all feature of ilTable2GUI
84  $recipients = array();
85  $recipients = array_merge($recipients, (array)$_POST['search_name_to_addr']);
86  $recipients = array_merge($recipients, (array)$_POST['search_name_to_usr']);
87  $recipients = array_merge($recipients, (array)$_POST['search_name_to_grp']);
88 
89  $recipients = array_unique($recipients);
90 
91  $_SESSION["mail_search_results_to"] = $recipients;
92  $_SESSION["mail_search_results_cc"] = $_POST["search_name_cc"];
93  $_SESSION["mail_search_results_bcc"] = $_POST["search_name_bcc"];
94 
95  if($_GET["ref"] != "wsp")
96  {
97  $this->saveMailData();
98  }
99  else
100  {
101  $this->addPermission($recipients);
102  }
103 
104  $this->ctrl->returnToParent($this);
105  }
106 
107  private function saveMailData()
108  {
109  $mail_data = $this->umail->getSavedData();
110 
111  $this->umail->savePostData(
112  $mail_data["user_id"],
113  $mail_data["attachments"],
114  $mail_data["rcp_to"],
115  $mail_data["rcp_cc"],
116  $mail_data["rcp_bcc"],
117  $mail_data["m_type"],
118  $mail_data["m_email"],
119  $mail_data["m_subject"],
120  $mail_data["m_message"],
121  $mail_data["use_placeholders"]
122  );
123  }
124 
125  public function cancel()
126  {
127  $this->ctrl->returnToParent($this);
128  }
129 
130  function search()
131  {
132  $_SESSION["mail_search_search"] = $_POST["search"];
133 
134  if (strlen(trim($_SESSION["mail_search_search"])) == 0)
135  {
136  ilUtil::sendInfo($this->lng->txt("mail_insert_query"));
137  }
138  else if(strlen(trim($_SESSION["mail_search_search"])) < 3)
139  {
140  $this->lng->loadLanguageModule('search');
141  ilUtil::sendInfo($this->lng->txt('search_minimum_three'));
142  }
143 
144  $this->showResults();
145 
146  return true;
147  }
148 
149  protected function initSearchForm()
150  {
151  global $ilCtrl;
152 
153  if($_GET["ref"] != "wsp")
154  {
155  $this->saveMailData();
156  $title = $this->lng->txt('search_recipients');
157  }
158  else
159  {
160  $this->lng->loadLanguageModule("wsp");
161  $title = $this->lng->txt("wsp_share_search_users");
162  }
163 
164  // searchform
165  include_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
166  $form = new ilPropertyFormGUI();
167  $form->setTitle($title);
168  $form->setId('search_rcp');
169  $form->setFormAction($ilCtrl->getFormAction($this, 'search'));
170 
171  $inp = new ilTextInputGUI($this->lng->txt("search_for"), 'search');
172  $inp->setSize(30);
173  if (strlen(trim($_SESSION["mail_search_search"])) > 0)
174  {
175  $inp->setValue(ilUtil::prepareFormOutput(trim($_SESSION["mail_search_search"]), true));
176  }
177  $form->addItem($inp);
178 
179  $form->addCommandButton('search', $this->lng->txt("search"));
180  $form->addCommandButton('cancel', $this->lng->txt("cancel"));
181 
182  return $form;
183  }
184 
185  public function showResults()
186  {
187  global $lng, $ilUser, $rbacreview, $ilObjDataCache;
188 
189  $form = $this->initSearchForm();
190 
191  $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.mail_search.html", "Services/Contact");
192  $this->tpl->setVariable("ACTION", $this->ctrl->getFormAction($this));
193  $this->tpl->setTitle($this->lng->txt("mail"));
194  $this->tpl->setVariable('SEARCHFORM', $form->getHtml());
195 
196  // #14109
197  if(strlen($_SESSION['mail_search_search']) < 3)
198  {
199  if($_GET["ref"] != "wsp")
200  {
201  $this->tpl->show();
202  }
203  return;
204  }
205 
206  $abook = new ilAddressbook($ilUser->getId());
207  $entries = $abook->searchUsers(addslashes(urldecode($_SESSION['mail_search_search'])));
208 
209  // remove all contacts who are not registered users for personal workspace
210  if($_GET["ref"] == "wsp")
211  {
212  foreach($entries as $idx => $entry)
213  {
214  if(!$entry["login"])
215  {
216  unset($entries[$idx]);
217  }
218  }
219  }
220 
221  if(count($entries))
222  {
223  $tbl_addr = new ilTable2GUI($this);
224  $tbl_addr->setTitle($lng->txt('mail_addressbook'));
225  $tbl_addr->setRowTemplate('tpl.mail_search_addr_row.html', 'Services/Contact');
226 
227  $result = array();
228  $counter = 0;
229  foreach($entries as $entry)
230  {
231  if($_GET["ref"] != "wsp")
232  {
233  $result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_addr[]', ($entry['login'] ? $entry['login'] : $entry['email'])) .
234  ilUtil::formCheckbox(0, 'search_name_cc[]', ($entry['login'] ? $entry['login'] : $entry['email'])) .
235  ilUtil::formCheckbox(0, 'search_name_bcc[]', ($entry['login'] ? $entry['login'] : $entry['email']));
236  }
237  else
238  {
239  $user_id = ilObjUser::_loginExists($entry["login"]);
240  $result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_addr[]', $user_id);
241  }
242 
243  $result[$counter]['login'] = $entry['login'];
244  $result[$counter]['firstname'] = $entry['firstname'];
245  $result[$counter]['lastname'] = $entry['lastname'];
246 
247  $id = ilObjUser::_lookupId($entry['login']);
248  if(ilObjUser::_lookupPref($id, 'public_email') == 'y' || !$entry['login'])
249  {
250  $has_mail_addr = true;
251  $result[$counter]['email'] = $entry['email'];
252  }
253 
254  ++$counter;
255  }
256 
257  if($_GET["ref"] != "wsp")
258  {
259  $tbl_addr->addColumn($this->lng->txt('mail_to') . '/' . $this->lng->txt('cc') . '/' . $this->lng->txt('bc'), 'check', '10%');
260  }
261  else
262  {
263  $tbl_addr->addColumn("", "", "1%");
264  }
265  $tbl_addr->addColumn($this->lng->txt('login'), 'login', "15%");
266  $tbl_addr->addColumn($this->lng->txt('firstname'), 'firstname', "15%");
267  $tbl_addr->addColumn($this->lng->txt('lastname'), 'lastname', "15%");
268  if($has_mail_addr)
269  {
270  foreach($result as $key => $val)
271  {
272  if($val['email'] == '') $result[$key]['email'] = '&nbsp;';
273  }
274 
275  $tbl_addr->addColumn($this->lng->txt('email'), 'email', "15%");
276  }
277  $tbl_addr->setData($result);
278 
279  $tbl_addr->setDefaultOrderField('login');
280  $tbl_addr->setPrefix('addr_');
281  $tbl_addr->enable('select_all');
282  $tbl_addr->setSelectAllCheckbox('search_name_to_addr');
283  $tbl_addr->setFormName('recipients');
284 
285  $this->tpl->setVariable('TABLE_ADDR', $tbl_addr->getHTML());
286  }
287 
288  include_once 'Services/Search/classes/class.ilQueryParser.php';
289  include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
290  include_once 'Services/Search/classes/class.ilSearchResult.php';
291 
292  $all_results = new ilSearchResult();
293 
294  $query_parser = new ilQueryParser(addcslashes($_SESSION['mail_search_search'], '%_'));
295  $query_parser->setCombination(QP_COMBINATION_AND);
296  $query_parser->setMinWordLength(3);
297  $query_parser->parse();
298 
299  $user_search =& ilObjectSearchFactory::_getUserSearchInstance($query_parser);
300  $user_search->enableActiveCheck(true);
301  $user_search->setFields(array('login'));
302  $result_obj = $user_search->performSearch();
303  $all_results->mergeEntries($result_obj);
304 
305  $user_search->setFields(array('firstname'));
306  $result_obj = $user_search->performSearch();
307  $all_results->mergeEntries($result_obj);
308 
309  $user_search->setFields(array('lastname'));
310  $result_obj = $user_search->performSearch();
311  $all_results->mergeEntries($result_obj);
312 
313  $all_results->setMaxHits(100000);
314  $all_results->preventOverwritingMaxhits(true);
315  $all_results->filter(ROOT_FOLDER_ID, true);
316 
317  // Filter users (depends on setting in user accounts)
318  include_once 'Services/User/classes/class.ilUserFilter.php';
319  $users = ilUserFilter::getInstance()->filter($all_results->getResultIds());
320  if(count($users))
321  {
322  $tbl_users = new ilTable2GUI($this);
323  $tbl_users->setTitle($lng->txt('system') . ': ' . $lng->txt('persons'));
324  $tbl_users->setRowTemplate('tpl.mail_search_users_row.html', 'Services/Contact');
325 
326  $result = array();
327  $counter = 0;
328  foreach($users as $user)
329  {
330  $login = ilObjUser::_lookupLogin($user);
331 
332  if($_GET["ref"] != "wsp")
333  {
334  $result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_usr[]', $login) .
335  ilUtil::formCheckbox(0, 'search_name_cc[]', $login) .
336  ilUtil::formCheckbox(0, 'search_name_bcc[]', $login);
337  }
338  else
339  {
340  $result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_usr[]', $user);
341  }
342  $result[$counter]['login'] = $login;
343 
344  if(in_array(ilObjUser::_lookupPref($user, 'public_profile'), array('y', "g")))
345  {
346  $name = ilObjUser::_lookupName($user);
347  $result[$counter]['firstname'] = $name['firstname'];
348  $result[$counter]['lastname'] = $name['lastname'];
349  }
350  else
351  {
352  $result[$counter]['firstname'] = '';
353  $result[$counter]['lastname'] = '';
354  }
355 
356  if(ilObjUser::_lookupPref($user, 'public_email') == 'y')
357  {
358  $has_mail_usr = true;
359  $result[$counter]['email'] = ilObjUser::_lookupEmail($user);
360  }
361 
362  ++$counter;
363  }
364 
365  if($_GET["ref"] != "wsp")
366  {
367  $tbl_users->addColumn($this->lng->txt('mail_to') . '/' . $this->lng->txt('cc') . '/' . $this->lng->txt('bc'), 'check', '10%');
368  }
369  else
370  {
371  $tbl_users->addColumn("", "", "1%");
372  }
373  $tbl_users->addColumn($this->lng->txt('login'), 'login', '15%');
374  $tbl_users->addColumn($this->lng->txt('firstname'), 'firstname', '15%');
375  $tbl_users->addColumn($this->lng->txt('lastname'), 'lastname', '15%');
376  if($has_mail_usr == true)
377  {
378  foreach($result as $key => $val)
379  {
380  if($val['email'] == '') $result[$key]['email'] = '&nbsp;';
381  }
382 
383  $tbl_users->addColumn($this->lng->txt('email'), 'email', '15%');
384  }
385  $tbl_users->setData($result);
386 
387  $tbl_users->setDefaultOrderField('login');
388  $tbl_users->setPrefix('usr_');
389  $tbl_users->enable('select_all');
390  $tbl_users->setSelectAllCheckbox('search_name_to_usr');
391  $tbl_users->setFormName('recipients');
392 
393  $this->tpl->setVariable('TABLE_USERS', $tbl_users->getHTML());
394  }
395 
396  include_once 'Services/Search/classes/class.ilQueryParser.php';
397  include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
398  include_once 'Services/Search/classes/class.ilSearchResult.php';
399  include_once 'Services/Membership/classes/class.ilParticipants.php';
400 
401  $group_results = new ilSearchResult();
402 
403  $query_parser = new ilQueryParser(addcslashes($_SESSION['mail_search_search'], '%_'));
404  $query_parser->setCombination(QP_COMBINATION_AND);
405  $query_parser->setMinWordLength(3);
406  $query_parser->parse();
407 
408  $search = ilObjectSearchFactory::_getObjectSearchInstance($query_parser);
409  $search->setFilter(array('grp'));
410  $result = $search->performSearch();
411  $group_results->mergeEntries($result);
412  $group_results->setMaxHits(PHP_INT_MAX);
413  $group_results->preventOverwritingMaxhits(true);
414  $group_results->setRequiredPermission('read');
415  $group_results->filter(ROOT_FOLDER_ID, true);
416 
417  $visible_groups = array();
418  if($group_results->getResults())
419  {
420  $tbl_grp = new ilTable2GUI($this);
421  $tbl_grp->setTitle($lng->txt('system') . ': ' . $lng->txt('groups'));
422  $tbl_grp->setRowTemplate('tpl.mail_search_groups_row.html', 'Services/Contact');
423 
424  $result = array();
425  $counter = 0;
426 
427  $ilObjDataCache->preloadReferenceCache(array_keys($group_results->getResults()));
428 
429  $groups = $group_results->getResults();
430  foreach($groups as $grp)
431  {
432  if(!ilParticipants::hasParticipantListAccess($grp['obj_id']))
433  {
434  continue;
435  }
436 
437  if($_GET["ref"] != "wsp")
438  {
439  $members = array();
440  $roles = $rbacreview->getAssignableChildRoles($grp['ref_id']);
441  foreach($roles as $role)
442  {
443  if(substr($role['title'], 0, 14) == 'il_grp_member_' ||
444  substr($role['title'], 0, 13) == 'il_grp_admin_'
445  )
446  {
447  // does not work if Pear is enabled and Mailbox Address contain special chars!!
448  //array_push($members, $rbacreview->getRoleMailboxAddress($role['obj_id']));
449  // FIX for Mantis: 7523
450  array_push($members, '#' . $role['title']);
451  }
452  }
453  $str_members = implode(',', $members);
454 
455  $result[$counter]['check'] =
456  ilUtil::formCheckbox(0, 'search_name_to_grp[]', $str_members) .
457  ilUtil::formCheckbox(0, 'search_name_cc[]', $str_members) .
458  ilUtil::formCheckbox(0, 'search_name_bcc[]', $str_members);
459  }
460  else
461  {
462  $result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_grp[]', $grp['obj_id']);
463  }
464  $result[$counter]['title'] = $ilObjDataCache->lookupTitle($grp['obj_id']);
465  $result[$counter]['description'] = $ilObjDataCache->lookupDescription($grp['obj_id']);
466 
467  ++$counter;
468  $visible_groups[] = $grp;
469  }
470 
471  if($visible_groups)
472  {
473  $tbl_grp->setData($result);
474 
475  if($_GET["ref"] != "wsp")
476  {
477  $tbl_grp->addColumn($this->lng->txt('mail_to') . '/' . $this->lng->txt('cc') . '/' . $this->lng->txt('bc'), 'check', '10%');
478  }
479  else
480  {
481  $tbl_grp->addColumn("", "", "1%");
482  }
483  $tbl_grp->addColumn($this->lng->txt('title'), 'title', '15%');
484  $tbl_grp->addColumn($this->lng->txt('description'), 'description', '15%');
485 
486  $tbl_grp->setDefaultOrderField('title');
487  $tbl_grp->setPrefix('grp_');
488  $tbl_grp->enable('select_all');
489  $tbl_grp->setSelectAllCheckbox('search_name_to_grp');
490  $tbl_grp->setFormName('recipients');
491 
492  $this->tpl->setVariable('TABLE_GRP', $tbl_grp->getHTML());
493  }
494  }
495 
496  if(count($users) || count($visible_groups) || count($entries))
497  {
498  $this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("arrow_downright.png"));
499  $this->tpl->setVariable("ALT_ARROW", '');
500 
501  if($_GET["ref"] != "wsp")
502  {
503  $this->tpl->setVariable('BUTTON_ADOPT', $this->lng->txt('adopt'));
504  }
505  else
506  {
507  $this->tpl->setVariable('BUTTON_ADOPT', $this->lng->txt('wsp_share_with_users'));
508  }
509  }
510  else
511  {
512  $this->lng->loadLanguageModule('search');
513  ilUtil::sendInfo($this->lng->txt('search_no_match'));
514  }
515 
516  if($_GET["ref"] != "wsp")
517  {
518  $this->tpl->show();
519  }
520  }
521 
522  protected function addPermission($a_obj_ids)
523  {
524  if(!is_array($a_obj_ids))
525  {
526  $a_obj_ids = array($a_obj_ids);
527  }
528 
529  $existing = $this->wsp_access_handler->getPermissions($this->wsp_node_id);
530  $added = false;
531  foreach($a_obj_ids as $object_id)
532  {
533  if(!in_array($object_id, $existing))
534  {
535  $added = $this->wsp_access_handler->addPermission($this->wsp_node_id, $object_id);
536  }
537  }
538 
539  if($added)
540  {
541  ilUtil::sendSuccess($this->lng->txt("wsp_share_success"), true);
542  }
543  }
544 }
545 ?>