Soks 0.0.2 → 0.0.3

data/contrib/redcloth-2.0.11.rb

@@ -529,7 +529,9 @@ class RedCloth < String
                 end unless pre
             end
             
-            line.gsub!( /^(?!\t|<\/?div|<\/?pre|<\/?notextile|<\/?code|$| )(.*)/, "\t<p>\\1</p>" ) unless pre
+            # line.gsub!( /^(?!\t|<\/?div|<\/?pre|<\/?notextile|<\/?code|$| )(.*)/, "\t<p>\\1</p>" ) unless pre
+            
+            line.gsub!( /^(?!\t|<\/?div|<\/?pre|<\/?notextile|<\/?code| )(.*)/, "\t<p>\\1</p>" ) unless pre
             
             line.gsub!( "<br />", "\n" ) if pre
             pre = false if line =~ /<\/(pre|notextile)>/i

data/lib/authenticators.rb

@@ -5,7 +5,23 @@ require 'base64'
 
 module WEBrick
   module HTTPAuth
-		class NotAuthentication
+		
+		class NoAuthenticationRequired
+			
+			def authenticate(req, res)
+				req.user = req.meta_vars["HTTP_X_FORWARDED_FOR"] || req.meta_vars["REMOTE_ADDR"]
+			end
+		end
+		
+		class NotPermitted
+			
+			def authenticate(req, res)
+				raise WEBrick::HTTPStatus::Unauthorized
+			end
+				
+		end
+	
+		class AskForUserName
 			
 			include WEBrick::HTTPAuth::Authenticator
 			
@@ -36,7 +52,7 @@ module WEBrick
 		   end
 		end
 		
-    class OnePasswordAuthentication
+    class SiteWidePassword
       include Authenticator
 
       AuthScheme = "Basic"

data/lib/soks-helpers.rb

@@ -3,8 +3,8 @@ require 'net/smtp'
 
 class AutomaticUpdateCrossLinks
 
-	def initialize( wiki )
-		@wiki = wiki
+	def initialize( wiki, view, banned_titles = [] )
+		@wiki, @view, @banned_titles = wiki, view, banned_titles
 		@wiki.watch_for( :page_created ) { |event, page| new_page( page ) }
 		@wiki.watch_for( :page_deleted ) { |event, page| delete_page( page ) }
 		@wiki.watch_for( :page_revised ) { |event, page| page_revised( page ) }
@@ -12,208 +12,199 @@ class AutomaticUpdateCrossLinks
 	end
 
 	def new_page( page )
-		@wiki.rollingmatch[ page.name ] = page
+		return if title_banned? page.name
+		@view.rollingmatch[ page.name ] = page 
 		titleregex = Regexp.new( page.name, Regexp::IGNORECASE )
 		@wiki.each { |name, linkedpage | 
-			unless name[0,10] == 'Site Index'
-				@wiki.refresh_redcloth( linkedpage ) if linkedpage.textile =~ titleregex
-			end
+		   @view.refresh_redcloth( linkedpage ) if linkedpage.textile =~ titleregex
 		}
 	end
 	
 	def delete_page( page )
-		@wiki.rollingmatch.delete( page.name )
-		page.links_to.each { |linkedpage| @wiki.refresh_redcloth( linkedpage ) }
+		@view.rollingmatch.delete( page.name )
+		page.links_to.each { |linkedpage| @view.refresh_redcloth( linkedpage ) }
 	end
 	
 	def page_revised( page )
 		page.inserted_into.each { |including_page| 
-			@wiki.refresh_redcloth( including_page ) 
+			@view.refresh_redcloth( including_page ) 
 		}
 	end
 	
 	def update_all_pages
