turing 0.0.7

data/lib/turing/image.rb

@@ -0,0 +1,245 @@
+#!/usr/bin/ruby
+#
+# Turing -- Ruby implementation of Captcha
+#
+# Copyright © 2005 Michal Šafránek <wejn@box.cz>
+#
+# This file is part of http://turing.rubyforge.org/
+#
+# See turing.rb in lib/ directory for license terms.
+#
+require 'rubygems'
+require_gem 'gd2'
+require 'turing'
+require 'pathname'
+
+# == Simple obfuscated image generator with plugin design
+#
+# Generates obfuscated image containing given word by using
+# one of its registered plugins.
+#
+# For it's operation it requires gd2 gem, available from http://gd2.rubyforge.org/.
+#
+# Example of use:
+#   ti = Turing::Image.new(:width => 280, :height => 115)
+#   ti.generate(File.join(Dir.getwd, 'a.jpg'), "randomword")
+# In this case we generate image using random plugin containing
+# word "randomword". It is saved as <tt>`pwd`/a.jpg</tt>.
+#
+# === A word about plugins
+# All plugins are "registered" by subclassing Turing::Image (which is
+# implemented using <tt>self.inherited</tt>). It makes sense to subclass
+# Turing::Image because that way you'll also get goodies like #write_string.
+#
+# Plugins are auto-loaded by require from <tt>lib/turing/image_plugins</tt>
+# after Turing::Image is created but you're free to manually load any plugin
+# you like.
+#
+# For inspiration on how to write new plugin visit any of the existing
+# plugins in +image_plugins+ dir, minimal template would be:
+#  class MyCoolPlugin < Turing::Image
+#      def initialize(opts = {})
+#          super(opts)
+#      end
+#  
+#      def generate(img, word)
+#          write_string(img, 'cour.ttf', GD2::Color[0, 0, 0], word, 48)
+#      end
+#  end
+class Turing::Image # {{{
+	# All content generating plugins
+	@@plugins = []
+	
+	# Configure instance using options hash.
+	#
+	# *Warning*: Keys of this hash must be symbols.
+	#
+	# Accepted options:
+	# * +fontdir+: Directory containing .ttf fonts required by plugins. Default: gem's <tt>shared/fonts</tt> directory.
+	# * +bgdir+: Directory containing .jpeg files used as background by plugins. Default: gem's <tt>shared/bgs</tt> directory.
+	# * +outdir+: Output directory where to put image in case absolute path wasn't specified.
+	# * +width+: Width of the image.
+	# * +height+: Height of the image.
+	# * +method+: Use specified plugin instead of randomly selected. You must give class that implements +generate+ instance method. Default: nil.
+	def initialize(opts = {}) # {{{
+		raise ArgumentError, "Opts must be hash!" unless opts.kind_of? Hash
+		
+		base = File.join(File.dirname(__FILE__), '..', '..', 'shared')
+		@options = {
+			:fontdir => File.join(base, 'fonts'),
+			:bgdir => File.join(base, 'bgs'),
+			:outdir => ENV["TMPDIR"] || '/tmp',
+			:width => 280,
+			:height => 115,
+		}
+
+		@options.merge!(opts)
+	end # }}}
+
+	# Generate image into +outname+ containing +word+ (using +method+).
+	#
+	# *Warning*: If you pass absolute filename as +outname+, +outdir+ will have no effect.
+	#
+	# *Warning*: There's no way to reset +method+ to random if it was specified upon instance creation.
+	def generate(outname, word, method = nil) # {{{
+		# select appropriate output plugin # {{{
+		m = method || @options[:method]
+		if m.nil?
+			if @@plugins.empty?
+				raise RuntimeError, "no generators plugins available!"
+			end
+			m = @@plugins[rand(@@plugins.size)]
+		end
+		unless m.instance_methods.include?("generate")
+			raise ArgumentError, "plugin #{m} doesn't have generate method"
+		end
+		# }}}
+
+		# prepend outname with outdir, if no absolute path given
+		unless Pathname.new(outname).absolute?
+			outname = File.join(@options[:outdir], outname)
+		end
+		
+		img = GD2::Image.new(@options[:width], @options[:height])
+
+		img.draw do |canvas|
+			canvas.color = GD2::Color[255, 255, 255]
+			canvas.rectangle(0, 0, img.width - 1, img.height - 1, true)
+		end
+
+		m.new(@options).generate(img, word)
+		
+		img.draw do |canvas|
+			canvas.color = GD2::Color[0, 0, 0]
+			canvas.rectangle(0, 0, img.width - 1, img.height - 1)
+		end
+
+		begin
+			File.open(outname, 'w') { |f| f.write(img.jpeg(90)) }
+		rescue
+			raise "Unable to write challenge: #{$!}"
+		end
+
+		true
+	end # }}}
+
+	# Private methods
+	private
+
+	# Write +string+ to +img+ using color +fg+ and +font+
+	# (with size +req_size+, if possible) at random coordinates
+	# and using random angle.
+	#
+	# Method checks bounding box so the string is guaranteed to stay
+	# within image's dimensions.
+	#
+	# May raise RuntimeError if it's completely impossible to find suitable
+	# fontsize for given dimensions.
+	def write_string(img, font, fg, string, req_size = nil) # {{{ # :doc:
+		# prepend fontname with fontdir, unless absolute path given
+		unless Pathname.new(font).absolute?
+			font = File.join(@options[:fontdir], font)
+		end
+		sizes = (16..42).to_a.reverse
+		turbulence = 5 # x%
+		mult = 0.85 * ((rand(turbulence*2 + 1) - turbulence) / 100.0 + 1.0)
+
+		# select angle
+		angle = -5 + rand(11)
+		
+		# font size determination ...
+		chosen = nil # {{{
+		sizes.unshift(req_size) unless req_size.nil?
+		sizes.each do |size|
+			bounds = nil
+			begin
+				bounds = GD2::Font::TrueType.new(font, size).
+					bounding_rectangle(string, angle.degrees)
+			rescue
+				raise "Unable to detect bounding box: #{$!}"
+			end
+
+			minx, maxx = bounds.values.map { |x| x[0] }.sort.values_at(0, -1)
+			miny, maxy = bounds.values.map { |x| x[1] }.sort.values_at(0, -1)
+
+			bb_width = maxx - minx
+			bb_height = maxy - miny
+
+			if img.width * mult > bb_width && img.height * mult > bb_height
+				chosen = {
+					:size => size,
+					:width => bb_width,
+					:height => bb_height,
+				}
+				break
+			end
+		end # }}}
+
+		raise "Unable to select size" if chosen.nil?
+		
+		x_base, y_base = 1, img.height / 2
+
+		x_offset = rand(((img.width - chosen[:width])*mult).to_i)
+		y_offset = rand((((img.height - chosen[:height]) / 2)*mult).to_i)
+
+		x = x_base + x_offset
+		y = y_base + y_offset
+
+		img.draw do |canvas|
+			canvas.move_to(x, y)
+			canvas.color = fg
+			canvas.font = GD2::Font::TrueType.new(font, chosen[:size])
+			canvas.text(string, angle.degrees)
+		end
+
+		img
+	end # }}}
+
+	# Record all plugins available
+	# (subclasses which implement class method generate)
+	def self.inherited(other) # {{{
+		(@@plugins ||= []) << other
+	end # }}}
+end # }}}
+
+# Load all image plugins ...
+# {{{
+plugin_dir = File.join(File.dirname(__FILE__), 'image_plugins')
+if FileTest.directory?(plugin_dir)
+	Dir[File.join(plugin_dir, '*')].each do |f|
+		bn = File.basename(f)
+		begin
+			require 'turing/image_plugins/' + bn
+		rescue Object
+			raise RuntimeError, "Exception while loading plugin: #{bn}: #{$!}"
+		end
+	end
+end
+# }}}
+
+# Test it out, when executed directly
+if __FILE__ == $0 # {{{
+	ti = Turing::Image.new(:width => 280, :height => 115)
+
+	# debug loop
+	begin # {{{
+		loop do
+			dict_fn = File.join(File.dirname(__FILE__), '..', '..', 'shared',
+				'dictionary')
+			dict = File.open(dict_fn).readlines.map! { |x| x.chomp }
+			ti.generate(File.join(Dir.getwd, 'a.jpg'),
+				dict[rand(dict.size)])
+			pid = fork do
+				exec("xv", "a.jpg")
+			end
+			Process.detach(pid)
+			sleep 2
+			Process.kill(9, pid)
+		end
+	rescue Interrupt
+	ensure
+		File.unlink('a.jpg') rescue nil
+	end # }}}
+end # }}}
+
+# vim: set ts=4 sw=4 :

