From a06c5fd1973c92f39e490e93bb09070838d31f5b Mon Sep 17 00:00:00 2001 From: Marc Alexander Date: Sat, 6 Nov 2010 00:05:22 +0000 Subject: [PATCH] Added welcome block; Added some new features to welcome block: BBCode buttons, permission system --- root/adm/style/portal/acp_portal_welcome.html | 629 ++++++++++++++++++ .../en/mods/portal/portal_welcome_module.php | 47 ++ root/portal/modules/portal_welcome.php | 296 +++++++++ .../portal/modules/welcome_center.html | 10 + 4 files changed, 982 insertions(+) create mode 100644 root/adm/style/portal/acp_portal_welcome.html create mode 100644 root/language/en/mods/portal/portal_welcome_module.php create mode 100644 root/portal/modules/portal_welcome.php create mode 100644 root/styles/prosilver/template/portal/modules/welcome_center.html diff --git a/root/adm/style/portal/acp_portal_welcome.html b/root/adm/style/portal/acp_portal_welcome.html new file mode 100644 index 00000000..e8a78f56 --- /dev/null +++ b/root/adm/style/portal/acp_portal_welcome.html @@ -0,0 +1,629 @@ + + + + +

{L_TITLE}

+ +

{L_TITLE_EXPLAIN}

+ + +
+

{L_WARNING}

+

{ERROR_MSG}

+
+ +
+ +
+ {L_MODULE_OPTIONS} +
+

{L_MODULE_NAME_EXP}
+
+
+
+

{L_MODULE_IMAGE_EXP}
+
+
{L_MODULE_IMAGE}
+
+
+ + +
+ {L_ACP_PORTAL_WELCOME_PREVIEW} +
+
+ {PREVIEW_TEXT} +
+
+
+ +
+ {L_PORTAL_WELCOME} +
+
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+ {L_ACP_PORTAL_WELCOME_MESSAGE_EXP} +
+
+
+
+
+
+ {L_ACP_PORTAL_WELCOME_PERMISSION_EXP} +
+
+ +
+
+ + + {auth_tpl.TPL} + + + +

+   +   + +

