SD-Team-Mods-TopicSolved

@@ -0,0 +1,76 @@

+<?php

+

+if (!defined('SMF'))

+	die('Hacking attempt...');

+

+function add_ts_settings_menu(&$subActions)

+{

+	$subActions['topicsolved'] = 'ModifyTopicSolvedSettings';

+}

+

+function add_ts_permissions(&$permissionGroups, &$permissionList, &$leftPermissionGroups, &$hiddenPermissions, &$relabelPermissions)

+{

+	$permissionList['board']['solve_topic'] = array(true, 'topic', 'moderate', 'moderate');

+}

+

+function add_ts_adminmenu(&$admin_areas)

+{

+	global $txt, $context, $modSettings, $scripturl;

+	$admin_areas['maintenance']['areas']['logs']['subsections']['solvelog'] = array($txt['modlog_solve_log'], 'moderate_forum', 'enabled' => !empty($modSettings['enable_solved_log']) && in_array('ml', $context['admin_features']), 'url' => $scripturl . '?action=moderate;area=modlog;sa=solvelog');

+	$admin_areas['config']['areas']['modsettings']['subsections']['topicsolved'] = array($txt['topic_solved_title']);

+}

+

+function ModifyTopicSolvedSettings($return_config = false)

+{

+	global $txt, $scripturl, $context, $settings, $sc, $modSettings, $smcFunc;

+	

+	$query = $smcFunc['db_query']('', '

+		SELECT id_board, id_cat, child_level, name FROM {db_prefix}boards ORDER BY board_order ASC

+	');

+	

+	$config_vars = array();

+	$last = -1;

+	

+	$config_vars = array(

+		array('check', 'enable_solved_log', 'disabled' => !in_array('ml', $context['admin_features'])),

+		array('check', 'topicsolved_highlight'),

+		array('text', 'topicsolved_highlight_col1', 'size' => 10, 'disabled' => empty($modSettings['topicsolved_highlight'])),

+		array('text', 'topicsolved_highlight_col2', 'size' => 10, 'disabled' => empty($modSettings['topicsolved_highlight'])),

+		array('check', 'topicsolved_display_notice'),

+		'',

+		array('message', 'topicsolved_board_desc'),

+	);

+

+	while ($row = $smcFunc['db_fetch_assoc']($query)) {

+		if ($row['id_cat'] != $last && $last != -1)

+			$config_vars[] = '';

+

+		$board_id = 'topicsolved_board_' . $row['id_board'];

+		$txt[$board_id] = (($row['child_level'] > 0) ? str_repeat('    ', $row['child_level']) : '') . $row['name'];

+		$config_vars[] = array('check', $board_id);

+		$last = $row['id_cat'];

+	}

+	

+	$smcFunc['db_free_result']($query);	

+

+	if ($return_config)

+		return $config_vars;

+

+	$context['post_url'] = $scripturl . '?action=admin;area=modsettings;save;sa=topicsolved';

+	$context['settings_title'] = $txt['topic_solved_title'];

+

+	// Saving?

+	if (isset($_GET['save']))

+	{

+		checkSession();

+

+		$save_vars = $config_vars;

+		saveDBSettings($save_vars);

+		

+		redirectexit('action=admin;area=modsettings;sa=topicsolved');

+	}

+

+	prepareDBSettingContext($config_vars);

+}

+

+?>

\ No newline at end of file

@@ -0,0 +1,27 @@

+<?php

+

+if (!defined('SMF'))

+	die('Hacking attempt...');

+

+function template_topicsolved_header_above()

+{

+	global $txt;

+

+	echo '<br /><div class="information">', $txt['topicsolved_is_solved'], '</div>';

+}

+

+function template_topicsolved_header_below()

+{

+

+}

+

+// This is called from the hook in the display template. Since that's the case I didn't think it was inappropriate to put it here...

+function add_topicsolved_button(&$mod_buttons)

+{

+	global $context, $scripturl;

+	$mod_buttons = array_merge(array(

+		'solve' => array('test' => 'can_solve', 'text' => empty($context['is_solved']) ? 'solve_topic' : 'unsolve_topic', 'image' => empty($context['is_solved']) ? 'solve.gif' : 'unsolve.gif', 'lang' => true, 'url' => $scripturl . '?action=solve;topic=' . $context['current_topic'] . '.' . $context['start'] . ';' . $context['session_var'] . '=' . $context['session_id']),

+	), $mod_buttons);

+}

+

+?>

\ No newline at end of file

@@ -50,9 +50,9 @@ function SolveTopic()

 	// Youcansolvez?

 	$user_solve = !allowedTo('solve_topic_any', $board);

 	if ($user_solve && $starter == $user_info['id'])

-		isAllowedTo('solve_own', $board);

+		isAllowedTo('solve_topic_own', $board);

 	else

-		isAllowedTo('solve_any', $board);

+		isAllowedTo('solve_topic_any', $board);

 	// Mark the topic solved in the database. Simple enough.

 	$smcFunc['db_query']('', '

@@ -21,6 +21,8 @@ $txt['solve_log_help'] = '<strong>Topic solved log</strong><br />This section al

 $txt['permissionname_solve_topic'] = 'Mark topics solved/not solved';

 $txt['permissionname_solve_topic_any'] = 'Any topic';

 $txt['permissionname_solve_topic_own'] = 'Own topic';

+$txt['cannot_solve_topic_any'] = 'You do not have permission to mark topics solved.';

+$txt['cannot_solve_topic_own'] = 'You do not have permission to mark topics solved.';

 $txt['permissionhelp_solve_topic'] = 'This permission will allow the user to mark topics as solved and not solved.';

 $txt['enable_solved_log'] = 'Enable logging of topic solving (Requires moderation logging to be enabled)';

 $txt['topicsolved_board_desc'] = '<span class="smalltext">Please select the boards you wish to enable the topic solved feature in.</span>';

@@ -46,8 +48,10 @@ $txt['modlog_solve_log_desc'] = 'Below is a list of all topics that have been so

 $txt['modlog_solve_log_no_entries_found'] = 'There are currently no entries in the topic solved log.';

 $txt['solve_log_help'] = '<strong>Topic solved log</strong><br />This section allows members of the moderation team to track all usage of the topic solved/not solved feature. To ensure that moderators cannot remove references to the actions they have performed, entries may not be deleted until 24 hours after the action was taken.';

 $txt['permissionname_solve_topic'] = 'Mark topics solved/not solved';

-$txt['permissionname_solve_topic_any'] = 'Any topic';

-$txt['permissionname_solve_topic_own'] = 'Own topic';

+$txt['permissionname_solve_topic_any'] = 'Any topics';

+$txt['permissionname_solve_topic_own'] = 'Own topics';

+$txt['cannot_solve_topic_any'] = 'You do not have permission to mark topics solved.';

+$txt['cannot_solve_topic_own'] = 'You do not have permission to mark topics solved.';

 $txt['permissionhelp_solve_topic'] = 'This permission will allow the user to mark topics as solved and not solved.';

 $txt['enable_solved_log'] = 'Enable logging of topic solving';

 $txt['topicsolved_board_desc'] = '<span class="smalltext">Please select the boards you wish to enable the topic solved feature in.</span>';

@@ -21,16 +21,21 @@ if (empty($modSettings['topicsolved_highlight_col1']))

 		updateSettings(array($key => $value));

 }

-$check = $smcFunc['db_list_columns']('{db_prefix}topics');

-

-if (!in_array('solved', $check))

-	$smcFunc['db_add_column']('{db_prefix}topics', array('name' => 'solved', 'type' => 'tinyint', 'size' => 4));	

+$smcFunc['db_add_column']('{db_prefix}topics', array('name' => 'solved', 'type' => 'tinyint', 'size' => 3, 'unsigned' => true));	

 $installed = $smcFunc['db_list_columns']('{db_prefix}topics');

+add_integration_function('integrate_mod_buttons', 'add_topicsolved_button', true);

+add_integration_function('integrate_admin_include', '$sourcedir/SolveTopic-Admin.php', true);

+add_integration_function('integrate_modify_modifications', 'add_ts_settings_menu', true);

+add_integration_function('integrate_admin_areas', 'add_ts_adminmenu', true);

+

+if (SMF == 'SSI')

+{

 	if (in_array('solved', $installed))

 		echo 'Database edits completed!';

 	else

 		echo 'Database edits failed!';

+}

 ?>

\ No newline at end of file

@@ -7,40 +7,21 @@

 	<!-- Template files -->		

 	<file name="$themedir/MessageIndex.template.php">	

 		<operation>

-			<search position="replace"><![CDATA[$color_class = 'windowbg';]]></search>

-			<add><![CDATA[$color_class = 'windowbg';

-				

-			// Solved topics

-			if ($topic['is_solved'] && $topic['is_locked'])

-				$color_class = 'lockedbg solvedbg';

-			elseif ($topic['is_solved'])

-				$color_class = 'solvedbg';]]></add>

-		</operation>

-	</file>

-	<file name="$themedir/Display.template.php">	

-		<operation>

-			<search position="before"><![CDATA[// Show the anchor for the top and for the first message. If the first message is new, say so.]]></search>

-			<add><![CDATA[// Let them know that this is solved

-	if(!empty($modSettings['topicsolved_display_notice']) && $context['is_solved'] && $context['board_solve'])

-		echo'<br /><div class="information">', $txt['topicsolved_is_solved'], '</div>';]]></add>

-		</operation>

-		<operation>

-			<search position="after"><![CDATA[// Restore topic. eh?  No monkey business.]]></search>

-			<add><![CDATA[// Topic solved.

-	$mod_buttons = array_merge(array(

-		'solve' => array('test' => 'can_solve', 'text' => empty($context['is_solved']) ? 'solve_topic' : 'unsolve_topic', 'image' => empty($context['is_solved']) ? 'solve.gif' : 'unsolve.gif', 'lang' => true, 'url' => $scripturl . '?action=solve;topic=' . $context['current_topic'] . '.' . $context['start'] . ';' . $context['session_var'] . '=' . $context['session_id']),

-	),$mod_buttons);]]></add>

+			<search position="before"><![CDATA[// Some columns require a different shade of the color class.]]></search>

+			<add><![CDATA[

+			if (!empty($topic['is_solved']))

+				$color_class .= ' solvedbg';]]></add>

 		</operation>

 	</file>

 	<!-- Source files -->		

-	<file name="$boarddir/index.php">	

+	<file name="$boarddir/index.php"><!-- Adding the action. While it would be nice to use a hook, I don't want to include a file every page load for the sake of this one change. -->	

 		<operation>

 			<search position="after"><![CDATA[// Get the function and file to include - if it's not there, do the board index.]]></search>

 			<add><![CDATA[$actionArray['solve'] = array('SolveTopic.php', 'SolveTopic');]]></add>

 		</operation>

 	</file>

-	<file name="$sourcedir/Display.php">	

+	<file name="$sourcedir/Display.php"><!-- Lots to change, notably figuring out the permission for adding the button, plus loading all sorts of other stuff. -->

 		<operation>

 			<search position="replace"><![CDATA[foreach ($anyown_permissions as $contextual => $perm)

 		$context[$contextual] = allowedTo($perm . '_any') || ($context['user']['started'] && allowedTo($perm . '_own'));]]></search>

@@ -50,9 +31,12 @@

 	foreach ($anyown_permissions as $contextual => $perm)

 		$context[$contextual] = allowedTo($perm . '_any') || ($context['user']['started'] && allowedTo($perm . '_own'));

-	// Topic solved. Is this one of THE boards?

+	// Topic solved stuff. Is this one of THE boards?

+	loadTemplate('SolveTopic-Display');

 	$context['board_solve'] = !empty($modSettings['topicsolved_board_' . $board]);

 	$context['can_solve'] &= $context['board_solve'];

+	if (!empty($modSettings['topicsolved_display_notice']) && $context['is_solved'] && $context['board_solve'])

+		$context['template_layers'][] = 'topicsolved_header';

 ]]></add>

 		</operation>

 		<operation>

@@ -65,14 +49,14 @@

 	$context['is_solved'] = $topicinfo['solved'];]]></add>

 		</operation>		

 	</file>	

-	<file name="$sourcedir/Subs.php">	

+	<file name="$sourcedir/Subs.php"><!-- Add the topic solved log to the list of possible log types we can handle. -->

 		<operation>

 			<search position="after"><![CDATA[if (!is_array($extra))]]></search>

 			<add><![CDATA[// Solved log

-	$log_types = array_merge($log_types,array('solve' => 4));]]></add>

+	$log_types['solve'] = 4;]]></add>

 		</operation>	

 	</file>		

-	<file name="$sourcedir/ModLog.php">	

+	<file name="$sourcedir/Modlog.php"><!-- Extend the moderation log to support the topic solving too. -->

 		<operation>

 			<search position="before"><![CDATA[isAllowedTo('admin_forum');]]></search>

 			<add><![CDATA[// Topic solved log

@@ -87,7 +71,7 @@

 			<add><![CDATA[// Topic solved log: Override page_title and url_starts if required.

 	if ($context['log_type'] == 4)

 	{

-		$context['page_title'] = 'Solve log';	

+		$context['page_title'] = $txt['modlog_solve_log'];	

 		$context['url_start'] = '?action=moderate;area=modlog;sa=solvelog;type=4';		

 	}]]></add>

 		</operation>	

@@ -102,22 +86,11 @@

 	}]]></add>

 		</operation>		

 	</file>	

-	<file name="$sourcedir/Admin.php">	

-		<operation>

-			<search position="before"><![CDATA['pruning' => array($txt['pruning_title'], 'admin_forum'),]]></search>

-			<add><![CDATA['solvelog' => array($txt['modlog_solve_log'], 'moderate_forum', 'enabled' => !empty($modSettings['enable_solved_log']), 'url' => $scripturl . '?action=moderate;area=modlog;sa=solvelog'),]]></add>

-		</operation>

-		<operation>

-			<search position="before"><![CDATA[// Mod Authors for a "ADD AFTER" on this line. Ensure you end your change with a comma. For example:]]></search>

-			<add><![CDATA[

-			'topicsolved' => array($txt['topic_solved_title']),]]></add>

-		</operation>		

-	</file>	

-	<file name="$sourcedir/ModerationCenter.php">	

+	<file name="$sourcedir/ModerationCenter.php"><!-- Provide access from the moderation center to the moderation log for topic solving. -->

 		<operation>

 			<search position="after"><![CDATA['notice' => array(]]></search>

 			<add><![CDATA['solvelog' => array(

-					'enabled' => !empty($modSettings['enable_solved_log']),

+					'enabled' => !empty($modSettings['enable_solved_log']) && in_array('ml', $context['admin_features']),

 					'label' => $txt['modlog_solve_log'],

 					'file' => 'Modlog.php',

 					'function' => 'ViewModlog',

@@ -125,74 +98,7 @@

 				),]]></add>

 		</operation>	

 	</file>	

-	<file name="$sourcedir/ManagePermissions.php">	

-		<operation>

-			<search position="before"><![CDATA[// All permission groups that will be shown in the left column on classic view.

-]]></search>

-			<add><![CDATA[$permissionList['board']['solve_topic'] = array(true, 'topic', 'moderate', 'moderate');]]></add>

-		</operation>	

-	</file>

-	<file name="$sourcedir/ManageSettings.php">	

-		<operation>

-			<search position="after"><![CDATA[// Mod authors, once again, if you have a whole section to add do it AFTER this line, and keep a comma at the end.]]></search>

-			<add><![CDATA['topicsolved' => 'ModifyTopicSolvedSettings',]]></add>

-		</operation>	

-		<operation>

-			<search position="end" />

-			<add><![CDATA[// Topic solved mod

-function ModifyTopicSolvedSettings($return_config = false)

-{

-	global $txt, $scripturl, $context, $settings, $sc, $modSettings, $smcFunc;

-	

-	$query = $smcFunc['db_query']('', '

-		SELECT id_board, id_cat, child_level, name FROM {db_prefix}boards ORDER BY board_order ASC

-	');

-	

-	$config_vars = array();

-	$last = -1;

-	

-	$config_vars[] = array('check', 'enable_solved_log');

-	$config_vars[] = array('check', 'topicsolved_highlight');

-	$config_vars[] = array('text', 'topicsolved_highlight_col1', 'size' => 10, 'disabled' => empty($modSettings['topicsolved_highlight']));

-	$config_vars[] = array('text', 'topicsolved_highlight_col2', 'size' => 10, 'disabled' => empty($modSettings['topicsolved_highlight']));

-	$config_vars[] = array('check', 'topicsolved_display_notice');

-	$config_vars[] = '';	

-	$config_vars[] = array('message', 'topicsolved_board_desc');

-

-	while($row = $smcFunc['db_fetch_assoc']($query)) {

-		if($row['id_cat'] != $last && $last != -1) {

-			$config_vars[] = '';

-		}

-		$board_id = 'topicsolved_board_' . $row['id_board'];

-		$txt[$board_id] = (($row['child_level'] > 0) ? str_repeat('    ', $row['child_level']) : '') . $row['name'];

-		$config_vars[] = array('check', $board_id);

-		$last = $row['id_cat'];

-	}

-	

-	$smcFunc['db_free_result']($query);	

-

-	if ($return_config)

-		return $config_vars;

-

-	$context['post_url'] = $scripturl . '?action=admin;area=modsettings;save;sa=topicsolved';

-	$context['settings_title'] = $txt['topic_solved_title'];

-

-	// Saving?

-	if (isset($_GET['save']))

-	{

-		checkSession();

-

-		$save_vars = $config_vars;

-		saveDBSettings($save_vars);

-		

-		redirectexit('action=admin;area=modsettings;sa=topicsolved');

-	}

-

-	prepareDBSettingContext($config_vars);

-}]]></add>

-		</operation>		

-	</file>	

-	<file name="$sourcedir/MessageIndex.php">	

+	<file name="$sourcedir/MessageIndex.php"><!-- Be sure to get the topic data, to be able to display whether something is solved or not. -->

 		<operation>

 			<search position="after"><![CDATA[determineTopicClass($context['topics'][$row['id_topic']]);]]></search>

 			<add><![CDATA[// Topic solved highlighting, if enabled.

@@ -200,25 +106,31 @@ function ModifyTopicSolvedSettings($return_config = false)

 			]]></add>

 		</operation>

 		<operation>

-			<search position="before"><![CDATA[SUBSTRING(mf.body, 1, 385) AS first_body, ml.smileys_enabled AS last_smileys, mf.smileys_enabled AS first_smileys]]></search>

+			<search position="before"><![CDATA[mf.smileys_enabled AS first_smileys]]></search>

 			<add><![CDATA[, t.solved]]></add>

 		</operation>

 		<operation>

 			<search position="after"><![CDATA[// Begin 'printing' the message index for current board.]]></search>

 			<add><![CDATA[// Is this board solvable?

 		$context['board_solve'] = !empty($modSettings['topicsolved_board_' . $board]);

-		if (!empty($modSettings['topicsolved_highlight']))

-		{

-			if (!empty($modSettings['topicsolved_highlight_col1']) && !empty($modSettings['topicsolved_highlight_col2']))

+		if (!empty($modSettings['topicsolved_highlight']) && !empty($modSettings['topicsolved_highlight_col1']) && !empty($modSettings['topicsolved_highlight_col2']))

 		{

 			if (empty($context['html_headers']))

 				$context['html_headers'] = '';

 			$context['html_headers'] .= '<style type="text/css">/* Topic solved */ .solvedbg { background:' . $modSettings['topicsolved_highlight_col1'] . '; } .solvedbg2 { background:' . $modSettings['topicsolved_highlight_col2'] . '; }</style>';

 		}

-		}

 		]]></add>

 		</operation>

 	</file>

-

+	<file name="$boarddir/SSI.php"><!-- Make sure the topic solved icon is actually added to the SSI functions too. Same code, used twice. -->

+		<operation>

+			<search position="replace"><![CDATA[$stable_icons = array('xx']]></search>

+			<add><![CDATA[$stable_icons = array('solved', 'xx']]></add>

+		</operation>

+		<operation>

+			<search position="replace"><![CDATA[$stable_icons = array('xx']]></search>

+			<add><![CDATA[$stable_icons = array('solved', 'xx']]></add>

+		</operation>

+	</file>

 </modification>

\ No newline at end of file

@@ -10,14 +10,21 @@

 		<modification>install2.0.xml</modification>

 		<modification>english.xml</modification>

 		<require-file name="SolveTopic.php" destination="$sourcedir" />

+		<require-file name="SolveTopic-Admin.php" destination="$sourcedir" />

 		<require-file name="solved.gif" destination="$imagesdir/post" />

+		<require-file name="SolveTopic-Display.template.php" destination="$themes_dir/default" />

 		<database>install.php</database>

+		<redirect url="?action=admin;area=modsettings;sa=topicsolved" />

 	</install>

 	<uninstall for="2.0-2.99.99">

+		<database>uninstall-optional.php</database>

+		<code>uninstall-required.php</code>

 		<readme type="inline">This will uninstall the Topic Solved Mod. Thanks for using this customization.</readme>			

 		<modification reverse="true">install2.0.xml</modification>	

 		<modification reverse="true">english.xml</modification>

 		<remove-file name="$sourcedir/SolveTopic.php" />

+		<remove-file name="$sourcedir/SolveTopic-Admin.php" />

 		<remove-file name="$imagesdir/post/solved.gif" />

+		<remove-file name="$themes_dir/default/SolveTopic-Display.template.php" />

 	</uninstall>	

 </package-info>

\ No newline at end of file

@@ -0,0 +1,58 @@

+<?php

+if (file_exists(dirname(__FILE__) . '/SSI.php') && !defined('SMF'))

+	require_once(dirname(__FILE__) . '/SSI.php');

+elseif (!defined('SMF')) // If we are outside SMF and can't find SSI.php, then throw an error

+	die('<b>Error:</b> Cannot uninstall - please verify you put this file in the same place as SMF\'s SSI.php.');

+

+// OK, so we're cleaning up everything in the DB. The new columnw will have been taken care of already.

+

+// 1. Clean up the settings table.

+$remove = array('enable_solved');

+foreach ($modSettings as $variable => $value)

+	if (strpos($variable, 'topicsolved') === 0)

+		$remove[] = $variable;

+

+$smcFunc['db_query']('', '

+	DELETE FROM {db_prefix}settings WHERE variable IN ({array_string:vars})',

+	array(

+		'vars' => $remove

+	)

+);

+

+// 2. Clean up permissions.

+$smcFunc['db_query']('', '

+	DELETE FROM {db_prefix}board_permissions

+	WHERE permission LIKE {string:perm}',

+	array(

+		'perm' => 'solve_topic%',

+	)

+);

+

+// 3. Clean up the moderation log.

+$smcFunc['db_query']('', '

+	DELETE FROM {db_prefix}log_actions

+	WHERE id_log = {int:topic_solved_log}',

+	array(

+		'topic_solved_log' => 4,

+	)

+);

+

+// 4. Reset topic solved icons to their normal state.

+$smcFunc['db_query']('', '

+	UPDATE {db_prefix}messages

+	SET icon = {string:xx}

+	WHERE icon = {string:solved}',

+	array(

+		'xx' => 'xx', // for the bog standard icon

+		'solved' => 'solved', // for our icon

+	)

+);

+

+if (SMF == 'SSI')

+{

+	if (in_array('solved', $installed))

+		echo 'All topic-solved activity has been removed!';

+	else

+		echo 'Database edits failed!';

+}

+?>

\ No newline at end of file

@@ -0,0 +1,21 @@

+<?php

+if (file_exists(dirname(__FILE__) . '/SSI.php') && !defined('SMF'))

+	require_once(dirname(__FILE__) . '/SSI.php');

+elseif (!defined('SMF')) // If we are outside SMF and can't find SSI.php, then throw an error

+	die('<b>Error:</b> Cannot uninstall - please verify you put this file in the same place as SMF\'s SSI.php.');

+

+// We need to clean out things like hooks, and we must do this on an uninstall regardless of anything else.

+

+remove_integration_function('integrate_mod_buttons', 'add_topicsolved_button');

+remove_integration_function('integrate_admin_include', '$sourcedir/SolveTopic-Admin.php');

+remove_integration_function('integrate_modify_modifications', 'add_ts_settings_menu');

+remove_integration_function('integrate_admin_areas', 'add_ts_adminmenu');

+

+if (SMF == 'SSI')

+{

+	if (in_array('solved', $installed))

+		echo 'Basic database changes edits removed!';

+	else

+		echo 'Database edits failed!';

+}

+?>

\ No newline at end of file