Merge branch 'msftidy_badchars' of https://github.com/wchen-r7/metasploit-framework into wchen-r7-msftidy_badchars

Author: jvazquez-r7

tools/msftidy.rb

@@ -36,8 +36,9 @@ def initialize(source_file)
 
 	##
 	#
-	# The following two functions only print what you throw at them.
-	# With an option of displaying the line number.
+	# The following two functions only print what you throw at them,
+	# with the option of displying the line number.  error() is meant
+	# for mistakes that might actually break something.
 	#
 	##
 
@@ -58,6 +59,70 @@ def error(txt, line=0)
 	#
 	##
 
+	def check_badchars
+		badchars = %Q|&<=>|
+
+		in_super   = false
+		in_author  = false
+
+		@source.each_line do |line|
+			#
+			# Mark our "super" code block
+			#
+			if !in_super and line =~ /[\n\t]+super\(/
+				in_super = true
+			elsif in_super and line =~ /[[:space:]]*def \w+[\(\w+\)]*/
+				in_super = false
+				break
+			end
+
+			#
+			# While in super() code block
+			#
+			if in_super and line =~ /'Name'[[:space:]]*=>[[:space:]]*['|"](.+)['|"]/
+				# Now we're checking the module titlee
+				mod_title = $1
+				mod_title.each_char do |c|
+					if badchars.include?(c)
+						error("'#{c}' is a bad character in module title.")
+					end
+				end
+
+				if not mod_title.ascii_only?
+					error("Please avoid unicode in module title.")
+				end
+
+				# Since we're looking at the module title, this line clearly cannot be
+				# the author block, so no point to run more code below.
+				next
+			end
+
+			#
+			# Mark our 'Author' block
+			#
+			if in_super and !in_author and line =~ /'Author'[[:space:]]*=>/
+				in_author = true
+			elsif in_super and in_author and line =~ /\],*\n/
+				in_author = false
+			end
+
+
+			#
+			# While in 'Author' block, check for Twitter handles
+			#
+			if in_super and in_author and line =~ /['|"](.+)['|"]/
+				author_name = $1
+				if author_name =~ /^@.+$/
+					error("No Twitter handle, please. Try leaving it in a comment instead.")
+				end
+
+				if not author_name.ascii_only?
+					error("Please avoid unicode in Author")
+				end
+			end
+		end
+	end
+
 	def check_extname
 		if File.extname(@name) != '.rb'
 			error("Module should be a '.rb' file, or it won't load.")
@@ -126,7 +191,7 @@ def check_title_format
 			[words.first, words.last].each do |word|
 				if word[0,1] =~ /[a-z]/ and word[1,1] !~ /[A-Z0-9]/
 					next if word =~ /php[A-Z]/
-					next if %w{iseemedia activePDF freeFTPd osCommerce myBB qdPM}.include? word
+					next if %w{iseemedia activePDF freeFTPd osCommerce myBB qdPM inetd wallet.dat}.include? word
 					warn("Improper capitalization in module title: '#{word}...'")
 				end
 			end
@@ -234,6 +299,7 @@ def load_file(file)
 
 def run_checks(f_rel)
 	tidy = Msftidy.new(f_rel)
+	tidy.check_badchars
 	tidy.check_extname
 	tidy.test_old_rubies(f_rel)
 	tidy.check_ranking