data/lib/turing/image_plugins/__squaring_helper.rb

@@ -0,0 +1,66 @@
+#
+# Turing -- Ruby implementation of Captcha
+#
+# Copyright © 2005 Michal Šafránek <wejn@box.cz>
+#
+# This file is part of http://turing.rubyforge.org/
+#
+# See turing.rb in lib/ directory for license terms.
+#
+
+# == Squaring helper
+# Skeleton for Turing::Image::*Squaring (mixin, actually).
+module Turing::Image::SquaringHelper # {{{
+	# contract method - generate the challenge
+	def generate(img, word, bg = nil) # {{{
+		if bg.nil?
+			possible = Dir[File.join(@options[:bgdir], '*')]
+			bg = possible[rand(possible.size)]
+		else
+			unless FileTest.exists?(bg)
+				raise ArgumentError, "Wrong background!"
+			end
+		end
+
+		img_tmp = GD2::Image.load(File.open(bg, 'r'))
+
+		if img_tmp.width < img.width || img_tmp.height < img.height
+			raise "Background has insufficient dimensions"
+		end
+
+		img.merge_from(img_tmp, 0, 0, 0, 0, img.width, img.height, 30.percent)
+
+		# XXX: is this equivalent to "img_tmp.destroy" ?
+		img_tmp = nil
+
+		fg = GD2::Color[0, 0, 0]
+
+		write_string(img, 'cour.ttf', fg, word, 35)
+
+		raise RuntimeError, "no squaring color selected!" if @squaring_color.nil?
+		fg = @squaring_color
+		
+		img.draw do |canvas|
+			canvas.color = fg
+			if rand(2).zero?
+				delta = word.size > 8 ? 6 : 4
+				0.step(img.width, delta) { |x| canvas.line(x, 0, x, img.height) }
+				0.step(img.height, delta) { |y| canvas.line(0, y, img.width, y) }
+			else
+				i = 0
+				while i <= img.width
+					canvas.line(i, 0, i, img.height)
+					i += 3 + rand(4)
+				end
+
+				i = 0
+				while i <= img.height
+					canvas.line(0, i, img.width, i)
+					i += 3 + rand(4)
+				end
+			end
+		end
+	end # }}}
+end # }}}
+
+# vim: set ts=4 sw=4 :