-		@wiki.each { |pagename, page| @wiki.rollingmatch[ page.name ] = page }
-		@wiki.each { |pagename, page| @wiki.refresh_redcloth( page ) }
-	end
-end
-
-class AutomaticRecentChanges
-
-	IGNORED_AUTHORS = /^Automatic/
-	
-	def initialize( wiki, lines = 200, pagename = "Recent Changes to This Site", author = "AutomaticRecentChanges" )
-		@wiki, @lines, @pagename, @author = wiki, lines, pagename, author
-		@wiki.watch_for( :page_revised ) { |event, page, revision| revised( page, revision ) }
-	end
-	
-	def revised( page, revision )
-		unless ( revision.author =~ IGNORED_AUTHORS )
-			add_recent_change( page, revision )
-		end
-	end
-		
-	def add_recent_change( page, revision )
-		changes_content = "On #{revision.created_at.strftime('%Y %b %d')}, #{revision.author} made these changes to [[#{page}]]:\n"
-		revision.changes.each do |change_group| change_group.each do |change|
-				next if change[2] == ""
-				changes_content <<  case change[0]
-				# Note, +/- reversed because diffs stored as diff from CURRENT version
-				when "-" ; "| #{change[1]} | -<notextile>#{change[2]}</notextile>- |\n"
-				when "+" ; "| #{change[1]} | <notextile>#{change[2]}</notextile> |\n"
-				end
-		end  end
-		changes_content << "\n"
-		changes_content << @wiki.page( @pagename ).content.first_lines( @lines ) unless @wiki.page( @pagename ).empty?
-		@wiki.revise( @pagename , changes_content, @author)
-	end	
-end
-
-class AutomaticOnePageIndex
-	
-	def initialize( wiki, pagename = "Site Index", author = "AutomaticIndex"  )
-		@wiki, @pagename, @author = wiki, pagename, author
-		@wiki.watch_for( :page_created, :page_deleted ) { update_index }
-		update_index
-	end	
-	
-	def update_index
-		index = @wiki.sort_by{ |name, page| page.name_for_index.capitalize }.map{ |name, page| "* [[ #{page} ]]\n" }
-		@wiki.revise( @pagename, "h1. Index\n\n#{index}", @author )
-	end
-end
-
-class AutomaticMultiPageIndex < AutomaticOnePageIndex
-	
-	def update_index
-		buckets = separate_pages_by_first_character
-		link_bar = link_bar_from_buckets( buckets )
-		buckets.each do |firstcharacter, pages|
-			index = pages.sort_by{ |page| page.name_for_index.capitalize }.map{ |page| "* [[ #{page} ]]\n" }
-			@wiki.revise( "#{@pagename} #{firstcharacter}", "h1. Site Index #{firstcharacter}\n\n#{link_bar}\n\n#{index}", @author )
-		end
-		@wiki.revise( @pagename, "h1. Site Index\n\n#{link_bar}", @author )
-	end
-	
-	def separate_pages_by_first_character
-		buckets = Hash.new
-		@wiki.each do |name, page|
-			( buckets[ page.name_for_index[0,1].upcase ] ||= [] ) << page
-		end
-		buckets
-	end
-	
-	def link_bar_from_buckets( buckets )
-		buckets.keys.sort.map { |letter| "[[ #{letter} : #{@pagename} #{letter} ]]\n" }.join(' ')
-	end
-end
-
-class FiniteUniqueList
-	include Enumerable
-	
-	attr_accessor :max_size
-	
-	def initialize( max_size = nil )
-		@max_size = max_size
-		@list = Array.new
-	end
-
-	def add( item )
-		remove( item )
-		@list << item
-		remove_excess_items
-	end
-	
-	def remove( item )
-		@list.delete( item )
+		@wiki.each { |pagename, page| @view.rollingmatch[ page.name ] = page unless title_banned?( page.name )}
+		@wiki.each { |pagename, page| @view.refresh_redcloth( page ) }
 	end
 	
-	def each
-		@list.reverse_each { |item| yield item }
+	def title_banned?( title )
+		@banned_titles.include? title
 	end
 	
-	def empty?; @list.empty? end
-	
-	private 
-	
-	def remove_excess_items
-		if @max_size
-			while @list.size > @max_size
-				@list.shift
-			end
-		end
-	end
 end
 
 class AutomaticSummary
 	
 	DEFAULT_SETTINGS = {
-		:regexp_for_pages => /.*/,
+	 	:regexp_for_title => /.*/, # These three regexps act as an AND
+		:regexp_for_author => nil, 
+		:regexp_for_content => nil,
 		:max_pages_to_show => nil,
 		:pagename => 'Summary',
 		:author => 'AutomaticSummary',
-		:lines_to_include => nil,
+		:lines_to_include => nil, # Or pass a block
 		:only_new_pages => false,
+		:sort_pages_by => :created_on, # Could be :revised_on or :score or :name or :name_for_index, or :author
+		:reverse_sort => false,
+		:include_metadata => false, # Includes author and time in summary
+		:summarise_revisions => false, # If true, then can contain several revisions for same page
+		:remove_deleted_pages => true, # If false will keep references to deleted pages
 	}
 
 	attr_reader :settings, :pages_in_summary
 
