Soks 0.0.2 → 0.0.3

data/lib/soks.rb

@@ -11,9 +11,11 @@ require 'thread'
 require 'yaml'
 
 require 'soks-utils'
+require 'soks-storage'
 require 'soks-model'
 require 'soks-view'
 require 'soks-servlet'
 require 'soks-helpers'
 
-
+Thread.abort_on_exception = true
+Socket.do_not_reverse_lookup = true

data/templates/default/attachment/newpage.js

@@ -0,0 +1,41 @@
+function trim(str) 
+{ 
+	return str.replace(/^\s+/,'').replace(/\s+$/,'');
+}
+
+function editSelected()
+{
+	if (window.getSelection)
+	{
+		txt = window.getSelection();
+	}
+	else if (document.getSelection)
+	{
+		txt = document.getSelection();
+	}
+	else if (document.selection)
+	{
+		txt = document.selection.createRange().text;
+	}
+	if(!txt){
+	void(txt=prompt('Please enter the title of the page you wish to create',''))
+	}
+	if(txt){
+		window.location = '/edit/'+escape(trim(txt))
+	}
+}
+
+function hotkey( event )
+{
+ 	event = (event) ? event : ((window.event) ? event : null);
+	if (event)
+	{
+	if (event.ctrlKey ) 
+	{
+		var charCode = (event.charCode) ? event.charCode : ((event.which) ? event.which : event.keyCode);
+		if (charCode == 14 ) { 
+			editSelected();
+		}
+	}
+	}
+}

data/templates/default/attachment/print_stylesheet.css

@@ -0,0 +1,7 @@
+#Menu {
+	display: none;
+}
+
+#command {
+	display: none;
+}

data/{template → templates/default}/attachment/stylesheet.css