data/lib/turing/image_plugins/black_squaring.rb

@@ -0,0 +1,23 @@
+#
+# Turing -- Ruby implementation of Captcha
+#
+# Copyright © 2005 Michal Šafránek <wejn@box.cz>
+#
+# This file is part of http://turing.rubyforge.org/
+#
+# See turing.rb in lib/ directory for license terms.
+#
+require 'turing/image_plugins/__squaring_helper'
+
+# == BlackSquaring Turing test
+# Blends text, background and makes square pattern over image.
+class Turing::Image::BlackSquaring < Turing::Image # {{{
+	def initialize(opts = {})
+		super(opts)
+		@squaring_color = GD2::Color[0, 0, 0]
+	end
+
+	include Turing::Image::SquaringHelper
+end # }}}
+
+# vim: set ts=4 sw=4 :

data/lib/turing/image_plugins/blending.rb

@@ -0,0 +1,44 @@
+#
+# Turing -- Ruby implementation of Captcha
+#
+# Copyright © 2005 Michal Šafránek <wejn@box.cz>
+#
+# This file is part of http://turing.rubyforge.org/
+#
+# See turing.rb in lib/ directory for license terms.
+#
+
+# == Blending Turing test 
+# Blends text with background (highly imperfect for some backgrounds).
+class Turing::Image::Blending < Turing::Image # {{{
+	# contract method - generate the challenge
+	def generate(img, word, bg = nil) # {{{
+		if bg.nil?
+			possible = Dir[File.join(@options[:bgdir], '*')]
+			bg = possible[rand(possible.size)]
+		else
+			unless FileTest.exists?(bg)
+				raise ArgumentError, "Wrong background!"
+			end
+		end
+
+		img_tmp = GD2::Image.load(File.open(bg, 'r'))
+
+		if img_tmp.width < img.width || img_tmp.height < img.height
+			raise "Background has insufficient dimensions"
+		end
+
+		img.copy_from(img_tmp, 0, 0, 0, 0, img.width, img.height)
+
+		# XXX: equivalent of img_tmp.destroy ?
+		img_tmp = nil
+
+		r = rand(32)
+		fg = GD2::Color[r, r, r, 40.percent]
+
+		write_string(img, 'georgiai.ttf', fg, word, 40)
+
+	end # }}}
+end # }}}
+
+# vim: set ts=4 sw=4 :

