Namespaces

Classes

Traits

Functions

1: <?php
2:
3: /**
4: * Advanced search modules
5: * @package modules
6: * @subpackage advanced_search
7: */
8:
9: if (!defined('DEBUG_MODE')) { die(); }
10:
11:
12: /**
13: * Setup advanced search
14: * @subpackage advanced_search/output
15: */
16: class Hm_Handler_advanced_search_prepare extends Hm_Handler_Module {
17:
18: public function process() {
19: $this->out('msg_list_icons', $this->user_config->get('show_list_icons_setting', DEFAULT_SHOW_LIST_ICONS));
20: $this->out('imap_supported', $this->module_is_supported('imap'));
21: $this->out('list_parent', 'advanced_search');
22: }
23: }
24:
25: /**
26: * Process an advanced search ajax request
27: * @subpackage advanced_search/output
28: */
29: class Hm_Handler_process_adv_search_request extends Hm_Handler_Module {
30:
31: private $imap_id;
32: private $folder;
33:
34: public function process() {
35: if (!$this->module_is_supported('imap')) {
36: return;
37: }
38: list($success, $form) = $this->process_form(array(
39: 'adv_source',
40: 'adv_start',
41: 'adv_end',
42: 'adv_source_limit',
43: 'adv_terms',
44: 'adv_targets'
45: ));
46: if (!$success) {
47: return;
48: }
49: $limit = $form['adv_source_limit'];
50: if (!$limit || !is_int($limit) || (is_int($limit) && $limit > 1000)) {
51: $limit = 100;
52: }
53: if (!$this->validate_date($form['adv_start']) ||
54: !$this->validate_date($form['adv_end'])) {
55: Hm_Msgs::add('Invalid date format', 'warning');
56: return;
57: }
58: $flags = array('ALL');
59: if (array_key_exists('adv_flags', $this->request->post)) {
60: if (!$this->validate_flags($this->request->post['adv_flags'])) {
61: Hm_Msgs::add('Invalid flag', 'warning');
62: return;
63: }
64: $flags = $this->request->post['adv_flags'];
65: }
66: if (!$this->validate_source($form['adv_source'])) {
67: Hm_Msgs::add('Invalid source', 'warning');
68: return;
69: }
70: $charset = false;
71: if (array_key_exists('charset', $this->request->post) &&
72: in_array($this->request->post, array('UTF-8', 'ASCII'), true)) {
73: $charset = $this->request->post['charset'];
74: }
75:
76: $mailbox = Hm_IMAP_List::get_connected_mailbox($this->imap_id, $this->cache);
77: if (! $mailbox || ! $mailbox->authed()) {
78: return;
79: }
80: if ($charset) {
81: $mailbox->set_search_charset($charset);
82: }
83: $params = array(
84: array('SENTBEFORE', date('j-M-Y', strtotime($form['adv_end']))),
85: array('SENTSINCE', date('j-M-Y', strtotime($form['adv_start'])))
86: );
87: foreach ($form['adv_terms'] as $term) {
88: foreach ($form['adv_targets'] as $target) {
89: $params[] = array($target, $term);
90: }
91: }
92:
93: $searchInAllFolders = $this->request->post['all_folders'] ?? false;
94: $searchInSpecialFolders = $this->request->post['all_special_folders'] ?? false;
95: $includeSubfolders = $this->request->post['include_subfolders'] ?? false;
96: if ($searchInAllFolders) {
97: $msg_list = $this->all_folders_search($mailbox, $flags, $params, $limit);
98: } elseif ($searchInSpecialFolders) {
99: $msg_list = $this->special_folders_search($mailbox, $flags, $params, $limit);
100: } else if ($includeSubfolders) {
101: $msg_list = $this->all_folders_search($mailbox, $flags, $params, $limit, $this->folder);
102: } else if (! $mailbox->select_folder($this->folder)) {
103: return;
104: } else {
105: $msg_list = $this->imap_search($flags, $mailbox, $params, $limit);
106: }
107: $this->out('imap_search_results', $msg_list);
108: $this->out('folder_status', $mailbox->get_folder_state());
109: $this->out('imap_server_ids', array($this->imap_id));
110: }
111:
112: private function all_folders_search($mailbox, $flags, $params, $limit, $parent = '') {
113: if ($parent) {
114: $folders = $mailbox->get_subfolders($parent);
115: } else {
116: $folders = $mailbox->get_folders();
117: }
118: $msg_list = array();
119: foreach ($folders as $folder) {
120: $this->folder = $folder['name'];
121: $msgs = $this->imap_search($flags, $mailbox, $params, $limit);
122: $msg_list = array_merge($msg_list, $msgs);
123: }
124: return $msg_list;
125: }
126:
127: private function special_folders_search($mailbox, $flags, $params, $limit) {
128: $specials = $this->user_config->get('special_imap_folders', array());
129: $folders = $specials[$this->imap_id] ?? [];
130:
131: $msg_list = array();
132: foreach ($folders as $folder) {
133: $this->folder = $folder;
134: $mailbox->select_folder($this->folder);
135: $msgs = $this->imap_search($flags, $mailbox, $params, $limit);
136: $msg_list = array_merge($msg_list, $msgs);
137: }
138: return $msg_list;
139: }
140:
141: private function imap_search($flags, $mailbox, $params, $limit) {
142: $msg_list = array();
143: $exclude_deleted = true;
144: if (in_array('deleted', $flags, true)) {
145: $exclude_deleted = false;
146: }
147: $msgs = $mailbox->search($this->folder, $flags, $params, null, null, $exclude_deleted);
148: if (!$msgs) {
149: return $msg_list;
150: }
151: $server_details = Hm_IMAP_List::dump($this->imap_id);
152: foreach ($mailbox->get_message_list($this->folder, $msgs) as $msg) {
153: if (array_key_exists('content-type', $msg) && mb_stristr($msg['content-type'], 'multipart/mixed')) {
154: $msg['flags'] .= ' \Attachment';
155: }
156: if (mb_stristr($msg['flags'], 'deleted')) {
157: continue;
158: }
159: $msg['server_id'] = $this->imap_id;
160: $msg['folder'] = bin2hex($this->folder);
161: $msg['server_name'] = $server_details['name'];
162: $msg_list[] = $msg;
163: }
164: usort($msg_list, function($a, $b) {
165: if (!array_key_exists('internal_date', $a) || (!array_key_exists('internal_date', $b))) {
166: return 0;
167: }
168: return strtotime($b['internal_date']) - strtotime($a['internal_date']);
169: });
170: return array_slice($msg_list, 0, $limit);
171: }
172:
173: private function validate_source($val) {
174: if (mb_substr_count($val, '_') !== 2) {
175: return false;
176: }
177: $source_parts = explode('_', $val);
178: $this->imap_id = $source_parts[1];
179: $this->folder = hex2bin($source_parts[2]);
180: return true;
181: }
182:
183: private function validate_date($val) {
184: return preg_match("/\d{4}-\d{2}-\d{2}/", $val) ? true : false;
185: }
186:
187: private function validate_flags($data) {
188: $flags = array('SEEN', 'UNSEEN', 'UNSEEN', 'SEEN', 'ANSWERED', 'UNANSWERED',
189: 'FLAGGED', 'UNFLAGGED', 'DELETED', 'UNDELETED');
190: if (!array_key_exists('adv_flags', $data)) {
191: return true;
192: }
193: if (!is_array($adv_flags)) {
194: return false;
195: }
196: foreach ($data as $flag) {
197: if (!in_array($flag, $flags, true)) {
198: return false;
199: }
200: }
201: return true;
202: }
203: }
204:
205: /**
206: * Advanced search link
207: * @subpackage advanced_search/output
208: */
209: class Hm_Output_advanced_search_link extends Hm_Output_Module {
210: protected function output() {
211: return '<a class="adv_search_link" href="?page=advanced_search">'.$this->trans('Advanced').'</a>';
212: }
213: }
214:
215: /**
216: * Start the advanced search form
217: * @subpackage advanced_search/output
218: */
219: class Hm_Output_advanced_search_form_start extends Hm_Output_Module {
220: protected function output() {
221: return '<div class="advanced_search_form">';
222: }
223: }
224:
225: /**
226: * Start the advanced search results content section
227: * @subpackage advanced_search/output
228: */
229: class Hm_Output_advanced_search_content_start extends Hm_Output_Module {
230: protected function output() {
231: return '<div class="search_content px-0"><div class="content_title d-flex align-items-center px-3">'.
232: '<i class="bi bi-caret-down-fill adv_expand_all cursor-pointer"></i>'.
233: '<i class="bi bi-caret-up adv_collapse_all cursor-pointer"></i>'.
234: '<lable class="ms-2">'.$this->trans('Advanced Search').'</label></div>';
235: }
236: }
237:
238: /**
239: * End of the advanced search results content section
240: * @subpackage advanced_search/output
241: */
242: class Hm_Output_advanced_search_content_end extends Hm_Output_Module {
243: protected function output() {
244: return '</div></div></div>';
245: }
246: }
247:
248: /**
249: * Advanced search form content
250: * @subpackage advanced_search/output
251: */
252: class Hm_Output_advanced_search_form_content extends Hm_Output_Module {
253: protected function output() {
254: if (!$this->get('imap_supported')) {
255: return '<div class="imap_support_required">'.
256: $this->trans('the IMAP module set must be enabled for advanced search').'</div>';
257: }
258: return
259: $this->terms().
260: $this->sources().
261: $this->targets().
262: $this->times().
263: $this->other().
264: '<div class="submit_section px-3 mb-3"><input type="button" class="btn btn-primary" id="adv_search" value="'.$this->trans('Search').'" />'.
265: ' <input class="btn btn-light border" type="button" class="adv_reset" value="'.$this->trans('Reset').'" />';
266: }
267:
268: protected function targets() {
269: return '<div data-target=".targets_section" class="settings_subtitle cursor-pointer px-3 py-2 mt-3"><i class="bi bi-file-earmark-fill me-2"></i>'.$this->trans('Targets').
270: '<span class="target_count">'.sprintf($this->trans('targets: %d'), 0).'</span></div>'.
271: '<div class="targets_section mx-5 py-1"><div class="col-lg-6 col-12" id="adv_target"><table class="adv_targets table table-borderless"><tr><th>'.
272: '<input type="radio" value="TEXT" id="adv_msg" class="target_radio form-check-input" checked="checked" '.
273: 'name="target_type" /><label class="form-check-label ms-2" for="adv_msg">'.$this->trans('Entire message').'</label></th>'.
274: '<th><input type="radio" class="target_radio form-check-input" value="BODY" name="target_type" id="adv_body" '.
275: '/><label class="form-check-label ms-2" for="adv_body">'.$this->trans('Body').'</label></th><td></td></tr><tr><th><input type="radio" '.
276: 'class="target_radio form-check-input" value="header" id="adv_header_radio" name="target_type" /><label class="form-check-label ms-2" for="adv_header_radio">'.
277: $this->trans('Header').'</label></th><td>'.'<select class="adv_header_select form-select" ><option value="FROM">'.
278: $this->trans('From').'</option><option value="SUBJECT">'.$this->trans('Subject').'</option><option value="TO">'.
279: $this->trans('To').'</option><option value="CC">'.$this->trans('Cc').'</option></select></td></tr>'.
280: '<tr><th><input type="radio" class="target_radio form-check-input" value="custom" id="adv_custom" name="target_type" />'.
281: '<label class="form-check-label ms-2" for="adv_custom">'.$this->trans('Custom Header').'</label></th><td><input class="adv_custom_header form-control" '.
282: 'type="text" /></td></tr></table></div><i class="bi bi-plus-circle new_target cursor-pointer ms-2"></i></div>';
283: }
284:
285: protected function terms() {
286: return '<div data-target=".terms_section" class="settings_subtitle cursor-pointer px-3 py-2 mt-3">'.
287: '<i class="bi bi-search me-2"></i>'.$this->trans('Terms').
288: '<span class="term_count">'.sprintf($this->trans('terms: %d'), 0).'</span></div>'.
289: '<div class="terms_section mx-5 py-1">'.
290: '<div class="d-flex align-items-center"><span id="adv_term_not" class="adv_term_nots"><input type="checkbox" class="form-check-input" value="not" id="adv_term_not" /> !</span>'.
291: '<input class="adv_terms form-control w-auto" id="adv_term" type="text" /><i class="bi bi-plus-circle new_term cursor-pointer ms-3"></i></div></div>';
292: }
293:
294: protected function times() {
295: $from_time = strtotime("-1 year", time());
296: $from_date = date("Y-m-d", $from_time);
297: $to_time = strtotime("+1 day", time());
298: $to_date = date("Y-m-d", $to_time);
299: return '<div data-target=".time_section" class="settings_subtitle cursor-pointer px-3 py-2 mt-3"><i class="bi bi-calendar3-week-fill me-2"></i>'.$this->trans('Time').
300: '<span class="time_count">'.sprintf($this->trans('time ranges: %d'), 0).'</span></div>'.
301: '<div class="time_section mx-5 py-1"><span id="adv_time" class="adv_times d-flex align-items-center gap-2">'.$this->trans('From').
302: ' <input class="adv_time_fld_from form-control w-auto" type="date" value="'.$this->html_safe($from_date).
303: '" /> '.$this->trans('To').' <input class="adv_time_fld_to form-control w-auto" type="date" value="'.
304: $this->html_safe($to_date).'" /></span><i class="bi bi-plus-circle new_time cursor-pointer"></i></div>';
305: }
306:
307: protected function sources() {
308: return '<div data-target=".source_section" class="settings_subtitle cursor-pointer px-3 py-2 mt-3"><i class="bi bi-folder-fill me-2"></i>'.$this->trans('Sources').
309: '<span class="source_count">'.sprintf($this->trans('sources: %d'), 0).'</span></div>'.
310: '<div class="source_section mx-5 py-1">'.$this->trans('IMAP').' <i class="bi bi-plus-circle adv_folder_select cursor-pointer"></i><br /><div '.
311: 'class="adv_folder_list"></div><div class="adv_source_list"></div></div>';
312: }
313:
314: protected function other() {
315: return '<div data-target=".other_section" class="settings_subtitle cursor-pointer px-3 py-2 mt-3"><i class="bi bi-gear-fill me-2"></i>'.$this->trans('Other').
316: '<span class="other_count">'.sprintf($this->trans('other settings: %d'), 0).'</span></div>'.
317: '<div class="other_section mx-5 py-1 mb-3"><div class="col-lg-6 col-12"><table class="table table-borderless"><tr><th>'.$this->trans('Character set').'</th><td><select class="charset form-select w-auto">'.
318: '<option value="">'.$this->trans('Default').'</option><option value="UTF-8">UTF-8</option>'.
319: '<option value="ASCII">ASCII</option></select></td></tr><tr><th>'.$this->trans('Results per source').'</th>'.
320: '<td><input type="number" value="100" class="adv_source_limit form-control" /></td></tr><tr><th>'.$this->trans('Flags').'</th><td>'.
321: '<div class="flags d-flex flex-column"><div><input id="adv_flag_read" class="adv_flag form-check-input" value="SEEN" type="checkbox">'.
322: '<label class="form-check-label ms-2" for="adv_flag_read">'.$this->trans('Read').
323: ' </label></div><div><input id="adv_flag_unread" class="adv_flag form-check-input" value="UNSEEN" type="checkbox">'.
324: '<label class="form-check-label ms-2" for="adv_flag_unread">'.$this->trans('Unread').
325: '</label></div><div><input id="adv_flag_answered" class="adv_flag form-check-input" value="ANSWERED" type="checkbox">'.
326: '<label class="form-check-label ms-2" for="adv_flag_answered">'.$this->trans('Answered').
327: '</label></div><div><input id="adv_flag_unanswered" class="adv_flag form-check-input" value="UNANSWERED" type="checkbox">'.
328: '<label class="form-check-label ms-2" for="adv_flag_unanswered">'.$this->trans('Unanswered').
329: '</label></div><div><input id="adv_flag_flagged" class="adv_flag form-check-input" value="FLAGGED" type="checkbox">'.
330: '<label class="form-check-label ms-2" for="adv_flag_flagged">'.$this->trans('Flagged').
331: '</label></div><div><input id="adv_flag_unflagged" class="adv_flag form-check-input" value="UNFLAGGED" type="checkbox">'.
332: '<label class="form-check-label ms-2" for="adv_flag_unflagged">'.$this->trans('Unflagged').
333: '</label></div><div><input id="adv_flag_deleted" class="adv_flag form-check-input" value="DELETED" type="checkbox">'.
334: '<label class="form-check-label ms-2" for="adv_flag_deleted">'.$this->trans('Deleted').
335: '</label></div><div><input id="adv_flag_undeleted" class="adv_flag form-check-input" value="UNDELETED" type="checkbox">'.
336: '<label class="form-check-label ms-2" for="adv_flag_undeleted">'.$this->trans('Not deleted').
337: '</label></div></div></td></tr></table></div></div>';
338: }
339: }
340:
341: /**
342: * Finish the advanced search form
343: * @subpackage advanced_search/output
344: */
345: class Hm_Output_advanced_search_form_end extends Hm_Output_Module {
346: protected function output() {
347: return '</div><div class="content_title search_result_title mb-3 px-3"><i class="bi bi-envelope-check-fill adv_expand_all"></i>'.$this->trans('Search Results').'</div>'.
348: '<div class="adv_controls">'.message_controls($this).' '.combined_sort_dialog($this).'</div>'.
349: '<div class="message_list">';
350: }
351: }
352:
353: /**
354: * Closes the advanced search results table
355: * @subpackage advanced_search/output
356: */
357: class Hm_Output_advanced_search_results_table_end extends Hm_Output_Module {
358: protected function output() {
359: return '</tbody></table>';
360: }
361: }
362:
363: /**
364: * Format search results row
365: * @subpackage advanced_search/output
366: */
367: class Hm_Output_filter_imap_advanced_search extends Hm_Output_Module {
368: /**
369: * Build ajax response from an IMAP server for a search
370: */
371: protected function output() {
372: if ($this->get('imap_search_results')) {
373: $adv_search_result = format_imap_message_list(
374: $this->get('imap_search_results'),
375: $this,
376: 'advanced_search',
377: 'email'
378: );
379:
380: // Convert format (ID => [HTML, ID]) to format expected (HTML => ID)
381: $res = array();
382: foreach ($adv_search_result as $id => $row_data) {
383: $res[$row_data[0]] = $id;
384: }
385:
386: $this->out('formatted_message_list', $res);
387: }
388: elseif (!$this->get('formatted_message_list')) {
389: $this->out('formatted_message_list', array());
390: }
391: }
392: }
393:
API documentation generated by ApiGen v7.0.0-alpha.6