@@ -1,25 +1,29 @@
 /* Based, with permission, on bluerobot.com */
 
 body {	margin:0px;	padding:0px;
-	font-size:smaller;	font-family:verdana, arial, helvetica, sans-serif;	color:#333;	background-color:white;	}
-
-h1 {	color:#E00000;	}
-
-a {	color:#09c;	text-decoration:none;	}
-
-a:link {color:#09c;}a:visited {color:#07a;}
-
+	font-size:smaller;	font-family:verdana, arial, helvetica, sans-serif;	color:#333;	background-color:white;	}
+
+h1 {	color:#E00000;	}
+
+a {	color:#09c;	text-decoration:none;	}
+
+a:link {color:#09c;}a:visited {color:#07a;}
+
 a:hover {background-color:#eee;}
 
 a.missing {
 	color:#E00000;
-}#Content {	margin:0px 210px 50px 10px;	padding:10px;	}#Menu {	position:absolute;	top:12px;	right:10px;	width:162px;	padding:10px;	background-color:#E00000;	border:1px solid #000000;/* Again, the ugly brilliant hack. */	voice-family: "\"}\"";	voice-family:inherit;	width:150px;	}/* Again, "be nice to Opera 5". */body>#Menu {width:150px;}
-
-td {
-	font-size:smaller;
-}
+}
 
-#Menu a {
+#content {	margin:0px 210px 50px 10px;	padding:10px;	}
+
+#menu {	position:absolute;	top:12px;	right:10px;	width:162px;	padding:10px;	background-color:#E00000;	border:1px solid #000000;/* Again, the ugly brilliant hack. */	voice-family: "\"}\"";	voice-family:inherit;	width:150px;	}/* Again, "be nice to Opera 5". */body>#menu {width:150px;}
+
+td {
+	font-size:smaller;
+}
+
+#menu a {
 	display: block;
 	color:#000000;
 	border-top: solid 1px #F00000;
@@ -28,6 +32,10 @@ td {
 .pagename {
 	font-size: xx-small;
 	display: block;
+}
+
+img {
+	border-style: none;
 }
 
 .disclaimer {
@@ -36,8 +44,8 @@ td {
 }
 
 .subpage {
-	padding: 0px 10px 0px 10px;
-	margin: 0px;	
+	padding: 10px;
+	margin: 10px;	
 	border: solid 1px #AAAAAA;
 	font-size:x-small;
 }
@@ -46,7 +54,8 @@ p.more {
 	font-size: xx-small;
 	text-align: right;
 	padding: 0px;
-	font-color: #grey;
+	font-color: #grey;
+	color: gray;
 }
 
 .subpage h1 {
@@ -61,3 +70,21 @@ p.more {
 	padding: 0px 10px 0px 10px;
 	margin: 0px;	border: solid 1px #AAAAAA;
 }
+
+a.pageview {
+	display: inline;
+}
+
+pre.change {
+	margin: 0px;
+	padding: 0px;
+}
+
+ul.tips {
+	list-style-type: none;
+}
+
+.metacolumn {
+	display: inline;
+	font-size: smaller;
+}

data/templates/default/banned_titles.txt

@@ -0,0 +1,31 @@
+# Each line contains a title that will NOT be automatically linked in the wiki (can still be manually linked)
+the
+of
+and
+a
+to
+in
+is
+that
+it
+was
+he
+for
+as
+on
+with
+his
+be
+at
+you
+I
+are
+this
+by
+from
+had
+have
+they
+not
+or
+one

data/templates/default/content/Bug%3A%20In%20a%20list%20of%20links%2C%20the%20last%20link%20is%20sometimes%20not%20linked.textile

@@ -0,0 +1,10 @@
+In a list of links, the last link is sometimes not linked.
+
+e.g: 'How to administrate this wiki' might not be linked in this list:
+
+* How to export a site from this wiki 
+* How to hack soks 
+* How to import a site from instiki 
+* How to use this wiki 
+* How to change the way this wiki looks 
+* How to administrate this wiki 

data/templates/default/content/Bug%3A%20Symbols%20are%20not%20always%20correctly%20rendered%20in%20html.textile

@@ -0,0 +1,3 @@
+Symbols are often incorrectly encoded in the textile to html conversion.  
+
+Eg. > should be the same as <notextile>></notextile>

data/templates/default/content/Bug%3A%20Uploads%20are%20not%20password%20protected.textile

@@ -0,0 +1,3 @@
+Anything uploaded to the website (e.g. pictures, or attached files) is not protected by any form of authentication.  
+
+If anyone knows how to add authentication to the Webrick FileHandler then please let me know.

data/templates/default/content/How%20to%20administrate%20this%20wiki.textile

@@ -0,0 +1,62 @@
+h1. Adjusting the settings
+
+Take a look at the start.rb file in your wiki folder.  This can be used to change the settings such as port and url of this site, and to enable more advanced features such as calendars and automatic summaries.
+
+h2. To restart your wiki
+
+The soks-create-wiki.rb script will have created a folder in the directory in which you ran it (by default the folder is 'soks-wiki'). In that folder is a script 'start.rb' run it.
+<code>
+cd soks-wiki
+ruby start.rb
+</code>
+
+h2. To make your site accessible beyond localhost
+
+Open start.rb in your directory. Un-comment the lines
+<code>
+# :url => 'http://localhost:8000',
+# :port => 8000,
+</code>
+and replace them with the url and port you wish the wiki to run on.
+
+h2. To password protect your site.
+
+Open start.rb in your wiki directory. Un-comment and edit the authenticators section and edit the array.  The format is [  [ first regexp to match against title, authenticator to use ],  [ second regexp to match against title, authenticator to use ] .... ]. For example:
+
+# This matches against all the standard 'non editing commands' and doesn't ask for any authentication
+<code>[ %r{/(view|rss|print|find|meta)/.*}, WEBrick::HTTPAuth::NoAuthenticationRequired.new ]</code>
+
+# This doesn't permit any file or picture uploads
+<code>[ %r{/upload/.*}, WEBrick::HTTPAuth::NotPermitted.new ]</code>
+
+# This asks for a site wide password to edit or save changes to the home page
+<code>[ %r{/(edit|save)/home page}, WEBrick::HTTPAuth::SiteWidePassword.new('password','You need to enter the site wide password to edit the home page') ]</code>
+
+# This uses the standard WEBrick authentication system on any page whose name starts with private. The standard WEBrick authentication uses a database of usernames and passwords.  See [[ Gnome's Guide => http://shogo.homelinux.org/~ysantoso/webrickguide/html/html_webrick.html ]] for details.
+<code>[ %r{/(view|edit|save)/private.*},WEBrick::HTTPAuth::BasicAuth.new( :UserDB => htpasswd, :Realm => realm ) ]</code>
+
+# This is the default. For any page it just asks for a username, but the password can be left blank.
+<code>[ %r{.*}, WEBrick::HTTPAuth::AskForUserName.new( 'No password, just enter a name') ]</code>						
+
+Note a big bug is that viewing attached images and files is NOT password protected.  If someone knows how to make WEBrick::HTTPServlet::FileHandler use an authenticator, please let me know. 
+
+h2. To edit the default site settings used by soks-create-wiki.rb
+
+Edit template/start.rb in the directory where soks was installed.
+
+h2. To change how often the wiki checks the content directory for any changes.
+
+Open start.rb and add this to your CUSTOM_SETTINGS hash:
+<code>:check_files_every => 60, # Seconds</code>
+
+h2. To add a calendar and upcoming events page:
+
+Open start.rb and uncomment:
+<code>
+# 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
+</code>
+
+h2. To add a page that summarises other pages:
+
+See AutomaticSummary

data/templates/default/content/How%20to%20change%20the%20way%20this%20wiki%20looks.textile

@@ -0,0 +1,30 @@
+h1. Improving the style of this wiki
+
+If you develop any improvements to the layout and style of this wiki, and are willing to share, please send copies to me tamc@rubyforge.com (a zip of the view and attachment directory is probably the best method).
+
+h2. Changing the logo on the right
+
+The logo can be changed by replacing logo.tif in the in the attachment folder of the wiki you have created ( soks-wiki/attachment/logo.tif by default)
+
+h2. Changing the color scheme
+
+The stylesheet is stored in the attachment folder of the wiki you have created (soks-wiki/attachment/stylesheet.css by default).
+
+h2. Changing the html and layout
+
+The formatting of the wiki is stored in the views subdirectory of the folder in which the wiki was created (soks-wiki/views by default).  These pages are all erb ( www.ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html ).
+
+The folder contains:
+* frame.rhtml - This is the bulk of the html and is used to wrap all pages except those ending in 'print' or 'rss'
+* Page_view.rhtml - This is the 'standard' viewing page
+* Page_edit.rhtml - This is the 'standard' editing page
+* Page_revisions.rhtml - This is the 'standard' revisions page
+* Page_rss.rhtml - This attempts to create a rss feed for changes to the page 
+
+You can add a new type of view by creating a new file here ending in rthml, starting with Page and with _viewname in the middle.  E.g. for a new sort of 'doublesize' view you could create Page_doublesize.rhtml.  This would then be accessed by typing /doublesize/pagename as the url. 
+
+Note that you must restart soks for changes to the template to take effect.
+
+h2. Changing the default styles for NEW wikis 
+
+To change the style and layout of new wikis created using the soks-create-wiki.rb command, then edit the 'template' directory of wherever you installed soks.

data/templates/default/content/How%20to%20export%20a%20site%20from%20this%20wiki.textile

@@ -0,0 +1,60 @@
+h1. How to export a site from this wiki
+
+The contents of this site are stored in flat files in the 'contents' folder of this wiki (soks-wiki/contents by default).  They are the ones with the .textile ending.  Should be pretty easy to transfer them to wherever you need.
+
+The authors, and change history of each page are stored in the same folder with a yaml extension. These are yaml'd files that contain many documents.  Each document contains a single revision. Each revision is an array of [ revision number, changes, author, creation time ].  The changes is an array of change groups.  Each change group is an array of changed lines.  There may be several documents with the same revision number.  The last document with a particular revision number is the 'definative' one.
+
+E.g. The saved copy of a page titled Hello World would be two files:
+# Hello%20World.textile
+# Hello%20World.yaml
+
+Hello%20World.textile might contain:
+<pre>
+h1. Hello world
+
+What a beautiful world
+</pre>
+
+Hello%20World.yaml might contain
+<pre>
+--- # Start of document
+- 0 # Revision number
+- tamc # Revision author
+- 2005-01-23 22:53:11.081896 +00:00 # Revision time
+- # Array of change groups
+  - # Array of changes
+    -  # Each change is an array
+      - "+" # Add or delete
+      - 0 # Line number
+      - h1. Hello george # What the line is
+---
+- 0 # If a new revision is made by the same author within 30 minutes the revision number is not increased.  This is the definitive revision 0, the previous one should be ignored.
+- tamc
+- 2005-01-23 22:55:11.081896 +00:00
+- 
+  - 
+    - 
+      - "-"
+      - 0
+      - h1. Hello george
+    - 
+      - "+"
+      - 0
+      - h1. Hello world
+    - 
+---
+- 0
+- tamc
+- 2005-01-23 22:55:11.081896 +00:00
+- 
+  - 
+    - 
+      - "+"
+      - 1
+      - ""
+    - 
+      - "+"
+      - 2
+      - What a beautiful world
+    - 
+</pre>

data/{template → templates/default}/content/How%20to%20hack%20soks.textile

@@ -12,12 +12,13 @@ h2. template
 * show.rb - contains the default ruby file used by soks-create-wiki.rb, this is written using erb
 * attachments - contains the stuff that will be statically loaded when running a wiki, such as images and stylesheets. In particular you may want to replace logo.png
 * views - contains the default templates see Improving the style of this wiki for a few notes on this
-* content - contains the initial content for the wiki.  The .textile files are flatfile text files containing the textile for a page.  The title of the page is the filename (and has usually been url_encoded).  Any .marshal files in here contain arrays of Revision objects relating to the history of a particular page.
+* content - contains the initial content for the wiki.  The .textile files are flatfile text files containing the textile for a page.  The title of the page is the filename (and has usually been url_encoded).  Any .yaml files in here contain arrays containing the change history of the page
 
 h2. lib
 
 * soks.rb - Just requires all the other files
 * soks-utils.rb - Contains various utility classes, EventQueue, Notify and some extensions to String to url_encode and decode
+* soks-storage.rb - Contains a module which is mixed into the Wiki class to allow it to be saved
 * soks-model.rb - Contains the model of the wiki: Wiki, Page and Revision
 * soks-view.rb - Contains the classes that turn the wiki into html: View, WikiRedCloth, Links, RollingMatch
 * soks-servlet.rb - Contains the webrick server that passes commands to and from the View object
@@ -35,7 +36,7 @@ A Wiki class has many Page classes which have many Revision classes.  ImagePage
 
 The Wiki class decides what type of page to create based on its name.  All AttachmentPage pages have names that start with 'Attached ', all ImagePage pages have names that start with 'Picture of'. This is defined in the @page_classes instance variable of the Wiki class.
 
-The Wiki loads all the pages from file into a hash.  When pages are changed it writes a copy to disk immediately.
+The Wiki loads all the pages from file into a hash.  When pages are changed it writes a copy to disk immediately.  It has a thread that watches the disk for any changes to the files.
 
 h3. soks-view.rb
 

data/{template → templates/default}/content/How%20to%20import%20a%20site%20from%20instiki.textile

@@ -1,6 +1,6 @@
 h1. How to import a site from instiki
 
-[[ Instiki : www.instiki.org ]] is great, and was definitely an inspiration for this site.  If, however, you wish to import a wiki from instiki to here then you need to:
+[[ Instiki => www.instiki.org ]] is great, and was definitely an inspiration for this site.  If, however, you wish to import a wiki from instiki to here then you need to:
 
 # Launch your instiki wiki
 # Go to 'export' and click on 'Markup (textile)'

data/templates/default/content/How%20to%20use%20this%20wiki.textile

@@ -0,0 +1,27 @@
+h1. Pointers on how to use this wiki
+
+h2. Adding Pages
+
+There are several ways to add pages to soks:
+# Click on the 'add a new page'
+# Highlight the text on the page you wish to link from and press crtl-n[1]
+# Type the title of the page you wish to create and click search, there will be a link to create the page at the bottom of the search results.
+# As you are editing a page, put the title of a new page in square brackets like this: <notextile>[[ title of the new page ]]</notextile>.  When you save the page, a link will be created that permits you to create a new page.
+
+Yes, this means it is very easy to create orphaned pages. No I don't think this is a problem, because there is a site index.
+
+fn1. This only works on some browsers.  It doesn't seem to work on Mac Firefox or Mac OmniWeb. It does on Mac Safari.  Please report your successes and failiures.
+
+h2. Editing Pages
+
+* To edit a page, click edit. 
+* The pages are written in textile.  A reference is at http://hobix.com/textile/quick.html
+* Links to other pages within this wiki, and to web addresses, and to e-mail addresses, happen automatically
+* To force a link put it inside double square brackets e.g. <notextile>[[a forced link]]</notextile>
+* To alias a link: <notextile> [[ a different name for </notextile>=><notextile> site index ]] </notextile>
+* To insert another page: <notextile>[ [ insert site index ]]</notextile>
+* This is particularly usefull if you want to insert a picture: <notextile>[ [ insert picture of the soks logo ]]</notextile>
+
+h2. Searching
+
+The search box on the right takes a single regexp.  

data/templates/default/content/List%20of%20changes.textile

@@ -0,0 +1,35 @@
+h1. List of changes
+
+h2. Between v-0-0-3 and v-0-0-2
+
+h3. Features
+
+* File format for revisions changed from marshalled array of revisions to a yaml'd array of strings and times.  This should allow easier import/export.
+* Changes to the files on disk appear in the wiki (by default checks for changes on disk every 60 seconds) to allow external editing of the wiki.
+* New way of making new pages: highlight the text you wish to link and press crtl-n.  This only works on some browsers.
+* RSS feed for changes made to any page (use the RSS feed on Recent Changes to be notified of all changes to the site, use the RSS feed on Site Index to be notified of new pages).
+* Added a WikiWord link for those that don't like to give out links with %20's in them. e.g. http://yoursite.com/wiki/HomePage redirects to http://yoursite.com/view/Home%20Page.
+* The automatic summary class has been extended to allow summary based on the page title, page author, or page content.
+* Different parts of the wiki, and different commands, can be authenticated differently based on regexps.
+* Kill list of words that will not be automatically linked (default set is the 30 most common English language words).
+* The soks-create-wiki command can now be interactive (or can use command line options including --help and --no-interaction).  It also manages upgrades from the previous version of Soks.
+* There are some demo templates: default is the standard, rails looks a bit like www.rubyonrails.com and instiki which looks a bit like www.instiki.org. 
+* A meta data view of a page. Clicking on the page's title on the top left of the screen brings up a list of the links from and too that page, and a list of the people who have contributed to the page. 
+
+h3. Refactorings
+
+* The recent changes and site index helpers now use the automatic summary class.
+* The Wiki class now notifies other classes of changes to the site, including the View class.
+* The storage methods are now a module which is mixed into the wiki class.
+
+h3. Bug Fixes
+
+* Bug in uploads on windows fixed (thanks to Sebastien Clediere).
+* Bugs in accepting titles with punctuation fixed.
+* Bug in automatic summary fixed.
+* Logo changed from png to tif so that it is transparent on a wider selection of browsers.
+
+h3. Bugs remaining
+
+* No authentication on pictures and attachments
+* Lots of little faults with the textile to html conversion.  Some due to the use of Redcloth v 2.0.11 (looking forward to a stable v3!) and some due to my inept subclassing.