smfmod_sfs

Fix a few issues: - Redirect after install - Readme is not very descriptive - Missing label for a option on the admins page
Parent 53eb856
Jeremy D

Jeremy D commited on 2022-03-19 18:35:47
Showing 4 changed files, with 73 additions and 5 deletions.

README.bbc
View file @ 18ecacd
... ... 
@@ -0,0 +1,36 @@
1 
+[size=4]Stop Forum Spam[/size]
2 
+[size=3]Description[/size]
3 
+This customization adds support for detecting spam by using the [url=https://www.stopforumspam.com/]Stop Forum Spam[/url] API.
4 
+
5 
+[size=3]SMF Version support[/size]
6 
+This supports SMF 2.0.x and 2.1.x
7 
+
8 
+[size=3]Sections checked[/size]
9 
+On registration this can check the following fields:
10 
+- Username
11 
+- Email Address
12 
+- IP Address
13 
+-
14 
+On Posts this can check the following fields
15 
+- Username
16 
+- Email Address
17 
+- IP Address
18 
+-
19 
+On Search this chan check:
20 
+- IP Address
21 
+-
22 
+On Report(ing) posts this can check:
23 
+- Email
24 
+- IP Address
25 
+-
26 
+This can also check custom forms by specifying the id of the field in a comma separated list into the extra fields options.
27 
+
28 
+[size=3]Setup[/size]
29 
+Out of the box this has a default configuration of checking only usernames.  Additionally the confidence level for username can be adjusted.
30 
+
31 
+This can also block TOR as reported to the Stop Forum Spam database.
32 
+
33 
+The Verification Options section controls on which controls we are enforcing these checks again.
34 
+
35 
+[size=3]Compatibility[/size]
36 
+This has some setting compatibility with the original Stop Forum Spam as I was using it when I developed this.  The biggest difference is this supports SMF 2.1 and does not use any edits.  This version includes logging, bulk checks and the ability to check non standard SMF verification fields.
0 37 
\ No newline at end of file
README.md
View file @ 18ecacd
... ... 
@@ -1,7 +1,36 @@
1 
-A customization for SMF 2.0 or 2.1.
1 
+# Stop Forum Spam
2 
+### Description
3 
+This customization adds support for detecting spam by using the [Stop Forum Spam](https://www.stopforumspam.com/) API.
2 4
3 
-This has some setting compatibility with the original Stop Forum Spam as I was using it when I developed this.
5 
+### SMF Version support
6 
+This supports SMF 2.0.x and 2.1.x
4 7
5 
-This version includes logging, bulk checks and the ability to check non standard SMF verification fields.
8 
+### Sections checked
9 
+On registration this can check the following fields:
10 
+- Username
11 
+- Email Address
12 
+- IP Address
13 
+-
14 
+On Posts this can check the following fields
15 
+- Username
16 
+- Email Address
17 
+- IP Address
18 
+-
19 
+On Search this chan check:
20 
+- IP Address
21 
+-
22 
+On Report(ing) posts this can check:
23 
+- Email
24 
+- IP Address
25 
+-
26 
+This can also check custom forms by specifying the id of the field in a comma separated list into the extra fields options.
6 27
7 
-This is in development as I develop its needs for SimpleDesk where I am primary using it.
8 28 
\ No newline at end of file
29 
+### Setup
30 
+Out of the box this has a default configuration of checking only usernames.  Additionally the confidence level for username can be adjusted.
31 
+
32 
+This can also block TOR as reported to the Stop Forum Spam database.
33 
+
34 
+The Verification Options section controls on which controls we are enforcing these checks again.
35 
+
36 
+### Compatibility
37 
+This has some setting compatibility with the original Stop Forum Spam as I was using it when I developed this.  The biggest difference is this supports SMF 2.1 and does not use any edits.  This version includes logging, bulk checks and the ability to check non standard SMF verification fields.
9 38 
\ No newline at end of file
language/StopForumSpam.english.php
View file @ 18ecacd
... ... 
@@ -40,6 +40,7 @@ $txt['sfs_verification_desc'] = 'Usage of these options reuqire Anti-Spam Verifi
40 40
41 41 
 /* Admin Section: Verification Options for guests */
42 42 
 $txt['sfs_verification_options'] = 'Guest Verification Sections';
43 
+$txt['sfs_verOptionsMembers'] = 'Member Verification Sections';
43 44 
 $txt['sfs_verification_options_post'] = 'Posting';
44 45 
 $txt['sfs_verification_options_report'] = 'Reporting Topics';
45 46 
 $txt['sfs_verification_options_search'] = 'Search (Not Recommended)';
package-info.xml
View file @ 18ecacd
... ... 
@@ -12,6 +12,7 @@
12 12
13 13 
 	<!-- 2.0 has no support for hooks -->
14 14 
 	<install for="2.0.*">
15 
+		<readme type="file" parsebbc="true">README.bbc</readme>
15 16 
 		<database>install_sfs.php</database>
16 17 
 		<code type="file">sfs_hooks_install.php</code>
17 18 
 		<modification>install_smf20.xml</modification>
... ... 
@@ -37,6 +38,7 @@
37 38 
 	</uninstall>
38 39
39 40 
 	<install for="2.1.*">
41 
+		<readme type="file" parsebbc="true">README.bbc</readme>
40 42 
 		<database>install_sfs.php</database>
41 43
42 44 
 		<require-file name="language/StopForumSpam.english.php" destination="$themes_dir/default/languages" />
... ... 
@@ -57,7 +59,7 @@
57 59 
 			<hook hook="integrate_modify_modifications" function="SFSA::hook_modify_modifications" />
58 60 
 			<hook hook="integrate_manage_logs" function="SFSA::hook_manage_logs" />
59 61
60 
-		<redirect url="?action=admin;area=securitysettings;sa=sfs" />
62 
+		<redirect url="?action=admin;area=modsettings;sa=sfs" />
61 63 
 	</install>
62 64
63 65 
 	<uninstall for="2.1.*">
64 66