data/lib/turing/image_plugins/random_noise.rb

@@ -0,0 +1,32 @@
+#
+# Turing -- Ruby implementation of Captcha
+#
+# Copyright © 2005 Michal Šafránek <wejn@box.cz>
+#
+# This file is part of http://turing.rubyforge.org/
+#
+# See turing.rb in lib/ directory for license terms.
+#
+
+# == Random Noise turing test
+# Generates random black noise, then text, then random white noise.
+class Turing::Image::RandomNoise < Turing::Image # {{{
+	# contract method - generate the challenge
+	def generate(img, word, bg = nil) # {{{
+		fg = GD2::Color[255, 255, 255]
+		bg = GD2::Color[0, 0, 0]
+		
+		0.upto(img.width * img.height * 0.4) do |i|
+			img[rand(img.width), rand(img.height)] = bg
+		end
+
+		write_string(img, 'georgiai.ttf', bg, word, 48)
+		
+		quant = word.size > 7 ? 0.1 : 0.2
+		0.upto(img.width * img.height * quant) do |i|
+			img[rand(img.width), rand(img.height)] = fg
+		end
+	end # }}}
+end # }}}
+
+# vim: set ts=4 sw=4 :

data/lib/turing/image_plugins/spiral.rb

@@ -0,0 +1,56 @@
+#
+# Turing -- Ruby implementation of Captcha
+#
+# Copyright © 2005 Michal Šafránek <wejn@box.cz>
+#
+# This file is part of http://turing.rubyforge.org/
+# and is based on PHP captcha implementation "Session captcha"
+# which can be found at http://sourceforge.net/projects/session-captcha/
+#
+# See turing.rb in lib/ directory for license terms.
+#
+
+# == Spiral Turing test
+# Renders spirals plus text over them.
+class Turing::Image::Spiral < Turing::Image # {{{
+	# contract method - generate the challenge
+	def generate(img, word) # {{{
+		fg = GD2::Color[185, 140, 140]
+		sfg = GD2::Color[225, 190, 190]
+
+		spiral(img, (img.width/3) + rand(img.width/3), rand(img.height), sfg)
+
+		write_string(img, 'cour.ttf', fg, word)
+
+		spiral(img, rand(img.width / 3), rand(img.height), sfg)
+		spiral(img, 2*(img.width/3) + rand(img.width/3), rand(img.height), sfg)
+	end # }}}
+
+	private
+
+	# renders spiral with center at [originx, originy] using color
+	def spiral(img, originx, originy, color) # {{{
+		theta = 1.0
+		thetac = 6.0
+		radius = 15.0
+		circles = 10.0
+		points = 35.0
+		img.draw do |canvas|
+			canvas.color = color
+			0.upto(circles * points - 1) do |i|
+				theta += thetac
+				rad = radius * (i.to_f / points)
+				x = rad * Math.cos(theta) + originx
+				y = rad * Math.sin(theta) + originy
+				theta += thetac
+				rad1 = radius * ((i.to_f + 1.to_f) / points)
+				x1 = rad1 * Math.cos(theta) + originx
+				y1 = rad1 * Math.sin(theta) + originy
+				canvas.line(x.round, y.round, x1.round, y1.round)
+				theta -= thetac
+			end
+		end
+	end # }}}
+end # }}}
+
+# vim: set ts=4 sw=4 :