ILIAS  Release_4_2_x_branch Revision 61807
 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  $_SESSION["mail_search_type_system"] = $_POST["type_system"];
134  $_SESSION["mail_search_type_addressbook"] = $_POST["type_addressbook"];
135 
136  // IF NO TYPE IS GIVEN SEARCH IN BOTH 'system' and 'addressbook'
137  if(!$_SESSION["mail_search_type_system"] &&
138  !$_SESSION["mail_search_type_addressbook"])
139  {
140  $_SESSION["mail_search_type_system"] = 1;
141  $_SESSION["mail_search_type_addressbook"] = 1;
142  }
143  if (strlen(trim($_SESSION["mail_search_search"])) == 0)
144  {
145  ilUtil::sendInfo($this->lng->txt("mail_insert_query"));
146  }
147  else if(strlen(trim($_SESSION["mail_search_search"])) < 3)
148  {
149  $this->lng->loadLanguageModule('search');
150  ilUtil::sendInfo($this->lng->txt('search_minimum_three'));
151  }
152 
153  $this->showResults();
154 
155  return true;
156  }
157 
158  protected function initSearchForm()
159  {
160  global $ilCtrl;
161 
162  if($_GET["ref"] != "wsp")
163  {
164  $this->saveMailData();
165  $title = $this->lng->txt('search_recipients');
166  }
167  else
168  {
169  $this->lng->loadLanguageModule("wsp");
170  $title = $this->lng->txt("wsp_share_search_users");
171  }
172 
173  // searchform
174  include_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
175  $form = new ilPropertyFormGUI();
176  $form->setTitle($title);
177  $form->setId('search_rcp');
178  $form->setFormAction($ilCtrl->getFormAction($this, 'search'));
179 
180  $inp = new ilTextInputGUI($this->lng->txt("search_for"), 'search');
181  $inp->setSize(30);
182  if (strlen(trim($_SESSION["mail_search_search"])) > 0)
183  {
184  $inp->setValue(ilUtil::prepareFormOutput(trim($_SESSION["mail_search_search"]), true));
185  }
186  $form->addItem($inp);
187 
188  $chb = new ilCheckboxInputGUI($this->lng->txt("mail_search_addressbook"), 'type_addressbook');
189  if ($_SESSION['mail_search_type_addressbook'])
190  $chb->setChecked(true);
191  $inp->addSubItem($chb);
192 
193  $chb = new ilCheckboxInputGUI($this->lng->txt("mail_search_system"), 'type_system');
194  if ($_SESSION['mail_search_type_system'])
195  $chb->setChecked(true);
196  $inp->addSubItem($chb);
197 
198  $form->addCommandButton('search', $this->lng->txt("search"));
199  $form->addCommandButton('cancel', $this->lng->txt("cancel"));
200 
201  return $form;
202  }
203 
204  public function showResults()
205  {
206  global $rbacsystem, $lng, $ilUser, $ilCtrl, $rbacreview;
207 
208  $form = $this->initSearchForm();
209 
210  $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.mail_search.html", "Services/Contact");
211  $this->tpl->setTitle($this->lng->txt("mail"));
212 
213  $this->tpl->setVariable("ACTION", $this->ctrl->getFormAction($this));
214 
215  $this->tpl->setVariable('SEARCHFORM', $form->getHtml());
216 
217  if (strlen(trim($_SESSION["mail_search_search"])) > 0)
218  {
219  $this->tpl->setVariable("VALUE_SEARCH_FOR", ilUtil::prepareFormOutput(trim($_SESSION["mail_search_search"]), true));
220  }
221 
222  if (!$_SESSION['mail_search_type_system'] && !$_SESSION['mail_search_type_addressbook'])
223  {
224  $this->tpl->setVariable('CHECKED_TYPE_SYSTEM', "checked=\"checked\"");
225  }
226  else
227  {
228  if ($_SESSION['mail_search_type_addressbook']) $this->tpl->setVariable('CHECKED_TYPE_ADDRESSBOOK', "checked=\"checked\"");
229  if ($_SESSION['mail_search_type_system'])$this->tpl->setVariable('CHECKED_TYPE_SYSTEM', "checked=\"checked\"");
230  }
231 
232  if ($_SESSION['mail_search_type_addressbook'] && strlen(trim($_SESSION["mail_search_search"])) >= 3)
233  {
234  $abook = new ilAddressbook($ilUser->getId());
235  $entries = $abook->searchUsers(addslashes(urldecode($_SESSION['mail_search_search'])));
236 
237  // remove all contacts who are not registered users for personal workspace
238  if($_GET["ref"] == "wsp")
239  {
240  foreach($entries as $idx => $entry)
241  {
242  if(!$entry["login"])
243  {
244  unset($entries[$idx]);
245  }
246  }
247  }
248 
249  if (count($entries))
250  {
251  $tbl_addr = new ilTable2GUI($this);
252  $tbl_addr->setTitle($lng->txt('mail_addressbook'));
253  $tbl_addr->setRowTemplate('tpl.mail_search_addr_row.html', 'Services/Contact');
254 
255  $result = array();
256  $counter = 0;
257  foreach ($entries as $entry)
258  {
259  if($_GET["ref"] != "wsp")
260  {
261  $result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_addr[]', ($entry['login'] ? $entry['login'] : $entry['email'])) .
262  ilUtil::formCheckbox(0, 'search_name_cc[]', ($entry['login'] ? $entry['login'] : $entry['email'])) .
263  ilUtil::formCheckbox(0, 'search_name_bcc[]', ($entry['login'] ? $entry['login'] : $entry['email']));
264  }
265  else
266  {
267  $user_id = ilObjUser::_loginExists($entry["login"]);
268  $result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_addr[]', $user_id);
269  }
270 
271  $result[$counter]['login'] = $entry['login'];
272  $result[$counter]['firstname'] = $entry['firstname'];
273  $result[$counter]['lastname'] = $entry['lastname'];
274 
275  $id = ilObjUser::_lookupId($entry['login']);
276  if (ilObjUser::_lookupPref($id, 'public_email') == 'y' || !$entry['login'])
277  {
278  $has_mail_addr = true;
279  $result[$counter]['email'] = $entry['email'];
280  }
281 
282  ++$counter;
283  }
284 
285  if($_GET["ref"] != "wsp")
286  {
287  $tbl_addr->addColumn($this->lng->txt('mail_to') . '/' . $this->lng->txt('cc') . '/' . $this->lng->txt('bc'), 'check', '10%');
288  }
289  else
290  {
291  $tbl_addr->addColumn("", "", "1%");
292  }
293  $tbl_addr->addColumn($this->lng->txt('login'), 'login', "15%");
294  $tbl_addr->addColumn($this->lng->txt('firstname'), 'firstname', "15%");
295  $tbl_addr->addColumn($this->lng->txt('lastname'), 'lastname', "15%");
296  if ($has_mail_addr)
297  {
298  foreach ($result as $key => $val)
299  {
300  if ($val['email'] == '') $result[$key]['email'] = '&nbsp;';
301  }
302 
303  $tbl_addr->addColumn($this->lng->txt('email'), 'email', "15%");
304  }
305  $tbl_addr->setData($result);
306 
307  $tbl_addr->setDefaultOrderField('login');
308  $tbl_addr->setPrefix('addr_');
309  $tbl_addr->enable('select_all');
310  $tbl_addr->setSelectAllCheckbox('search_name_to_addr');
311  $tbl_addr->setFormName('recipients');
312 
313  $this->tpl->setVariable('TABLE_ADDR', $tbl_addr->getHTML());
314  }
315  }
316  if ($_SESSION['mail_search_type_system'] && strlen(trim($_SESSION["mail_search_search"])) >= 3)
317  {
318  include_once 'Services/Search/classes/class.ilQueryParser.php';
319  include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
320  include_once 'Services/Search/classes/class.ilSearchResult.php';
321 
322  $all_results = new ilSearchResult();
323 
324  $query_parser = new ilQueryParser(addcslashes($_SESSION['mail_search_search'],'%_'));
325  $query_parser->setCombination(QP_COMBINATION_OR);
326  $query_parser->setMinWordLength(3);
327  $query_parser->parse();
328 
329  $user_search =& ilObjectSearchFactory::_getUserSearchInstance($query_parser);
330  $user_search->enableActiveCheck(true);
331  $user_search->setFields(array('login'));
332  $result_obj = $user_search->performSearch();
333  $all_results->mergeEntries($result_obj);
334 
335  $user_search->setFields(array('firstname'));
336  $result_obj = $user_search->performSearch();
337  $all_results->mergeEntries($result_obj);
338 
339  $user_search->setFields(array('lastname'));
340  $result_obj = $user_search->performSearch();
341  $all_results->mergeEntries($result_obj);
342 
343  $all_results->setMaxHits(100000);
344  $all_results->preventOverwritingMaxhits(true);
345  $all_results->filter(ROOT_FOLDER_ID,QP_COMBINATION_OR);
346 
347 
348  //$users = $all_results->getResults();
349 
350  // Filter users (depends on setting in user accounts)
351  include_once './Services/User/classes/class.ilUserFilter.php';
352  $users = ilUserFilter::getInstance()->filter($all_results->getResultIds());
353 
354 
355  if (count($users))
356  {
357  $tbl_users = new ilTable2GUI($this);
358  $tbl_users->setTitle($lng->txt('system').': '.$lng->txt('persons'));
359  $tbl_users->setRowTemplate('tpl.mail_search_users_row.html','Services/Contact');
360 
361  $result = array();
362  $counter = 0;
363  foreach ($users as $user)
364  {
365  $login = ilObjUser::_lookupLogin($user);
366 
367  if($_GET["ref"] != "wsp")
368  {
369  $result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_usr[]', $login) .
370  ilUtil::formCheckbox(0, 'search_name_cc[]', $login) .
371  ilUtil::formCheckbox(0, 'search_name_bcc[]', $login);
372  }
373  else
374  {
375  $result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_usr[]', $user);
376  }
377  $result[$counter]['login'] = $login;
378 
379  if (in_array(ilObjUser::_lookupPref($user, 'public_profile'), array('y',"g")))
380  {
381  $name = ilObjUser::_lookupName($user);
382  $result[$counter]['firstname'] = $name['firstname'];
383  $result[$counter]['lastname'] = $name['lastname'];
384  }
385  else
386  {
387  $result[$counter]['firstname'] = '';
388  $result[$counter]['lastname'] = '';
389  }
390 
391  if (ilObjUser::_lookupPref($user, 'public_email') == 'y')
392  {
393  $has_mail_usr = true;
394  $result[$counter]['email'] = ilObjUser::_lookupEmail($user);
395  }
396 
397  ++$counter;
398  }
399 
400  if($_GET["ref"] != "wsp")
401  {
402  $tbl_users->addColumn($this->lng->txt('mail_to') . '/' . $this->lng->txt('cc') . '/' . $this->lng->txt('bc'), 'check', '10%');
403  }
404  else
405  {
406  $tbl_users->addColumn("", "", "1%");
407  }
408  $tbl_users->addColumn($this->lng->txt('login'), 'login', '15%');
409  $tbl_users->addColumn($this->lng->txt('firstname'), 'firstname', '15%');
410  $tbl_users->addColumn($this->lng->txt('lastname'), 'lastname', '15%');
411  if ($has_mail_usr == true)
412  {
413  foreach ($result as $key => $val)
414  {
415  if ($val['email'] == '') $result[$key]['email'] = '&nbsp;';
416  }
417 
418  $tbl_users->addColumn($this->lng->txt('email'), 'email', '15%');
419  }
420  $tbl_users->setData($result);
421 
422  $tbl_users->setDefaultOrderField('login');
423  $tbl_users->setPrefix('usr_');
424  $tbl_users->enable('select_all');
425  $tbl_users->setSelectAllCheckbox('search_name_to_usr');
426  $tbl_users->setFormName('recipients');
427 
428  $this->tpl->setVariable('TABLE_USERS', $tbl_users->getHTML());
429  }
430 
431  $groups = ilUtil::searchGroups(addslashes(urldecode(addcslashes($_SESSION['mail_search_search'],'%_'))));
432 
433  if (count($groups))
434  {
435  $tbl_grp = new ilTable2GUI($this);
436  $tbl_grp->setTitle($lng->txt('system').': '.$lng->txt('groups'));
437  $tbl_grp->setRowTemplate('tpl.mail_search_groups_row.html','Services/Contact');
438 
439  $result = array();
440  $counter = 0;
441 
442 
443  foreach ($groups as $grp)
444  {
445  if($_GET["ref"] != "wsp")
446  {
447  $members = array();
448  $roles = $rbacreview->getAssignableChildRoles($grp['ref_id']);
449  foreach ($roles as $role)
450  {
451  if (substr($role['title'], 0, 14) == 'il_grp_member_' ||
452  substr($role['title'], 0, 13) == 'il_grp_admin_')
453  {
454  // does not work if Pear is enabled and Mailbox Address contain special chars!!
455  //array_push($members, $rbacreview->getRoleMailboxAddress($role['obj_id']));
456  // FIX for Mantis: 7523
457  array_push($members, '#'.$role['title']);
458  }
459  }
460  $str_members = implode(',',$members);
461 
462  $result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_grp[]', $str_members) .
463  ilUtil::formCheckbox(0, 'search_name_cc[]', $str_members) .
464  ilUtil::formCheckbox(0, 'search_name_bcc[]',$str_members);
465  }
466  else
467  {
468  $result[$counter]['check'] = ilUtil::formCheckbox(0, 'search_name_to_grp[]', ilObject::_lookupObjId($grp['ref_id']));
469  }
470  $result[$counter]['title'] = $grp['title'];
471  $result[$counter]['description'] = $grp['description'];
472 
473  ++$counter;
474  }
475  $tbl_grp->setData($result);
476 
477  if($_GET["ref"] != "wsp")
478  {
479  $tbl_grp->addColumn($this->lng->txt('mail_to') . '/' . $this->lng->txt('cc') . '/' . $this->lng->txt('bc'), 'check', '10%');
480  }
481  else
482  {
483  $tbl_grp->addColumn("", "", "1%");
484  }
485  $tbl_grp->addColumn($this->lng->txt('title'), 'title', '15%');
486  $tbl_grp->addColumn($this->lng->txt('description'), 'description', '15%');
487 
488  $tbl_grp->setDefaultOrderField('title');
489  $tbl_grp->setPrefix('grp_');
490  $tbl_grp->enable('select_all');
491  $tbl_grp->setSelectAllCheckbox('search_name_to_grp');
492  $tbl_grp->setFormName('recipients');
493 
494  $this->tpl->setVariable('TABLE_GRP', $tbl_grp->getHTML());
495  }
496  }
497 
498  if (count($users) || count($groups) || count($entries))
499  {
500  $this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("arrow_downright.gif"));
501  $this->tpl->setVariable("ALT_ARROW", '');
502 
503  if($_GET["ref"] != "wsp")
504  {
505  $this->tpl->setVariable('BUTTON_ADOPT', $this->lng->txt('adopt'));
506  }
507  else
508  {
509  $this->tpl->setVariable('BUTTON_ADOPT', $this->lng->txt('wsp_share_with_users'));
510  }
511  }
512  else if (strlen(trim($_SESSION["mail_search_search"])) >= 3)
513  {
514  $this->lng->loadLanguageModule('search');
515  ilUtil::sendInfo($this->lng->txt('search_no_match'));
516  }
517 
518  if($_GET["ref"] != "wsp")
519  {
520  $this->tpl->show();
521  }
522  }
523 
524  protected function addPermission($a_obj_ids)
525  {
526  if(!is_array($a_obj_ids))
527  {
528  $a_obj_ids = array($a_obj_ids);
529  }
530 
531  $existing = $this->wsp_access_handler->getPermissions($this->wsp_node_id);
532  $added = false;
533  foreach($a_obj_ids as $object_id)
534  {
535  if(!in_array($object_id, $existing))
536  {
537  $added = $this->wsp_access_handler->addPermission($this->wsp_node_id, $object_id);
538  }
539  }
540 
541  if($added)
542  {
543  ilUtil::sendSuccess($this->lng->txt("wsp_share_success"), true);
544  }
545  }
546 }
547 ?>