Soks 0.0.7 → 1.0.0

data/lib/soks-view.rb

@@ -1,17 +1,54 @@
+# Extend the model classes to provide view functions
+class Page
+	def textile( view = nil )
+		return "[[#{$MESSAGES[:Create]} #{name} => /edit/#{name} ]]" if empty? 
+		content 
+	end
+end
+
+class ImagePage
+  def textile( view )
+  	return "[[#{$MESSAGES[:Create]} #{name} => /edit/#{name} ]]" if empty?
+  	return content if deleted?
+  	"!#{view.file2(content)}!:#{view.url(name)}" 	
+  end
+end
+
+class AttachmentPage 
+  def textile( view )
+  	return "[[#{$MESSAGES[:Create]} #{name} => /edit/#{name} ]]" if empty?
+  	return content if deleted? 
+  	%Q{[[ #{name} => #{view.file2(content)} ]]\n} 	
+  end
+end
+
 # This module is used to extend each erb page to provide helper methods
 module ErbHelper
 	
-	def url( name, view = 'view' )
-		"#{$SETTINGS[:url]}/#{view}/#{name}"
+	attr_accessor :name
+	attr_accessor :description
+	attr_accessor :author_to_email_conversion
+	
+	def url( name, view = 'view', query = '' )
+		"#{root_url}/#{view}/#{url_name_for_page_name(name)}#{query}"
 	end
 	
 	def file( name )
-		"#{$SETTINGS[:url]}/attachment/#{name}"
+		"#{root_url}/attachment/#{name}"
+	end
+	
+	# Will refactor this out eventually and merge with above
+	def file2( name )
+		name = name[1..-1] if name[0,1] == '/'
+		"#{root_url}/#{name.strip}"
 	end
 end
 
 # This class records all the links between pages
 class Links
+	
+	attr_reader :links
+	
 	def initialize
 		@links = Hash.new
 	end
@@ -48,7 +85,7 @@ end
 class BruteMatch
 	
 	IGNORE_CASE = true
-	
+
 	def initialize
 		@matches = Hash.new
 		@titles = Array.new #sorted array for speed 
@@ -70,18 +107,19 @@ class BruteMatch
 	end
 	
 	def match( text )
-		@titles.each do |title|
-			regexp = /\b#{Regexp.escape(title)}\b/i
-			page = @matches[ title ]
-			text.gsub!( regexp ) { |match| yield match, page }
+		@titles.each do |title,regexp,page|
+			text.gsub!( regexp ) { |match| "#{$1}#{yield $2, page}#{$3}" }
 		end
 		text
 	end
 	
 	private
 	
+	# The title, a regexp to match for the title, and the page are stored in a sorted array
 	def update_titles
-		@titles = @matches.keys.sort_by { |title| title.length }.reverse
+		@titles = @matches.keys.sort_by { |title| title.length }.reverse.map do |title|
+			[ title, /(^|\W)(#{Regexp.escape( title )})(\W|$)/i, @matches[ title ] ]
+		end
 	end
 	
 	def lower_case( text )
@@ -98,17 +136,17 @@ end
 # * Automatically links things that look like email addresses and urls
 class WikiRedCloth < RedCloth
 	
-	RULES = [:refs_soks_bracketed_link, :textile, :markdown, :inline_soks ]
+	RULES = [:refs_soks_bracketed_link, :refs_textile, :block_textile_table, :block_textile_lists,:block_textile_prefix, :inline_textile_image, :inline_textile_link, :inline_textile_code, :inline_soks, :inline_textile_glyphs, :inline_textile_span, :refs_markdown, :block_markdown_setext, :block_markdown_atx, :block_markdown_rule, :block_markdown_bq, :block_markdown_lists, :inline_markdown_reflink, :inline_markdown_link ]
 	
-	def initialize( wiki, page, string )
-		@wiki, @page = wiki, page
+	def initialize( wiki, page, string, hard_breaks = false )
+		@wiki, @view, @page = wiki, wiki, page
 		@internal_links_from_page = []
-		super(insert_sub_strings( string.dup ), [ :no_span_caps])
-		self.hard_breaks = true if $SETTINGS[:redcloth_hard_breaks]
+		super(insert_sub_strings( string.dup ),[:no_span_caps])
+		self.hard_breaks = hard_breaks
 	end
 	
 	def to_html
-		super( *RULES )
+		super( *RULES ).to_s
 	end
 		
 	def inline_soks( text )
@@ -149,16 +187,14 @@ class WikiRedCloth < RedCloth
 
 	def insert_sub_strings( text, count = 0 )
 	  return text if count > 5 # Stops us getting locked into a cycle if people mess up the insert
-	  text.gsub!(/\[\[\s*(insert (.+?))\s*\]\]/i) do |m|
-		unless @wiki.exists? $1 # So we don't accidentlaly match a page whose name starts 'insert'
-	  		inserted_page = @wiki.page( $2 )
-		  	if @wiki.exists? inserted_page.name
-				@internal_links_from_page << inserted_page
-			  	inserted_page.is_inserted_into( @page )
-			end
-			insert_sub_strings( "#{inserted_page.textile}\n", count + 1 )
+	  text.gsub!(/\[\[\s*(insert (.+?))\s*\]\]/i) do |match|
+		if @wiki.exists? $1 # So we don't accidentlaly match a page whose name starts 'insert'
+	  		match
 		else
-			m
+			inserted_page = @wiki.page( $2 )	
+			@internal_links_from_page << inserted_page if @wiki.exists? inserted_page.name
+		  	inserted_page.is_inserted_into( @page )
+			insert_sub_strings( "#{inserted_page.textile(@view)}\n", count + 1 )
 		end 
 	  end
 	  text
@@ -176,107 +212,140 @@ class WikiRedCloth < RedCloth
      		title, pagename = $1, $3
 			pagename ||= title
 			case pagename
+			
+			# http://soks.rubyforge.org/index
+			when /^http(s)?:\/\//i 					; link(pagename,title)
+			
+			# www.soks.org
 			when /^www\./i 							; link("http://#{pagename}", title )
-			when /[A-Za-z0-9.]+?@[A-Za-z0-9.]+/ ; link("mailto:#{pagename}",title)
-			when /^http:\/\//i 						; link(pagename,title)
-			else											; wiki_link( pagename, title )
+			
+			# tamc@soks.org
+			when /[A-Za-z0-9.]+?@[A-Za-z0-9.]+/ 	; link("mailto:#{pagename}",title)
+			
+			# /revision/Home page?revision=10
+			when %r{^/(\w+)/(.+?)(\?\w+=\w+)$} 
+				@internal_links_from_page << @wiki.page($2) if @wiki.exists?($2)
+				link( @view.url($2,$1,$3), title, @wiki.exists?($2) ? '':'missing' )
+			
+			# /edit/a new page	
+			when %r{^/(\w+)/(.+)} 
+				@internal_links_from_page << @wiki.page($2) if @wiki.exists?($2)
+				link( @view.url($2,$1), title, @wiki.exists?($2) ? '':'missing' )
+			
+			# the name of a page
+			else 
+				@internal_links_from_page << @wiki.page(pagename) if @wiki.exists? pagename
+				link( @view.url( pagename ), title, @wiki.exists?(pagename) ? '':'missing' )
 			end
 		end
 	end
        
-  	def inline_soks_automatic_link( text )	
-		@wiki.rollingmatch.match( text ) { |title, page| wiki_link( page.name, title, 'automatic' ) }
-	end
-	
-	def wiki_link( pagename, title, css_class = nil )
-		if @wiki.exists? pagename
-			@internal_links_from_page << @wiki.page( pagename )
-			css_class ||= ''
+  	def inline_soks_automatic_link( text )
+		@wiki.rollingmatch.match( text ) do |title, page|
+			@internal_links_from_page << page
+			link( @view.url(page.name), title, 'automatic' )
 		end
-		link( url_for(pagename), title, css_class || 'missing')
 	end
 	
 	def link( url, title = url, css_class = '' )
 		shelve "<a href='#{url}' class='#{css_class}'>#{title}</a>"
 	end
 	
-	def url_for( pagename, view = 'view' )
-		view, pagename = $1, $2 if pagename =~ /\/(\w+)\/(.*)/
-		"#{$SETTINGS[:url]}/#{view}/#{pagename}"
+end
+
+module PageNameToUrlNameConversion
+	
+	def setup_page_name_to_url_name_conversion
+		@urls_to_pages, @pages_to_urls = {}, {}
+		@wiki.each { |name,page| url_name_for_page_name( page.name ) }
+		@wiki.watch_attentively_for(:page_created) {|event,page,revision| url_name_for_page_name( page.name )}
+		@wiki.watch_attentively_for(:page_title_recapitalized) {|event,page| change_caps_for( page.name )}
+	end
+	
+	# To allow punctuation in page titles and not mess up urls
+	def url_name_for_page_name( page_name )
+		@pages_to_urls[ page_name.downcase ] || add_url_name_for_page_name( page_name )
 	end
 	
+	def page_name_for_url_name( url_name )
+		@urls_to_pages[ url_name.downcase ] || url_name 
+	end
+	
+	def add_url_name_for_page_name( page_name )
+		url_name = create_url_name( page_name )
+		@pages_to_urls[ page_name.downcase ] = url_name
+		@urls_to_pages[ url_name.downcase ] = page_name
+		url_name 
+	end
+	
+	def change_caps_for( page_name )
+		url_name = @pages_to_urls[ page_name.downcase ].downcase
+		@urls_to_pages[ url_name  ] = page_name
+	end
+	
+	# Turns text into a WikiWord by changing the capitalization and then dumping the punctuation
+	def create_url_name( page_name )
+		url_name = page_name.capitalize.gsub(/(\W+(\w))/) { |m| $1.upcase }.gsub(/\W+/,'')
+		url_name = "PunctuationOnlyInTitle" if url_name == ""
+		url_name = increment_url_name( url_name ) while @urls_to_pages.has_key? url_name.downcase
+		url_name
+	end
+	
+	def increment_url_name( url_name )
+		if url_name =~ /(\w+)-(\d+)/
+			"#{$1}-#{$2.to_i.succ}"
+		else
+			url_name+"-2"
+		end 
+	end
 end
 
 class View
-
 	include ErbHelper
+	include PageNameToUrlNameConversion
 
-	attr_reader :rollingmatch, :links
+	REDCLOTH_CACHE_NAME = 'redcloth'
 
-	def initialize( wiki, name )
-		@wikiname = name
-		@rollingmatch, @links, @redcloth_cache, @erb_cache = BruteMatch.new, Links.new, Hash.new, Hash.new
-		@wiki = wiki
+	attr_reader :rollingmatch, :links
+	attr_accessor :view_folder
+	attr_accessor :root_url
+	attr_accessor :reload_erb_each_request
+	attr_accessor :dont_frame_views
+	attr_accessor :redcloth_hard_breaks
+	
+	def initialize( wiki, root_url, view_folder )
+		@wiki, @root_url, @view_folder = wiki, root_url, view_folder
+		@rollingmatch, @links = BruteMatch.new, Links.new
+		@redcloth_cache = wiki.load_cache(REDCLOTH_CACHE_NAME) || Hash.new
+		@erb_cache = Hash.new
+		@reload_erb_each_request = false
+		@dont_frame_views = []
+		@redcloth_hard_breaks = false
+		setup_page_name_to_url_name_conversion
 		wiki.watch_attentively_for( :page_revised ) { |event,page,revision| refresh_redcloth( page ) }
+		wiki.watch_for(:shutdown) { wiki.save_cache(REDCLOTH_CACHE_NAME,@redcloth_cache) }
 	end
 
-	def view( pagename, view = 'view', person = nil )
-		page = @wiki.page pagename
+	def render( pagename, view = 'view', person = 'Anon.', query = {} )
+		page = @wiki.page( pagename )
 	   	renderedview = redcloth( page )
 		content_of_page = html( page.class, view, binding )
+		@wiki.notify(:page_viewed, page, view, person)
 		if should_frame? view 
-			frame_erb.result binding
+			return frame_erb.result(binding)
 		else
-			content_of_page
+			return content_of_page
 		end
 	end
-	
-	def find( pagename )
-		return view( pagename ) if @wiki.exists?( pagename )
-		view = 'find'
-		search_term = /#{pagename}/i
-		title_results = @wiki.select { |name,page| name=~ search_term }
-		text_results = @wiki.select { |name,page| page.content=~ search_term }
-		content_of_page = html( Page, 'search_results', binding )
-		page = nil
-		frame_erb.result binding	
-	end
-		
-	def revise( pagename, content, person, newpagename = pagename )
-		if @wiki.exists?( pagename ) && (newpagename != pagename)
-			@wiki.revise( pagename, "#{$MESSAGES[:content_moved_to]} [[#{newpagename}]]", person )
-			@wiki.revise( newpagename, "#{$MESSAGES[:content_moved_from]} [[#{pagename}]]", 'AutomaticPageMover' )
-			@wiki.revise( newpagename, content, person )
-		else
-			@wiki.revise( newpagename, content, person )
-		end		
-	end
-	
-	def move( oldpagename, person, newpagename )
-		unless newpagename == oldpagename
-			@wiki.revise( newpagename, "#{$MESSAGES[:content_moved_from]} [[#{oldpagename}]]", 'AutomaticPageMover')
-			@wiki.revise( newpagename, @wiki.page( oldpagename ).content, person)
-			@wiki.revise( oldpagename, "#{$MESSAGES[:content_moved_to]} [[#{newpagename}]]", person)
-		end
-	end
-	
-	def rollback( pagename, revision, person )
-		@wiki.rollback( pagename, revision, person )
-	end
-	
-	def delete( pagename, person )
-		@wiki.revise( pagename, $MESSAGES[:page_deleted], person )
-	end
 		
 	def refresh_redcloth( page )
 		$LOG.info "Refreshing #{page}"
-		@redcloth_cache[page] = "" if page.textile.strip == ""
-		@redcloth_cache[ page ] = WikiRedCloth.new( self, page, page.textile ).to_html
+		@redcloth_cache[ page.name ] = WikiRedCloth.new( self, page, page.textile(self), redcloth_hard_breaks).to_html
 	end
 	
 	def redcloth( page )
-		@redcloth_cache[page] = "" if page.textile.strip == ""
-		@redcloth_cache[ page ] ||= WikiRedCloth.new( self, page, page.textile ).to_html
+		textile = page.textile(self)
+		@redcloth_cache[ page.name ] || refresh_redcloth( page )
 	end
 	
 	def clear_redcloth_cache( page = :all_pages )
@@ -284,7 +353,7 @@ class View
 	end
 	
 	def html( klass, view, _binding )
-		@erb_cache.clear if $SETTINGS[:reload_erb_each_request]
+		@erb_cache.clear if reload_erb_each_request
 		( @erb_cache[ path_for( klass, view ) ] ||= ERB.new( IO.readlines( erb_filename( klass, view ) ).join ) ).result( _binding )
 	end
   
@@ -294,37 +363,34 @@ class View
 		 	if klass.superclass
 		   		klass = klass.superclass
 		   	else
-				 raise WEBrick::HTTPStatus::NotFound
+				$LOG.warn "Not found #{path_for( klass, view)}"
+				raise WEBrick::HTTPStatus::NotFound
 		   	end
 	    end
 	    path_for( klass, view )
 	end
 
-  	def path_for( klass, view ) "#{$SETTINGS[:root_directory]}/views/#{klass}_#{view}.rhtml" end
+  	def path_for( klass, view ) "#{view_folder}/#{klass}_#{view.downcase}.rhtml" end
 	
 	def should_frame?( view )
-		return true unless $SETTINGS[:dont_frame_templates].include? view.downcase
+		not( dont_frame_views.include? view.downcase )
 	end
 	
 	def frame_erb
-		@frame_erb = nil if $SETTINGS[:reload_erb_each_request]
+		@frame_erb = nil if reload_erb_each_request
 		@frame_erb ||= load_frame_erb
 	end
 	
 	def load_frame_erb
-		if File.exists? "#{$SETTINGS[:root_directory]}/views/frame.rhtml"
-			ERB.new( IO.readlines( "#{$SETTINGS[:root_directory]}/views/frame.rhtml" ).join )
+		if File.exists? "#{view_folder}/frame.rhtml"
+			ERB.new( IO.readlines( "#{view_folder}/frame.rhtml" ).join )
 		else
 			ERB.new( "<%= content_of_page %>" )
 		end
 	end
 	
-	# CGI and FCGI can't access this global directly, so call through here
-	def settings
-		$SETTINGS
-	end
-	
-	def method_missing( method, *args, &block ) 
+	def method_missing( method, *args, &block )
+		# $LOG.debug "View method missing called for #{method} with #{args.inspect}" 
 		@wiki.send( method, *args, &block ) 
   	end
 end

data/lib/soks.rb

@@ -9,35 +9,17 @@ require 'diff/lcs/array'
 require 'fileutils'
 require 'thread'
 require 'yaml'
+require 'logger'
 
 require 'soks-utils'
 require 'soks-storage'
 require 'soks-model'
 require 'soks-view'
 require 'soks-servlet'
+
 require 'helpers/default-helpers'
+require 'helpers/maintenance-helpers'
+require 'helpers/counter-helpers'
 
 Thread.abort_on_exception = true
-Socket.do_not_reverse_lookup = true
-
-# These are the default settings.  Can be overriden in the call to soks-servlet.rb#start_wiki
-$SETTINGS = {
-	:name => 'A Soks Wiki',
-	:description => 'A Soks Wiki',
-	:root_directory => 'soks-wiki',
-	:check_files_every => 60, # Seconds
-	:url => 'http://localhost:8000',
-	:port => 8000,
-	:home_page => 'Home Page',
-	:dont_frame_templates => ['print','rss'],
-	:force_no_cache => false, # Adds headers to restrict the cacheing of pages
-	:redcloth_hard_breaks => false, # Set Redcloth to use hard breaks
-	:reload_erb_each_request => false, # False faster for production, true speeds development cycle
-	:server_type =>  WEBrick::SimpleServer, # Could be WEBrick::Daemon if you wish to fork
-	:authenticators => [ [ %r{/(view|rss|print|find|meta|attachment)/.*}, WEBrick::HTTPAuth::NoAuthenticationRequired.new ],
-								# [ %r{/upload/.*}, WEBrick::HTTPAuth::NotPermitted.new ],
-								# [ %r{/(edit|save)/home page}, WEBrick::HTTPAuth::SiteWidePassword.new('password','You need to enter the site wide password to edit the home page') ],
-								# [ %r{/(view|edit|save)/private.*},WEBrick::HTTPAuth::BasicAuth.new( :UserDB => htpasswd, :Realm => realm ) ], # See webrick documentation
-								[ %r{.*}, WEBrick::HTTPAuth::AskForUserName.new( 'No password, just enter a name') ]
-							 ]
-}
+Socket.do_not_reverse_lookup = true

data/templates/default/attachment/newpage.js

@@ -3,7 +3,7 @@ function trim(str)
 	return str.replace(/^\s+/,'').replace(/\s+$/,'');
 }
 
-function editSelected()
+function editSelected(web_root)
 {
 	if (window.getSelection)
 	{
@@ -21,11 +21,11 @@ function editSelected()
 	void(txt=prompt('Please enter the title of the page you wish to create',''))
 	}
 	if(txt){
-		window.location = '/edit/'+escape(trim(txt))
+		window.location = web_root+escape(txt)
 	}
 }
 
-function hotkey( event )
+function hotkey( event, web_root )
 {
  	event = (event) ? event : ((window.event) ? event : null);
 	if (event)
@@ -34,17 +34,8 @@ function hotkey( event )
 	{
 		var charCode = (event.charCode) ? event.charCode : ((event.which) ? event.which : event.keyCode);
 		if (charCode == 14 ) { 
-			editSelected();
+			editSelected(web_root);
 		}
 	}
 	}
-}
-
-function validateTitle( proposed_title ) 
-{
-	var illegalcharacters = /[\\\[\]\?<>&\^\/]/;
-	if (illegalcharacters.test( proposed_title ) == true ) 
-	{
-		alert( 'Unfortunately the characters \ / [ ] ? < > & ^ in titles cause problems with Soks. Please try not to use them.');
-	}
 }