Soks 0.0.7 → 1.0.0

data/templates/default/content/Soks%20Licence.textile

@@ -62,3 +62,5 @@ GPL (see the file GPL), or the conditions below:
      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
      PURPOSE.
 </pre>
+
+Tag: Include this page in the distribution

data/templates/default/content/Tag%3A%20Include%20this%20page%20in%20the%20distribution.textile

@@ -0,0 +1,6 @@
+h1. Tag: Include this page in the distribution
+
+Pages with this text on are downloaded from http://www.soks.org and packaged up in the soks distribution.
+
+
+[[insert pages to include in the distribution]]

data/templates/default/start.rb

@@ -1,20 +1,16 @@
 #!/usr/local/bin/ruby
 
 # This file was created automatically on <%= Time.now %>
-# Uncomment different sections to enable features of this wiki.
-
-#Get a logger going
 require 'logger'
-$LOG = Logger.new(STDOUT) # For development
-$LOG.level = Logger::DEBUG # For development
-# $LOG = Logger.new('soks.log', 10, 1024000) # For production
-# $LOG.level = Logger::WARN # For production
+
+$LOG = Logger.new(STDOUT)
+$LOG.level = Logger::DEBUG
 $LOG.datetime_format = "%Y-%m-%d %H:%M:%S"
 
 #Add the required libraries to the search path
 begin
 	require 'rubygems'
-	require_gem 'Soks', '= <%= settings[:version] %>'
+	require_gem 'Soks', '~> <%= settings[:version] %>'
 	$LOG.info 'Loaded Soks <%= settings[:version] %> from gem'
 rescue LoadError
 	$LOG.info "Soks Gem version <%= settings[:version] %> could not be found"
@@ -23,122 +19,70 @@ rescue LoadError
 	$LOG.info 'Loaded Soks libraries from <%= settings[:soks_libraries].join('","') %>'
 end
 
