Merge changes made in revisions #r9405 to #r9467
[phpbb.git] / phpBB / modules / ucp / ucp_pm_viewfolder.php
blob5b252f7410308ec16400c47c33626fb167b19137
1 <?php
2 /**
4 * @package ucp
5 * @version $Id$
6 * @copyright (c) 2005 phpBB Group
7 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
9 */
11 /**
12 * @ignore
14 if (!defined('IN_PHPBB'))
16 exit;
19 /**
20 * View message folder
21 * Called from ucp_pm with mode == 'view' && action == 'view_folder'
23 function view_folder($id, $mode, $folder_id, $folder)
25 $submit_export = phpbb_request::is_set_post('submit_export');
27 $folder_info = get_pm_from($folder_id, $folder, phpbb::$user->data['user_id']);
29 if (!$submit_export)
31 phpbb::$user->add_lang('viewforum');
33 // Grab icons
34 $icons = phpbb_cache::obtain_icons();
36 $color_rows = array('marked', 'replied');
38 // only show the friend/foe color rows if the module is enabled
39 $zebra_enabled = false;
41 $_module = new p_master();
42 $_module->list_modules('ucp');
43 $_module->set_active('zebra');
45 $zebra_enabled = ($_module->active_module === false) ? false : true;
47 unset($_module);
49 if ($zebra_enabled)
51 $color_rows = array_merge($color_rows, array('friend', 'foe'));
54 foreach ($color_rows as $var)
56 phpbb::$template->assign_block_vars('pm_colour_info', array(
57 'IMG' => phpbb::$user->img("pm_{$var}", ''),
58 'CLASS' => "pm_{$var}_colour",
59 'LANG' => phpbb::$user->lang[strtoupper($var) . '_MESSAGE'],
60 ));
63 $mark_options = array('mark_important', 'delete_marked');
65 $s_mark_options = '';
66 foreach ($mark_options as $mark_option)
68 $s_mark_options .= '<option value="' . $mark_option . '">' . phpbb::$user->lang[strtoupper($mark_option)] . '</option>';
71 // We do the folder moving options here too, for template authors to use...
72 $s_folder_move_options = '';
73 if ($folder_id != PRIVMSGS_NO_BOX && $folder_id != PRIVMSGS_OUTBOX)
75 foreach ($folder as $f_id => $folder_ary)
77 if ($f_id == PRIVMSGS_OUTBOX || $f_id == PRIVMSGS_SENTBOX || $f_id == $folder_id)
79 continue;
82 $s_folder_move_options .= '<option' . (($f_id != PRIVMSGS_INBOX) ? ' class="sep"' : '') . ' value="' . $f_id . '">';
83 $s_folder_move_options .= sprintf(phpbb::$user->lang['MOVE_MARKED_TO_FOLDER'], $folder_ary['folder_name']);
84 $s_folder_move_options .= (($folder_ary['unread_messages']) ? ' [' . $folder_ary['unread_messages'] . '] ' : '') . '</option>';
87 $friend = $foe = array();
89 // Get friends and foes
90 $sql = 'SELECT *
91 FROM ' . ZEBRA_TABLE . '
92 WHERE user_id = ' . phpbb::$user->data['user_id'];
93 $result = phpbb::$db->sql_query($sql);
95 while ($row = phpbb::$db->sql_fetchrow($result))
97 $friend[$row['zebra_id']] = $row['friend'];
98 $foe[$row['zebra_id']] = $row['foe'];
100 phpbb::$db->sql_freeresult($result);
102 phpbb::$template->assign_vars(array(
103 'S_MARK_OPTIONS' => $s_mark_options,
104 'S_MOVE_MARKED_OPTIONS' => $s_folder_move_options,
107 // Okay, lets dump out the page ...
108 if (sizeof($folder_info['pm_list']))
110 $address_list = array();
112 // Build Recipient List if in outbox/sentbox - max two additional queries
113 if ($folder_id == PRIVMSGS_OUTBOX || $folder_id == PRIVMSGS_SENTBOX)
115 $recipient_list = $address = array();
117 foreach ($folder_info['rowset'] as $message_id => $row)
119 $address[$message_id] = rebuild_header(array('to' => $row['to_address'], 'bcc' => $row['bcc_address']));
120 $_save = array('u', 'g');
121 foreach ($_save as $save)
123 if (isset($address[$message_id][$save]) && sizeof($address[$message_id][$save]))
125 foreach (array_keys($address[$message_id][$save]) as $ug_id)
127 $recipient_list[$save][$ug_id] = array('name' => phpbb::$user->lang['NA'], 'colour' => '');
133 $_types = array('u', 'g');
134 foreach ($_types as $ug_type)
136 if (!empty($recipient_list[$ug_type]))
138 if ($ug_type == 'u')
140 $sql = 'SELECT user_id as id, username as name, user_colour as colour
141 FROM ' . USERS_TABLE . '
142 WHERE ';
144 else
146 $sql = 'SELECT group_id as id, group_name as name, group_colour as colour, group_type
147 FROM ' . GROUPS_TABLE . '
148 WHERE ';
150 $sql .= phpbb::$db->sql_in_set(($ug_type == 'u') ? 'user_id' : 'group_id', array_map('intval', array_keys($recipient_list[$ug_type])));
152 $result = phpbb::$db->sql_query($sql);
154 while ($row = phpbb::$db->sql_fetchrow($result))
156 if ($ug_type == 'g')
158 $row['name'] = ($row['group_type'] == GROUP_SPECIAL) ? phpbb::$user->lang['G_' . $row['name']] : $row['name'];
161 $recipient_list[$ug_type][$row['id']] = array('name' => $row['name'], 'colour' => $row['colour']);
163 phpbb::$db->sql_freeresult($result);
167 foreach ($address as $message_id => $adr_ary)
169 foreach ($adr_ary as $type => $id_ary)
171 foreach ($id_ary as $ug_id => $_id)
173 if ($type == 'u')
175 $address_list[$message_id][] = get_username_string('full', $ug_id, $recipient_list[$type][$ug_id]['name'], $recipient_list[$type][$ug_id]['colour']);
177 else
179 $user_colour = ($recipient_list[$type][$ug_id]['colour']) ? ' style="font-weight: bold; color:#' . $recipient_list[$type][$ug_id]['colour'] . '"' : '';
180 $link = '<a href="' . append_sid('memberlist', 'mode=group&amp;g=' . $ug_id) . '"' . $user_colour . '>';
181 $address_list[$message_id][] = $link . $recipient_list[$type][$ug_id]['name'] . (($link) ? '</a>' : '');
186 unset($recipient_list, $address);
189 $data = array();
191 foreach ($folder_info['pm_list'] as $message_id)
193 $row = &$folder_info['rowset'][$message_id];
195 $folder_img = ($row['pm_unread']) ? 'pm_unread' : 'pm_read';
196 $folder_alt = ($row['pm_unread']) ? 'NEW_MESSAGES' : 'NO_NEW_MESSAGES';
198 // Generate all URIs ...
199 $view_message_url = append_sid('ucp', "i=$id&amp;mode=view&amp;f=$folder_id&amp;p=$message_id");
200 $remove_message_url = append_sid('ucp', "i=$id&amp;mode=compose&amp;action=delete&amp;p=$message_id");
202 $row_indicator = '';
203 foreach ($color_rows as $var)
205 if (($var != 'friend' && $var != 'foe' && $row['pm_' . $var])
207 (($var == 'friend' || $var == 'foe') && isset(${$var}[$row['author_id']]) && ${$var}[$row['author_id']]))
209 $row_indicator = $var;
210 break;
214 // Send vars to template
215 phpbb::$template->assign_block_vars('messagerow', array(
216 'PM_CLASS' => ($row_indicator) ? 'pm_' . $row_indicator . '_colour' : '',
218 'MESSAGE_AUTHOR_FULL' => get_username_string('full', $row['author_id'], $row['username'], $row['user_colour'], $row['username']),
219 'MESSAGE_AUTHOR_COLOUR' => get_username_string('colour', $row['author_id'], $row['username'], $row['user_colour'], $row['username']),
220 'MESSAGE_AUTHOR' => get_username_string('username', $row['author_id'], $row['username'], $row['user_colour'], $row['username']),
221 'U_MESSAGE_AUTHOR' => get_username_string('profile', $row['author_id'], $row['username'], $row['user_colour'], $row['username']),
223 'FOLDER_ID' => $folder_id,
224 'MESSAGE_ID' => $message_id,
225 'SENT_TIME' => phpbb::$user->format_date($row['message_time']),
226 'SUBJECT' => censor_text($row['message_subject']),
227 'FOLDER' => (isset($folder[$row['folder_id']])) ? $folder[$row['folder_id']]['folder_name'] : '',
228 'U_FOLDER' => (isset($folder[$row['folder_id']])) ? append_sid('ucp', 'folder=' . $row['folder_id']) : '',
229 'PM_ICON_IMG' => (!empty($icons[$row['icon_id']])) ? '<img src="' . phpbb::$config['icons_path'] . '/' . $icons[$row['icon_id']]['img'] . '" width="' . $icons[$row['icon_id']]['width'] . '" height="' . $icons[$row['icon_id']]['height'] . '" alt="" title="" />' : '',
230 'PM_ICON_URL' => (!empty($icons[$row['icon_id']])) ? phpbb::$config['icons_path'] . '/' . $icons[$row['icon_id']]['img'] : '',
231 'FOLDER_IMG' => phpbb::$user->img($folder_img, $folder_alt),
232 'FOLDER_IMG_SRC' => phpbb::$user->img($folder_img, $folder_alt, 'src'),
233 'PM_IMG' => ($row_indicator) ? phpbb::$user->img('pm_' . $row_indicator, '') : '',
234 'ATTACH_ICON_IMG' => (phpbb::$acl->acl_get('u_pm_download') && $row['message_attachment'] && phpbb::$config['allow_pm_attach']) ? phpbb::$user->img('icon_topic_attach', 'TOTAL_ATTACHMENTS') : '',
236 'S_PM_DELETED' => ($row['pm_deleted']) ? true : false,
237 'S_AUTHOR_DELETED' => ($row['author_id'] == ANONYMOUS) ? true : false,
239 'U_VIEW_PM' => ($row['pm_deleted']) ? '' : $view_message_url,
240 'U_REMOVE_PM' => ($row['pm_deleted']) ? $remove_message_url : '',
241 'RECIPIENTS' => ($folder_id == PRIVMSGS_OUTBOX || $folder_id == PRIVMSGS_SENTBOX) ? implode(', ', $address_list[$message_id]) : '',
244 unset($folder_info['rowset']);
246 phpbb::$template->assign_vars(array(
247 'S_SHOW_RECIPIENTS' => ($folder_id == PRIVMSGS_OUTBOX || $folder_id == PRIVMSGS_SENTBOX) ? true : false,
248 'S_SHOW_COLOUR_LEGEND' => true,
250 'S_PM_ICONS' => (phpbb::$config['enable_pm_icons']) ? true : false,
254 else
256 $export_type = request_var('export_option', '');
257 $enclosure = request_var('enclosure', '');
258 $delimiter = request_var('delimiter', '');
260 if ($export_type == 'CSV' && ($delimiter === '' || $enclosure === ''))
262 phpbb::$template->assign_var('PROMPT', true);
264 else
266 // Build Recipient List if in outbox/sentbox
267 $address = array();
268 if ($folder_id == PRIVMSGS_OUTBOX || $folder_id == PRIVMSGS_SENTBOX)
270 foreach ($folder_info['rowset'] as $message_id => $row)
272 $address[$message_id] = rebuild_header(array('to' => $row['to_address'], 'bcc' => $row['bcc_address']));
276 foreach ($folder_info['pm_list'] as $message_id)
278 $row = &$folder_info['rowset'][$message_id];
280 include_once(PHPBB_ROOT_PATH . 'includes/functions_posting.' . PHP_EXT);
282 $sql = 'SELECT p.message_text, p.bbcode_uid
283 FROM ' . PRIVMSGS_TO_TABLE . ' t, ' . PRIVMSGS_TABLE . ' p, ' . USERS_TABLE . ' u
284 WHERE t.user_id = ' . phpbb::$user->data['user_id'] . "
285 AND p.author_id = u.user_id
286 AND t.folder_id = $folder_id
287 AND t.msg_id = p.msg_id
288 AND p.msg_id = $message_id";
289 $result = phpbb::$db->sql_query_limit($sql, 1);
290 $message_row = phpbb::$db->sql_fetchrow($result);
291 phpbb::$db->sql_freeresult($result);
293 $_types = array('u', 'g');
294 foreach ($_types as $ug_type)
296 if (isset($address[$message_id][$ug_type]) && sizeof($address[$message_id][$ug_type]))
298 if ($ug_type == 'u')
300 $sql = 'SELECT user_id as id, username as name
301 FROM ' . USERS_TABLE . '
302 WHERE ';
304 else
306 $sql = 'SELECT group_id as id, group_name as name
307 FROM ' . GROUPS_TABLE . '
308 WHERE ';
310 $sql .= phpbb::$db->sql_in_set(($ug_type == 'u') ? 'user_id' : 'group_id', array_map('intval', array_keys($address[$message_id][$ug_type])));
312 $result = phpbb::$db->sql_query($sql);
314 while ($info_row = phpbb::$db->sql_fetchrow($result))
316 $address[$message_id][$ug_type][$address[$message_id][$ug_type][$info_row['id']]][] = $info_row['name'];
317 unset($address[$message_id][$ug_type][$info_row['id']]);
319 phpbb::$db->sql_freeresult($result);
323 decode_message($message_row['message_text'], $message_row['bbcode_uid']);
325 $data[] = array(
326 'subject' => censor_text($row['message_subject']),
327 'sender' => $row['username'],
328 'date' => phpbb::$user->format_date($row['message_time'], 'c', true), // ISO 8601 date.
329 'to' => ($folder_id == PRIVMSGS_OUTBOX || $folder_id == PRIVMSGS_SENTBOX) ? $address[$message_id] : '',
330 'message' => $message_row['message_text']
334 switch ($export_type)
336 case 'CSV':
337 case 'CSV_EXCEL':
338 $mimetype = 'text/csv';
339 $filetype = 'csv';
341 if ($export_type == 'CSV_EXCEL')
343 $enclosure = '"';
344 $delimiter = ',';
345 $newline = "\r\n";
347 else
349 $newline = "\n";
352 $string = '';
353 foreach ($data as $value)
355 $recipients = $value['to'];
356 $value['to'] = $value['bcc'] = '';
358 if (is_array($recipients))
360 foreach ($recipients as $values)
362 $value['bcc'] .= (isset($values['bcc']) && is_array($values['bcc'])) ? ',' . implode(',', $values['bcc']) : '';
363 $value['to'] .= (isset($values['to']) && is_array($values['to'])) ? ',' . implode(',', $values['to']) : '';
366 // Remove the commas which will appear before the first entry.
367 $value['to'] = substr($value['to'], 1);
368 $value['bcc'] = substr($value['bcc'], 1);
371 foreach ($value as $tag => $text)
373 $cell = str_replace($enclosure, $enclosure . $enclosure, $text);
375 if (strpos($cell, $enclosure) !== false || strpos($cell, $delimiter) !== false || strpos($cell, $newline) !== false)
377 $string .= $enclosure . $text . $enclosure . $delimiter;
379 else
381 $string .= $cell . $delimiter;
384 $string = substr($string, 0, -1) . $newline;
386 break;
388 case 'XML':
389 $mimetype = 'application/xml';
390 $filetype = 'xml';
391 $string = '<?xml version="1.0"?>' . "\n";
392 $string .= "<phpbb>\n";
394 foreach ($data as $value)
396 $string .= "\t<privmsg>\n";
398 if (is_array($value['to']))
400 foreach ($value['to'] as $key => $values)
402 foreach ($values as $type => $types)
404 foreach ($types as $name)
406 $string .= "\t\t<recipient type=\"$type\" status=\"$key\">$name</recipient>\n";
412 unset($value['to']);
414 foreach ($value as $tag => $text)
416 $string .= "\t\t<$tag>$text</$tag>\n";
419 $string .= "\t</privmsg>\n";
421 $string .= '</phpbb>';
422 break;
425 header('Pragma: no-cache');
426 header("Content-Type: $mimetype; name=\"data.$filetype\"");
427 header("Content-disposition: attachment; filename=data.$filetype");
428 echo $string;
429 exit;
435 * Get Messages from folder/user
437 function get_pm_from($folder_id, $folder, $user_id)
439 $start = request_var('start', 0);
441 // Additional vars later, pm ordering is mostly different from post ordering. :/
442 $sort_days = request_var('st', 0);
443 $sort_key = request_var('sk', 't');
444 $sort_dir = request_var('sd', 'd');
446 // PM ordering options
447 $limit_days = array(0 => phpbb::$user->lang['ALL_MESSAGES'], 1 => phpbb::$user->lang['1_DAY'], 7 => phpbb::$user->lang['7_DAYS'], 14 => phpbb::$user->lang['2_WEEKS'], 30 => phpbb::$user->lang['1_MONTH'], 90 => phpbb::$user->lang['3_MONTHS'], 180 => phpbb::$user->lang['6_MONTHS'], 365 => phpbb::$user->lang['1_YEAR']);
449 // No sort by Author for sentbox/outbox (already only author available)
450 // Also, sort by msg_id for the time - private messages are not as prone to errors as posts are.
451 if ($folder_id == PRIVMSGS_OUTBOX || $folder_id == PRIVMSGS_SENTBOX)
453 $sort_by_text = array('t' => phpbb::$user->lang['POST_TIME'], 's' => phpbb::$user->lang['SUBJECT']);
454 $sort_by_sql = array('t' => 'p.msg_id', 's' => 'p.message_subject');
456 else
458 $sort_by_text = array('a' => phpbb::$user->lang['AUTHOR'], 't' => phpbb::$user->lang['POST_TIME'], 's' => phpbb::$user->lang['SUBJECT']);
459 $sort_by_sql = array('a' => 'u.username_clean', 't' => 'p.msg_id', 's' => 'p.message_subject');
462 $s_limit_days = $s_sort_key = $s_sort_dir = $u_sort_param = '';
463 gen_sort_selects($limit_days, $sort_by_text, $sort_days, $sort_key, $sort_dir, $s_limit_days, $s_sort_key, $s_sort_dir, $u_sort_param);
465 $folder_sql = 't.folder_id = ' . (int) $folder_id;
467 // Limit pms to certain time frame, obtain correct pm count
468 if ($sort_days)
470 $min_post_time = time() - ($sort_days * 86400);
472 if (phpbb_request::is_set_post('sort'))
474 $start = 0;
477 $sql = 'SELECT COUNT(t.msg_id) AS pm_count
478 FROM ' . PRIVMSGS_TO_TABLE . ' t, ' . PRIVMSGS_TABLE . " p
479 WHERE $folder_sql
480 AND t.user_id = $user_id
481 AND t.msg_id = p.msg_id
482 AND p.message_time >= $min_post_time";
483 $result = phpbb::$db->sql_query_limit($sql, 1);
484 $pm_count = (int) phpbb::$db->sql_fetchfield('pm_count');
485 phpbb::$db->sql_freeresult($result);
487 $sql_limit_time = "AND p.message_time >= $min_post_time";
489 else
491 $pm_count = (!empty($folder[$folder_id]['num_messages'])) ? $folder[$folder_id]['num_messages'] : 0;
492 $sql_limit_time = '';
495 phpbb::$template->assign_vars(array(
496 'PAGINATION' => generate_pagination(append_sid('ucp', "i=pm&amp;mode=view&amp;action=view_folder&amp;f=$folder_id&amp;$u_sort_param"), $pm_count, phpbb::$config['topics_per_page'], $start),
497 'PAGE_NUMBER' => on_page($pm_count, phpbb::$config['topics_per_page'], $start),
498 'TOTAL_MESSAGES' => (($pm_count == 1) ? phpbb::$user->lang['VIEW_PM_MESSAGE'] : sprintf(phpbb::$user->lang['VIEW_PM_MESSAGES'], $pm_count)),
500 'POST_IMG' => (!phpbb::$acl->acl_get('u_sendpm')) ? phpbb::$user->img('button_topic_locked', 'POST_PM_LOCKED') : phpbb::$user->img('button_pm_new', 'POST_NEW_PM'),
502 'L_NO_MESSAGES' => (!phpbb::$acl->acl_get('u_sendpm')) ? phpbb::$user->lang['POST_PM_LOCKED'] : phpbb::$user->lang['NO_MESSAGES'],
504 'S_SELECT_SORT_DIR' => $s_sort_dir,
505 'S_SELECT_SORT_KEY' => $s_sort_key,
506 'S_SELECT_SORT_DAYS' => $s_limit_days,
507 'S_TOPIC_ICONS' => (phpbb::$config['enable_pm_icons']) ? true : false,
509 'U_POST_NEW_TOPIC' => (phpbb::$acl->acl_get('u_sendpm')) ? append_sid('ucp', 'i=pm&amp;mode=compose') : '',
510 'S_PM_ACTION' => append_sid('ucp', "i=pm&amp;mode=view&amp;action=view_folder&amp;f=$folder_id" . (($start !== 0) ? "&amp;start=$start" : '')),
513 // Grab all pm data
514 $rowset = $pm_list = array();
516 // If the user is trying to reach late pages, start searching from the end
517 $store_reverse = false;
518 $sql_limit = phpbb::$config['topics_per_page'];
519 if ($start > $pm_count / 2)
521 $store_reverse = true;
523 if ($start + phpbb::$config['topics_per_page'] > $pm_count)
525 $sql_limit = min(phpbb::$config['topics_per_page'], max(1, $pm_count - $start));
528 // Select the sort order
529 $sql_sort_order = $sort_by_sql[$sort_key] . ' ' . (($sort_dir == 'd') ? 'ASC' : 'DESC');
530 $sql_start = max(0, $pm_count - $sql_limit - $start);
532 else
534 // Select the sort order
535 $sql_sort_order = $sort_by_sql[$sort_key] . ' ' . (($sort_dir == 'd') ? 'DESC' : 'ASC');
536 $sql_start = $start;
539 $sql = 'SELECT t.*, p.root_level, p.message_time, p.message_subject, p.icon_id, p.to_address, p.message_attachment, p.bcc_address, u.username, u.username_clean, u.user_colour
540 FROM ' . PRIVMSGS_TO_TABLE . ' t, ' . PRIVMSGS_TABLE . ' p, ' . USERS_TABLE . " u
541 WHERE t.user_id = $user_id
542 AND p.author_id = u.user_id
543 AND $folder_sql
544 AND t.msg_id = p.msg_id
545 $sql_limit_time
546 ORDER BY $sql_sort_order";
547 $result = phpbb::$db->sql_query_limit($sql, $sql_limit, $sql_start);
549 while ($row = phpbb::$db->sql_fetchrow($result))
551 $rowset[$row['msg_id']] = $row;
552 $pm_list[] = $row['msg_id'];
554 phpbb::$db->sql_freeresult($result);
556 $pm_list = ($store_reverse) ? array_reverse($pm_list) : $pm_list;
558 return array(
559 'pm_count' => $pm_count,
560 'pm_list' => $pm_list,
561 'rowset' => $rowset