-	def initialize( wiki, settings = {} )
-		@wiki = wiki
-		@settings = DEFAULT_SETTINGS.merge( settings )
-		@pages_in_summary = FiniteUniqueList.new( @settings[:max_pages_to_show] )
-		scan_for_pages_to_summarise
+	def initialize( wiki, settings = {}, &renderer )
+		@wiki, @settings, @renderer = wiki, DEFAULT_SETTINGS.merge( settings ), renderer
+		setup_list
+		scan_for_pages_to_summarise_in wiki
 		render_summary
-		@wiki.watch_for( @settings[:only_new_pages] ? :page_created : :page_revised ) { |event, page| check_whether_to_add_page( page ) }
-		@wiki.watch_for( :page_deleted ) { |event, page| check_whether_to_remove_page( page ) }
+		start_watching_wiki wiki
 	end
 	
-	def check_whether_to_add_page( page )
+	def check_whether_to_add_page( page, revision )
 		return if page.name == @settings[:pagename]
-		if page.name=~ @settings[:regexp_for_pages]
-			@pages_in_summary.add( page ) 
+		if summarise? page
+			@pages_in_summary.add( @settings[:summarise_revisions] ? revision : page ) 
 			render_summary
 		end
 	end
 	
-	def check_whether_to_remove_page( page )
-		render_summary if @pages_in_summary.remove( page )	
+	def check_whether_to_remove_page( page, revision )
+		return unless @settings[:remove_deleted_pages]
+		render_summary if @pages_in_summary.remove( @settings[:summarise_revisions] ? revision : page )	
 	end
 	
-	def scan_for_pages_to_summarise
-		@wiki.select do |name,page| 
-			name=~ @settings[:regexp_for_pages]
-		end.sort_by  do |name, page| 
-			(@settings[:only_new_pages] ? page.revision[0] : page).created_at
-		end.each 	 do |name, page|
-			@pages_in_summary.add page
+	private
+	
+	def summarise?( page )
+		return false if @settings[:regexp_for_title] && page.name !~ @settings[:regexp_for_title] 
+		return false if @settings[:regexp_for_author] && page.author !~ @settings[:regexp_for_author] 
+		return false if @settings[:regexp_for_content] && page.content !~ @settings[:regexp_for_content]
+		return true 
+	end
+	
+	def scan_for_pages_to_summarise_in( wiki )
+		wiki.each( @settings[:remove_deleted_pages] ) do |name,page| 
+			next if page.name == @settings[:pagename]
+			next unless summarise? page
+			if @settings[:summarise_revisions]
+				page.revisions.each { |revision| @pages_in_summary.add revision }
+			else
+				@pages_in_summary.add page
+			end
 		end
 	end
 	
 	def render_summary
+		if @wiki.exists? @settings[:pagename]
+			old_page = @wiki.page( @settings[:pagename] )
+			if old_page.textile =~ /(.*?<automaticsummary>).*?(<\/automaticsummary>.*)/mi
+				content, tail = $1, $2
+			end
+		end
+		content ||= "h2. #{@settings[:pagename]}\n\np{font-size: x-small;}. #{@settings[:pagename]} was created automatically from pages whose title matches #{@settings[:regexp_for_title].inspect}.\n\n<automaticsummary>"
+		tail ||= "</automaticsummary>"
+		content << "\n\n"
 		if @pages_in_summary.empty?
-			@wiki.revise( @settings[:pagename], "No pages found to summarise" , @settings[:author] )
+			content << "No pages found to summarise"
+		elsif @renderer
+			@pages_in_summary.each { |page| content << @renderer.call(page)  }
+		elsif @settings[:lines_to_include]
+			@pages_in_summary.each { |page| content << render_page(page)  }
 		else