-module StartSoks
-
-	# EDIT THIS TO CHANGE THE AUTHENTICATION	
-=begin
-	# If you uncomment this, don't forget to uncomment the authenticators line in the CUSTOMSETTINGS hash below!
-	# You can choose what level of authentication to apply based on regular expressions matched
-	# against the page title.  These regexps are tried in order.Defaults are here:
-	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') ]						
-							] 
-=end
-
-	# EDIT THIS TO CHANGE THE BASIC SETTINGS, DEFAULTS ARE IN /LIB/SOKS.rb
-	CUSTOMSETTINGS = {
-		:root_directory => File.expand_path( File.dirname( __FILE__) ), 
-		# :name => 'test',
-		# :description => 'A Soks Wiki',
-		# :server_type =>  WEBrick::Daemon, # Uncomment if you wish to fork, only works on some OSs
-		# :home_page => 'Home Page',  
-		:url => '<%= settings[:url] %>',
-		:port => <%= settings[:port] %>,
-	    # :authenticators => authenticators
-	}
-	
-	def self.start
+root_directory = File.expand_path( File.dirname( __FILE__) )
+$MESSAGES = YAML.load( IO.readlines("#{root_directory}/views/messages.yaml").join )
+banned_titles = IO.readlines("#{root_directory}/banned_titles.txt").map { |title| title.strip }
+
+server = WEBrick::HTTPServer.new(:Port => <%= settings[:port] %> )
+
+wiki = Wiki.new( "#{root_directory}/content", "#{root_directory}/caches" )
+wiki.check_files_every = :min
+
+view = View.new( wiki, "<%= settings[:url] %>", "#{root_directory}/views" )
+view.name = 'A Soks Wiki'
+view.description = 'A Soks Wiki for you!'
+view.reload_erb_each_request = false
+view.dont_frame_views = ['print','rss','listrss','linksfromrss']
+view.redcloth_hard_breaks = false
+view.author_to_email_conversion = '@address-not-known.com'
+
+servlet = ServletSettings.new( wiki, view )
+servlet.home_page = 'Home Page'
+servlet.content_types = { 'Rss' => 'application/xml', 'Listrss' => 'application/xml', 'Linksfromrss' => 'application/xml' }
+servlet.force_no_cache = false
+
+servlet.authenticators << [ /\/(edit|save|upload|delete|rollback)\//i, WEBrick::HTTPAuth::AskForUserName.new( 'No password, just enter a name') ]
+servlet.authenticators << [ /.*/, WEBrick::HTTPAuth::NoAuthenticationRequired.new ]
+
+servlet.static_file_directories[ 'Attachment' ] = "#{root_directory}/attachment"
+servlet.upload_directory = 'Attachment' # Must be one of the static file directories
+
+wiki.watch_for(:start) do |event,wiki,view|
+	MergeOldRevisionsHelper.new( wiki, :day, 2, 60*60*24)
 	
-		# EDIT THIS TO CHANGE THE HELPERS (Index, Recent changes etc)
-		start_wiki( CUSTOMSETTINGS ) do |wiki, view|
-
-			# Examples of automatically generated summary pages:
-			AutomaticSummary.new( wiki, 
-				:regexp_for_title => /^How to /i,
-				:pagename => 'Instructions and Howtos'
-				)
-			
-			AutomaticSummary.new( wiki, 
-				:regexp_for_title => /^Bug:/i,
-				:regexp_to_exclude_title => /^Bug: Type a title here/i,
-				:pagename => 'Known bugs',
-				:include_metadata => true 
-				)
-			
-			AutomaticSummary.new( wiki, 
-				:regexp_for_title => /^News:/i,
-				:max_pages_to_show => 1,
-				:lines_to_include => 10,
-				:reverse_sort => true, 
-				:pagename => 'Latest News'
-				)
-			
-			AutomaticSummary.new( wiki, 
-				:regexp_for_title => /^News:/i,
-				:lines_to_include => 10, 
-				:reverse_sort => true,
-				:pagename => 'All News'
-				)
-			
-			 #  Possible settings for the Automatic Summary	(with defaults)
-		 	 #  :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, # nil puts a link, can pass a block instead to render
-			 #  :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
-			
-			# These are beta and off by default...
-=begin
-			require 'helpers/rss2wiki-helper'
-			RSS2WikiHelper.new( wiki, :url => 'http://rubyforge.org/export/rss_sfnews.php' )	
-			
-			require 'helpers/mail2wiki-helper'
-			Mail2WikiHelper.new( wiki, :server => 'imap.hermes.cam.ac.uk', 
-					:username => 'tamc2', 
-					:password => 'PASSWORD',	
-					:mailbox => 'mcr notices',
-					:check_period => 600, # Seconds
-					:subject_regexp => /.*/ )
-					
-			require 'helpers/wiki2html'
-			Wiki2Html.new( wiki, view, 	:views_to_copy => ['view','meta','rss'],
-										:extension => '.html',
-										:destination_dir => '/Users/tamc2/Sites',
-										:destination_url => 'http://localhost/~tamc2')
-=end
-			
-			# Putting these towards the end speeds things up.
-			AutomaticRecentChanges.new( wiki )
-			
-			AutomaticOnePageIndex.new( wiki ) # Index on one page, best for small wikis
-			# AutomaticMultiPageIndex.new( wiki ) # One page per letter index, best for large wikis
-			
-			# calendar = AutomaticCalendar.new( wiki ) # Adds a series of calendar pages to the wiki
-			# AutomaticUpcomingEvents.new( wiki, calendar ) # Creates a page with the next weeks events drawn from the calendar pages
-			
-			# This is an array of titles that will NOT be automatically linked.
-			# Default is the 30 most common words in the english language
-			# Note that pages can still be created with these titles, and they can still be manually linked to.
-			banned_titles = IO.readlines("#{CUSTOMSETTINGS[:root_directory]}/banned_titles.txt").map { |title| title.strip }
-			
-			# This takes a while, so do it last. Note that the banned_titles argument is optional.
-			AutomaticUpdateCrossLinks.new( wiki, view, banned_titles ) 
-		end
+	AutomaticDetailedList.new( wiki, 'Known bugs' ) do |page|
+		page.name =~ /^Bug:/i && page.name !~ /^Bug: Type a title here/i
 	end
+	
+	AutomaticList.new( wiki, 'Instructions and Howtos' ) { |page| page.name =~ /^How to /i }
+	AutomaticSummary.new( wiki, 'Latest News', :max_pages_to_show => 1, :reverse_sort => true) { |page| page.name =~ /^News:/i }
+	AutomaticSummary.new( wiki, 'All News', :reverse_sort => true) { |page| page.name =~ /^News:/i }					
 
-end
+	#ViewCountHelper.new( wiki ) # Counts which are the most popular pages
+	#ViewerCountHelper.new( wiki ) # Counts who visits the wiki most
+	#AuthorCountHelper.new(wiki) # Counts who makes the most revisions
+	
+	AutomaticRecentChanges.new( wiki )
 
-if $0 == __FILE__ then
-	StartSoks::start
-end
+	AutomaticOnePageIndex.new( wiki ) # Index on one page, best for small wikis
+	# AutomaticMultiPageIndex.new( wiki ) # One page per letter index, best for large wikis
+	
+	#calendar = AutomaticCalendar.new( wiki ) # Adds a series of calendar pages to the wiki
+	#AutomaticUpcomingEvents.new( wiki, calendar ) # Creates a page with the next weeks events drawn from the calendar pages
+
+	AutomaticUpdateCrossLinks.new( wiki, view, banned_titles )
+end 
+
+
+server.mount("/", WikiServlet, servlet  )
+
+trap("INT") { 
+	$LOG.warn "Trying to shutdown gracefully"
+	server.shutdown 
+	wiki.shutdown
+	$LOG.info "Shutdown."
+}
+
+$LOG.warn "Starting server"
+wiki.notify(:start,wiki,view)
+server.start

data/templates/default/version.txt

@@ -1 +1 @@
-0.0.7
+1.0.0

data/templates/default/views/Page_edit.rhtml

@@ -1,5 +1,5 @@
 <span class='pagename'>
-	<a href='<%= url pagename, "meta" %>'><%= pagename %></a> 
+	<a href='<%= url page.name, "meta" %>'><%= page.name %></a> 
 	<%= page.deleted? ? "(Deleted)" : '' %>
 </span>
 
@@ -22,14 +22,14 @@
 	</ul>
 </div>
 	
-<form class='editpage' method='post' action='<%= url pagename, "save" %>' >
+<form class='editpage' method='post' action='<%= url page.name, "save" %>' >
 	<fieldset>
 	
 	<div id='edittitle'>
 		Title: 
 		<input 	name='newtitle' 
 					size = '60' 
-					value='<%= pagename %>' 
+					value='<%= page.name %>' 
 					onblur="validateTitle( this.value );" 
 					onClick="this.value=this.value.replace('Type a title here' ,'')"
 		/>
@@ -46,10 +46,10 @@
 	
 	Hello <a href='<%= url person %>'><%= person %></a> (Quit browser to log out). Would you like to 
 	<input name='action' value='Save Changes' type='submit' accesskey="S" /></form>,  
-	<form class='editpage' method='post' action='<%= url pagename %>' >
+	<form class='editpage' method='post' action='<%= url page.name %>' >
 		<input name='action' value='Cancel Changes' type=submit accesskey="C" />
 	</form> or
-	<form class='editpage' method='post' action='<%= url pagename, 'delete' %>' >
+	<form class='editpage' method='post' action='<%= url page.name, 'delete' %>' >
 		<input name='action' value='Delete this Page' type='submit' accesskey="D" />
 	</form>?
 
@@ -71,9 +71,9 @@
 			%>
 	</div>
 	<p>
-		<form class='editpage' method=post action='<%= url pagename, "rollback" %>' >
+		<form class='editpage' method=post action='<%= url page.name, "rollback" %>' >
 			<input name='revision' value='<%= page.number-1  %>' type='hidden' />
 			<input name='action' value='Undo this change' type='submit' accesskey="U" />
-		</form> or <a href='<%= url pagename, "revisions" %>' accesskey="A" >Show <b>A</b>ll changes</a>.
+		</form> or <a href='<%= url page.name, "revisions" %>' accesskey="A" >Show <b>A</b>ll changes</a>.
 	</p>
 <% end %>

data/templates/default/views/{Page_search_results.rhtml → Page_find.rhtml}

@@ -1,6 +1,12 @@
-<span class='pagename'><%= pagename %></span>
+<span class='pagename'>Search Results</span>
 
-<h1>Results of Search for &#8220;<%= pagename %>&#8221;</h1>
+<%
+search_regexp = /#{query['regex'].strip}/i
+title_results = @wiki.select { |name,apage| name=~ search_regexp }
+text_results = @wiki.select { |name,apage| apage.content=~ search_regexp }
+%>
+
+<h1>Results of Search for &#8220;<%= query['regex'] %>&#8221;</h1>
 
 <% unless title_results.empty? %>
 	<h2>Matches in the titles of pages</h2>
@@ -25,5 +31,5 @@
 <% end %>
 
 <div class='command'>
-	<a href='<%= url pagename, "edit" %>' accesskey="E" >Create a page titled &#8220;<%= pagename %>&#8221;</a>
+	<a href='<%= url query['regex'], "edit" %>' accesskey="E" >Create a page titled &#8220;<%= query['regex'] %>&#8221;</a>
 </div>

data/templates/default/views/Page_linksfromrss.rhtml

@@ -0,0 +1,24 @@
+<%=
+require "rss/maker"
+
+RSS::Maker.make("2.0") do |maker|
+  	
+  	maker.encoding = 'iso-8859-1'
+  	
+  	maker.channel.title = "#{page.name} (#{name})"
+	maker.channel.description = description
+	maker.channel.link = url(page.name)
+
+	maker.image.title = name
+	maker.image.url = file("logo.png")
+
+	page.links_from.each do |linked_page|
+		item = maker.items.new_item
+		item.link = url(linked_page.name)
+		item.title = linked_page.name
+		item.date = linked_page.revised_on
+		item.author = linked_page.author
+		item.description = redcloth( linked_page )
+	end
+end
+%>

data/templates/default/views/Page_listrss.rhtml

@@ -0,0 +1,46 @@
+<%=
+require "rss/maker"
+
+RSS::Maker.make("2.0") do |maker|
+  	
+  	maker.encoding = 'iso-8859-1'
+  	
+  	maker.channel.title = "#{name} #{page.name}"
+	maker.channel.description = description
+	maker.channel.link = root_url
+
+	maker.image.title = name
+	maker.image.url = file('logo.png')
+	
+	maker.items.do_sort = true
+	
+	count = 0
+	page.textile.scan(%r{/revision/([^?]+)\?time=(\d+)}) do |linked_pagename,time|
+		break if (count +=1) == 15
+		linked_page = @wiki.page( linked_pagename )
+		revision =  linked_page.revisions.detect { |revision| revision.created_on.to_i >= time.to_i }
+		
+		item = maker.items.new_item
+		item.link = url(linked_page.name)
+		item.title = linked_page.name
+		item.date = revision.revised_on
+		item.author = revision.author
+		item.description = ""
+		revision.number.downto(0) do |number|
+			revision = linked_page.revision(number)
+			break unless revision.author == item.author
+			content_deleted = false
+			revision.changes.each do |change_group|
+				change_group.each do |change|
+					case change[0]
+					when "-"; content_deleted = true
+					when "+"; item.description << "#{change[2]}<br />"
+					end
+				end
+				item.description << "&#8230;<br />"
+			end
+			item.description << "Content was also deleted<br />" if content_deleted
+		end
+	end
+end
+%>

data/templates/default/views/Page_meta.rhtml

@@ -1,4 +1,4 @@
-<span class='pagename'><a href='<%= url pagename %>'><%= pagename %></a> <%= page.deleted? ? "(Deleted)" : '' %></span>
+<span class='pagename'><a href='<%= url page.name %>'><%= page.name %></a> <%= page.deleted? ? "(Deleted)" : '' %></span>
 
 <h1><%= pagename %></h1>
 

data/templates/default/views/Page_revision.rhtml

@@ -0,0 +1,39 @@
+<span class='pagename'><a href='<%= url page.name, "meta" %>'><%= page.name %></a> <%= page.deleted? ? "(Deleted)" : '' %></span>
+
+<%
+if query['time'] 
+	final_revision = page.revisions.detect { |revision| revision.created_on.to_i >= query['time'].to_i }
+	final_revision_number = final_revision.number if final_revision
+end
+final_revision_number ||= ( query['revision'] || page.number ).to_i
+final_revison_number = page.number if final_revision_number > page.number
+final_revision ||= page.revision( final_revision_number )
+%>
+
+<h1>Revisions made by <%= final_revision.author%> up to <%= final_revision.revised_on.strftime('%H:%M %a %d %b %Y') %></h1>
+
+<p>Note, if you wish to edit or undo these revisions, please follow the links from <a href='<%= url page.name, 'edit' %>'>here</a>. You cannot do it from here, becuase someone may have edited the page more recently and because you may need a password to edit the page.</p>
+
+<% final_revision_number.downto(0) do |number| %>
+	<% revision = page.revision( number ) %>
+	<% break unless revision.author == final_revision.author %>
+	<div class="undochange">
+		<p><%= revision.created_on.strftime('%H:%M %a %d %b %Y') %></p>
+		<ol>	
+		<% revision.changes.each do |change_group| %>
+				<%	change_group.each do |change|
+					case change[0]
+					when "-" %>
+						<li><del><%= change[1] %>. <%= change[2].gsub('<','&lt;').gsub('>','&gt;') %></del></li>
+					<% 	when "+" %>
+						<li><%= change[1] %>. <%= change[2].gsub('<','&lt;').gsub('>','&gt;') %></li>
+					<%	end %>
+				<%	end %>
+		<% end %>			
+		</ol>
+	</div>		
+<% end %>
+
+<div class='command'>
+	<a href='<%= url page.name %>' accesskey="V" >View</a>, <a href='<%= url page.name, "edit" %>' accesskey="E" >Edit</a> or <a href='<%= url page.name, "revisions" %>' accesskey="R" >see all changes to</a> this page.
+</div>

data/templates/default/views/Page_revisions.rhtml

@@ -1,7 +1,12 @@
-<span class='pagename'><a href='<%= url pagename, "meta" %>'><%= pagename %></a> <%= page.deleted? ? "(Deleted)" : '' %></span>
+<span class='pagename'><a href='<%= url page.name, "meta" %>'><%= page.name %></a> <%= page.deleted? ? "(Deleted)" : '' %></span>
 
+<% start_at_revision = query['revision'] ? query['revision'].to_i : 0 %>
 
-<% page.revisions.reverse_each do |revision| %>
+<% if start_at_revision > 0 %>
+	<p><a href='<%= url page.name, "revisions", "?revision=#{start_at_revision-10}" %>' accesskey="N" >Newer revisions</a></p>
+<% end %>
+
+<% page.revisions[start_at_revision,10].reverse_each do |revision| %>
 	<div class="undochange">
 		<p><%= revision.created_on %> by <a href='<%= url revision.author %>'><%= revision.author %></a></p>
 		<ol>	
@@ -16,13 +21,16 @@
 				<%	end %>
 		<% end %>			
 		</ol>
-		<form method=post action='<%= url pagename, "rollback" %>' >
+		<form method=post action='<%= url page.name, "rollback" %>' >
 			<input name='revision' value='<%= revision.number-1 %>' type='hidden' />
 			<input name='action' value='Undo the changes above' type='submit' />
 		</form>
 	</div>		
 <% end %>
 
+<% if (start_at_revision+10) < page.revisions.size %>
+	<p><a href='<%= url page.name, "revisions", "?revision=#{start_at_revision+10}" %>' accesskey="O" >Older revisions</a></p>
+<% end %>
 <div class='command'>
-	<a href='<%= url pagename, "edit" %>' accesskey="R" >Return to editing</a>
-</div>
+	<a href='<%= url page.name, "edit" %>' accesskey="R" >Return to editing</a>
+</div>