+ {S_FORM_TOKEN} +
+
+ + \ No newline at end of file diff --git a/root/language/en/mods/portal/portal_welcome_module.php b/root/language/en/mods/portal/portal_welcome_module.php new file mode 100644 index 00000000..0273888a --- /dev/null +++ b/root/language/en/mods/portal/portal_welcome_module.php @@ -0,0 +1,47 @@ + 'Welcome Message', + + // ACP + 'ACP_PORTAL_WELCOME_SETTINGS' => 'Welcome Message Settings', + 'ACP_PORTAL_WELCOME_MESSAGE_SHORT' => 'The message you entered is not long enough.', + 'ACP_PORTAL_WELCOME_PREVIEW' => 'Welcome Message Preview', + 'ACP_PORTAL_WELCOME_MESSAGE' => 'Welcome Message', + 'ACP_PORTAL_WELCOME_MESSAGE_EXP' => 'You can change the welcome message in the textbox. BBCode, Images and URLs are allowed.', + 'ACP_PORTAL_WELCOME_PERMISSION' => 'Welcome message permissions', + 'ACP_PORTAL_WELCOME_PERMISSION_EXP' => 'Select the groups that should be able to view the welcome message. If you want all users to be able to view the welcome message, don´t select anything.
Select/Deselect multiple groups by holding CTRL and clicking.', + +)); + +?> \ No newline at end of file diff --git a/root/portal/modules/portal_welcome.php b/root/portal/modules/portal_welcome.php new file mode 100644 index 00000000..665914cd --- /dev/null +++ b/root/portal/modules/portal_welcome.php @@ -0,0 +1,296 @@ +lang}/mods/portal/" + */ + var $language = 'portal_welcome_module'; + + /** + * custom acp template + * file must be in "adm/style/portal/" + */ + var $custom_acp_tpl = 'acp_portal_welcome'; + + function get_template_center($module_id) + { + global $config, $template, $portal_config, $phpEx; + + // Generate text for display and assign template vars + $uid = $config['board3_welcome_message_uid_' . $module_id]; + $bitfield = $config['board3_welcome_message_bitfield_' . $module_id]; + $bbcode_options = OPTION_FLAG_BBCODE + OPTION_FLAG_SMILIES + OPTION_FLAG_LINKS; + //$text = generate_text_for_display($portal_config['board3_welcome_message_' . $module_id], $config['board3_welcome_message_uid_' . $module_id], $config['board3_welcome_message_bitfield_' . $module_id], $bbcode_options); + + $text = censor_text($portal_config['board3_welcome_message_' . $module_id]); + + // Parse bbcode if bbcode uid stored and bbcode enabled + if ($uid) + { + if (!class_exists('bbcode')) + { + global $phpbb_root_path, $phpEx; + include($phpbb_root_path . 'includes/bbcode.' . $phpEx); + } + + if (empty($bbcode)) + { + $bbcode = new bbcode($bitfield); + } + else + { + $bbcode->bbcode($bitfield); + } + + $bbcode->bbcode_second_pass($text, $uid); + } + + $text = bbcode_nl2br($text); + $text = smiley_text($text, false); + $template->assign_vars(array( + 'PORTAL_WELCOME_MSG' => $text, + )); + + return 'welcome_center.html'; + } + + function get_template_acp($module_id) + { + return array( + 'title' => 'ACP_PORTAL_WELCOME_SETTINGS', + 'vars' => array( + 'legend1' => 'ACP_PORTAL_WELCOME_SETTINGS', + 'board3_welcome_message_' . $module_id => array('lang' => 'PORTAL_WELCOME_INTRO', 'validate' => 'string', 'type' => 'custom', 'method' => 'manage_welcome', 'submit' => 'update_welcome', 'explain' => true), + ), + ); + } + + /** + * API functions + */ + function install($module_id) + { + set_portal_config('board3_welcome_message_' . $module_id, 'Welcome to my Community!'); + set_config('board3_welcome_message_' . $module_id, ''); + set_config('board3_welcome_message_uid_' . $module_id, ''); + set_config('board3_welcome_message_bitfield_' . $module_id, ''); + set_config('board3_welcome_groups_' . $module_id, ''); + return true; + } + + function uninstall($module_id) + { + global $db; + + $del_config = array( + 'board3_welcome_message_' . $module_id, + ); + $sql = 'DELETE FROM ' . PORTAL_CONFIG_TABLE . ' + WHERE ' . $db->sql_in_set('config_name', $del_config); + + $check = $db->sql_query($sql); + + $del_config = array( + 'board3_welcome_intro_' . $module_id, + 'board3_welcome_groups_' . $module_id, + 'board3_welcome_message_uid_' . $module_id, + 'board3_welcome_message_bitfield_' . $module_id, + ); + $sql = 'DELETE FROM ' . CONFIG_TABLE . ' + WHERE ' . $db->sql_in_set('config_name', $del_config); + return ((!$check) ? $check : $db->sql_query($sql)); // if something went wrong, make sure we are aware of the first query + } + + function manage_welcome($value, $key, $module_id) + { + global $db, $portal_config, $config, $template, $user, $phpEx, $phpbb_admin_path, $phpbb_root_path; + + $action = (isset($_POST['reset'])) ? 'reset' : ''; + $action = (isset($_POST['submit'])) ? 'save' : $action; + $action = (isset($_POST['preview'])) ? 'preview' : $action; + + $portal_config = obtain_portal_config(); + + $u_action = append_sid($phpbb_admin_path . 'index.' . $phpEx, 'i=portal&mode=config&module_id=' . $module_id); + + switch($action) + { + // Save changes + case 'save': + if (!check_form_key('acp_portal')) + { + trigger_error($user->lang['FORM_INVALID']. adm_back_link($u_action), E_USER_WARNING); + } + + $welcome_message = utf8_normalize_nfc(request_var('welcome_message', '', true)); + $welcome_permission = request_var('permission-setting', array(0 => '')); + $groups_ary = array(); + $uid = $bitfield = $flags = ''; + $options = 7; + generate_text_for_storage($welcome_message, $uid, $bitfield, $flags, true, true, true); + + + // first check for obvious errors, we don't want to waste server resources + if(empty($welcome_message)) + { + trigger_error($user->lang['ACP_PORTAL_WELCOME_MESSAGE_SHORT']. adm_back_link($u_action), E_USER_WARNING); + } + + // get groups and check if the selected groups actually exist + $sql = 'SELECT group_id + FROM ' . GROUPS_TABLE . ' + ORDER BY group_id ASC'; + $result = $db->sql_query($sql); + while($row = $db->sql_fetchrow($result)) + { + $groups_ary[] = $row['group_id']; + } + $db->sql_freeresult($result); + + $welcome_permission = array_intersect($welcome_permission, $groups_ary); + $welcome_permission = implode(',', $welcome_permission); + + add_log('admin', 'LOG_PORTAL_CONFIG', $user->lang['PORTAL_WELCOME']); + + // set_portal_config will take care of escaping the welcome message + set_portal_config('board3_welcome_message_' . $module_id, $welcome_message); + set_config('board3_welcome_message_uid_' . $module_id, $uid); + set_config('board3_welcome_message_bitfield_' . $module_id, $bitfield); + + trigger_error($user->lang['CONFIG_UPDATED'] . adm_back_link(($module_id) ? append_sid("{$phpbb_admin_path}index.$phpEx", 'i=portal&mode=modules') : $u_action)); + + break; + + case 'preview': + $welcome_message = $text = utf8_normalize_nfc(request_var('welcome_message', '', true)); + $welcome_permission = request_var('permission-setting', array(0 => '')); + $groups_ary = array(); + if (!class_exists('parse_message')) + { + include($phpbb_root_path . 'includes/message_parser.' . $phpEx); + } + + $bbcode_options = OPTION_FLAG_BBCODE + OPTION_FLAG_SMILIES + OPTION_FLAG_LINKS; + $uid = (isset($config['board3_welcome_message_uid_' . $module_id])) ? $config['board3_welcome_message_uid_' . $module_id] : ''; + $bitfield = (isset($config['board3_welcome_message_bitfield_' . $module_id])) ? $config['board3_welcome_message_bitfield_' . $module_id] : ''; + $options = OPTION_FLAG_BBCODE + OPTION_FLAG_SMILIES + OPTION_FLAG_LINKS; + generate_text_for_storage($text, $uid, $bitfield, $options, true, true, true); + + $text = generate_text_for_display($text, $uid, $bitfield, $options); + + $template->assign_vars(array( + 'PREVIEW_TEXT' => $text, + 'S_PREVIEW' => true, + )); + + // get groups and check if the selected groups actually exist + $sql = 'SELECT group_id + FROM ' . GROUPS_TABLE . ' + ORDER BY group_id ASC'; + $result = $db->sql_query($sql); + while($row = $db->sql_fetchrow($result)) + { + $groups_ary[] = $row['group_id']; + } + $db->sql_freeresult($result); + + $temp_permissions = array_intersect($welcome_permission, $groups_ary); + + // Edit or add menu item + case 'reset': + default: + if(!isset($welcome_message)) + { + $welcome_message = generate_text_for_edit($portal_config['board3_welcome_message_' . $module_id], $config['board3_welcome_message_uid_' . $module_id], ''); + } + + $template->assign_vars(array( + 'WELCOME_MESSAGE' => (is_array($welcome_message)) ? $welcome_message['text'] : $welcome_message, + //'U_BACK' => $u_action, + 'U_ACTION' => $u_action, + 'S_EDIT' => true, + 'S_LINKS_ALLOWED' => true, + 'S_BBCODE_IMG' => true, + 'S_BBCODE_FLASH' => true, + 'S_BBCODE_QUOTE' => true, + 'S_BBCODE_ALLOWED' => true, + 'MAX_FONT_SIZE' => (int) $config['max_post_font_size'], + )); + + $groups_ary = (isset($temp_permissions)) ? $temp_permissions : ((isset($config['board3_welcome_groups_' . $module_id])) ? explode(',', $config['board3_welcome_groups_' . $module_id]) : array()); + + // get group info from database and assign the block vars + $sql = 'SELECT group_id, group_name + FROM ' . GROUPS_TABLE . ' + ORDER BY group_id ASC'; + $result = $db->sql_query($sql); + while($row = $db->sql_fetchrow($result)) + { + $template->assign_block_vars('permission_setting', array( + 'SELECTED' => (in_array($row['group_id'], $groups_ary)) ? true : false, + 'GROUP_NAME' => (isset($user->lang['G_' . $row['group_name']])) ? $user->lang['G_' . $row['group_name']] : $row['group_name'], + 'GROUP_ID' => $row['group_id'], + )); + } + $db->sql_freeresult($result); + + if(!function_exists('display_forums')) + { + include($phpbb_root_path . 'includes/functions_display.' . $phpEx); + } + + // Build custom bbcodes array + display_custom_bbcodes(); + $user->add_lang('posting'); + + break; + } + } + + function update_welcome($key, $module_id) + { + $this->manage_welcome('', $key, $module_id); + } +} + +?> \ No newline at end of file diff --git a/root/styles/prosilver/template/portal/modules/welcome_center.html b/root/styles/prosilver/template/portal/modules/welcome_center.html new file mode 100644 index 00000000..5a49ebcf --- /dev/null +++ b/root/styles/prosilver/template/portal/modules/welcome_center.html @@ -0,0 +1,10 @@ + +{$C_BLOCK_H_L}
{L_PORTAL_WELCOME}
{$C_BLOCK_H_R} +
+
+
+
{PORTAL_WELCOME_MSG}
+
+
+
+{$C_BLOCK_F_L}{$C_BLOCK_F_R} \ No newline at end of file