-			content = ""
-			@pages_in_summary.each do |page|
-				content << "<div class='subpage'>\n\n"
-				content << render_page( page )
-				content << "\n\np(more). [[(more) : #{page.name}]]\n\n"
-				content << "</div>\n"
-			end
-			@wiki.revise( @settings[:pagename], content , @settings[:author] )
+			@pages_in_summary.each { |page| content << render_link_to(page) }
 		end
+		content << "\n\n"
+		content << tail
+		@wiki.revise( @settings[:pagename], content , @settings[:author] )
 	end
 	
 	def render_page( page )
-		if @settings[:lines_to_include] 
-			page.textile.first_lines( @settings[:lines_to_include] ) 
-		else
-			page.textile
-		end
+		"<div class='subpage'>\n#[page.name} #{ @settings[:include_metadata] ? render_meta_data( page ) : "" }<br />\n\n#{page.textile.first_lines( @settings[:lines_to_include] ).close_unmatched_html}\n\np(more). [[(more) => #{page.name}]]\n\n</div>\n" 
+	end
+	
+	def render_link_to( page )
+		"* #{page.name} #{ @settings[:include_metadata] ? render_meta_data( page ) : "" }\n"
+	end
+	
+	def render_meta_data( page )
+		"revised on #{page.revised_on.strftime('%Y %b %d %H:%M')} by #{page.author}"
+	end
+	
+	def setup_list
+		@pages_in_summary = FiniteUniqueList.new( @settings[:max_pages_to_show], 
+																@settings[:reverse_sort], 
+																@settings[:sort_pages_by] )
 	end
+	
+	def start_watching_wiki( wiki )
+		wiki.watch_for( @settings[:only_new_pages] ? :page_created : :page_revised ) { |event, page, revision| check_whether_to_add_page( page, revision ) }
+		wiki.watch_for( :page_deleted ) { |event, page, revision| check_whether_to_remove_page( page, revision ) } if @settings[:remove_deleted_pages]
+	end
+	
 end 
 
+class AutomaticRecentChanges
+	
+	def initialize( wiki, changes = 200, pagename = "Recent Changes to This Site", author = "AutomaticRecentChanges" )
+			AutomaticSummary.new( wiki, { :pagename => pagename,
+													:author => author,
+													:only_new_pages => false,
+													:sort_pages_by => :revised_on,
+													:include_metadata => true,
+													:summarise_revisions => true,
+													:reverse_sort => true,
+													:remove_deleted_pages => false,
+													} )		
+	end
+end
+
+class AutomaticOnePageIndex
+	
+	def initialize( wiki, pagename = "Site Index", author = "AutomaticIndex"  )
+		AutomaticSummary.new( wiki, { 	:pagename => pagename,
+													:author => author,
+													:only_new_pages => true,
+													:sort_pages_by => :name_for_index,
+													} )
+	end	
+	
+end
+
+class AutomaticMultiPageIndex
+	
+	def initialize( wiki, pageroot = "Site Index", author = "AutomaticIndex"  )
+		content = "h1. #{pageroot}\n\n"
+		('A'..'Z').each do |letter|
+			AutomaticSummary.new( wiki, {  	:regexp_for_title => /^#{letter}.*/i,
+														:pagename => "#{pageroot} #{letter}",
+														:author => author,
+														:only_new_pages => true,
+														:sort_pages_by => :name_for_index,
+														} )
+			content << "* #{pageroot} #{letter}\n"
+		end
+		AutomaticSummary.new( wiki, {  	:regexp_for_title => /^[^A-Za-z].*/,
+													:pagename => "#{pageroot} Other",
+													:author => author,
+													:only_new_pages => true,
+													:sort_pages_by => :name_for_index,
+													} )
+	 	content << "* #{pageroot} Other\n"
+		wiki.revise( pageroot, content, author )
+	end	
+	
+end
+
 class AutomaticCalendar
 	
 	attr_reader :month_pagename, :day_pagename
@@ -240,12 +231,13 @@ class AutomaticCalendar
 		1.upto( 31 ) do |day_no|
 			day = time_for( month, day_no )
 			break if day.month > month
-			content << "| [[ #{day_no} : #{day_pagename( day )} ]] "
+			content << "| [[ #{day_no} => #{day_pagename( day )} ]] "
 			content << "|\n" if day.wday == 6
 		end
 		day.wday.upto( 5 ) { content << "| . " }
 		content << "|\n"
-		content << "\n\n< #{month_pagename( month-1 )}  #{month_pagename( month+1 )} >\n"		
+		content << "\n\n< #{month_pagename( month-1 )}  #{month_pagename( month+1 )} >\n"	
+		content << "</div>"	
 	end
 	
 	def time_for( month, day = 1 )
@@ -290,10 +282,10 @@ class AutomaticUpcomingEvents
 		content = "<div class='upcomingevents'>\n"
 		Time.now.day.upto( Time.now.day+7 ) do |day|
 			time =  @calendar.time_for( Time.now.month, day )
-			content << "| [[ #{relative_day( time ) } : #{@calendar.day_pagename( time )} ]] |"
+			content << "| [[ #{relative_day( time ) } => #{@calendar.day_pagename( time )} ]] |"
 			content << (@wiki.exists?( @calendar.day_pagename(time) ) ? render_event( @calendar.day_pagename( time ) ) : "&nbsp; |\n")	
 		end
-		content << "\n\np(more). [[(more) : #{@calendar.month_pagename}]]\n\n"
+		content << "\n\np(more). [[(more) => #{@calendar.month_pagename}]]\n\n"
 		content << "</div>\n"
 		@wiki.revise( "Upcoming Events", content , "AutomaticCalendar" ) 
 	end
@@ -313,9 +305,67 @@ class AutomaticUpcomingEvents
 		page = @wiki.page( name )
 		headings = page.textile.select { |line| line =~ /^h\d\./ }
 		headings = headings.map { |heading| heading.to_s[4..-1].strip }
-		headings = [ page.textile[/.*?\n/] ] if headings.empty?
-		content = "[[ #{headings.shift} : #{page.name} ]] |\n"
-		headings.each { |heading| content << "| &nbsp; | [[ #{heading} : #{page.name} ]] |\n" }
+		headings = [ page.textile.first_lines(1) ] if headings.empty?
+		content = " [[ #{headings.shift} => #{page.name} ]] |\n"
+		headings.each { |heading| content << "| &nbsp; | [[ #{heading} => #{page.name} ]] |\n" }
 		content
 	end
 end
+
+class AutomaticAuthorIndex
+
+	def initialize( wiki, create_author_pages = true, author_include_regexp = /.*/, author_exclude_regexp = /^Automatic.*/, pagename = "authors", author = "AutomaticAuthorIndexer", author_page_tail = "s pages" )
+		@wiki, @create_author_pages, @author_include_regexp, @author_exclude_regexp, @pagename, @author, @author_page_tail = wiki, create_author_pages, author_include_regexp, author_exclude_regexp, pagename, author, author_page_tail
+		@authors = []
+		find_all_authors( wiki )
+		@wiki.watch_for( :page_revised ) { |event, page, revision| 
+			$stderr.puts "Got a page revised message in AutomaticAuthorIndex"
+			add_author( revision ) }
+	end
+	
+	def add_author( revision )
+		return if @authors.include? revision.author
+		return unless revision.author =~ @author_include_regexp
+		return unless revision.author !~ @author_exclude_regexp
+		@authors << revision.author
+		@authors.sort!
+		create_author_page_for(revision.author) if @create_author_pages
+		render_author_index
+	end
+	
+	def find_all_authors( wiki )
+		wiki.each do |name, page|
+			page.revisions.each do |revision|
+				add_author( revision )
+			end
+		end
+	end
+	
+	def render_author_index
+		content = "h1. Index of Authors\n\n"
+		@authors.each do |author|
+			content << "* #{author}"
+			if @create_author_pages
+				content << " #{author}#{@author_page_tail}"
+			end
+			content << "\n"
+		end
+		@wiki.revise( @pagename, content, @author )
+	end
+	
+	
+	def create_author_page_for( author ) 
+		AutomaticSummary.new( @wiki, {   :pagename => "#{author}#{@author_page_tail}" ,
+										:regexp_for_author => /#{author}/,
+										:author => @author,
+										:only_new_pages => false,
+										:sort_pages_by => :revised_on,
+										:include_metadata => true,
+										:summarise_revisions => true,
+										:reverse_sort => true,
+										:remove_deleted_pages => false,
+									 } )		
+		end
+
+end
+