arrow 1.0.7

data/data/arrow/applets/tutorial/superhello.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+# 
+# The SuperHello class, a derivative of Arrow::Applet. A
+# "hello world" applet.
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'arrow/applet'
+
+
+### A superclass applet for testing inheritance
+class SuperHello < Arrow::Applet
+
+
+	# Applet signature -- since it defines no 'uri' item, it shouldn't be loaded
+	# by the appserver directly.
+	Signature = {
+		:name => "Hello World",
+		:description => %{A 'hello world' applet.},
+		:maintainer => "ged@FaerieMUD.org",
+		:default_action => 'templated',
+		:templates => {
+			:templated		=> 'hello-world.tmpl',
+			:printsource	=> 'hello-world-src.tmpl',
+		},
+	}
+
+
+
+	######
+	public
+	######
+
+	def_action :display do |txn, *args|
+		self.log.debug "In the 'display' action of the '%s' applet." %
+			self.signature.name 
+
+		txn.content_type = "text/plain"
+		return "Hello world."
+	end
+
+
+	def_action :templated do |txn, *args|
+		self.log.debug "In the 'templated' action of the %s applet." %
+			self.signature.name
+			
+		templ = self.load_template( :templated )
+		templ.txn = txn
+		templ.applet = self
+
+		return templ
+	end
+
+
+	def_action :printsource do |txn, *args|
+		self.log.debug "In the 'printsource' action of the %s applet." %
+			self.signature.name
+
+		src = File.read( __FILE__ ).gsub(/\t/, '    ')
+
+		templ = self.load_template( :printsource )
+		templ.txn = txn
+		templ.applet = self
+		templ.source = src
+
+		return templ
+	end
+
+end # class SuperHello

data/data/arrow/applets/tutorial/timeclock.rb

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+# 
+# The TimeClock class, a derivative of Arrow::Applet; it
+# implements a web-based timeclock applet.
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+# Please see the file LICENSE in the top-level directory for licensing details.
+#
+
+require 'bdb'
+
+require 'arrow/applet'
+
+
+### A timeclock applet
+class TimeClock < Arrow::Applet
+
+
+	# Applet signature
+	Signature = {
+		:name => "",
+		:description => "A web-enabled timeclock for consultants.",
+		:uri => "timeclock",
+		:maintainer => "ged@FaerieMUD.org",
+		:version => SVNRev,
+		:config => {
+			:datadir	=> '/www/RubyCrafters.com/private/timeclock',
+		},
+		:templates => {
+			:main		=> 'timeclock/main.tmpl',
+			:home		=> 'timeclock/home.tmpl',
+		},
+		:vargs => {
+			:_default_ => {
+				:optional		=> [:username],
+				:constraints	=> {
+					:username	=> /^(\w+)$/,
+				},
+				:untaint_constraint_fields => %w{class inline},
+			},
+		},
+		:monitors => {},
+		:default_action => 'home',
+	}
+
+
+
+	######
+	public
+	######
+
+	### Override #run to do things that need to be done for every action. All
+	### actions will be wrapped by this method, which wraps the template objects
+	### they return in a container 'main' template.
+	def run( txn, *rest )
+		super {|meth, txn, *rest|
+			template = self.load_template( :main )
+			
+			template.body = meth.call( txn, *rest )
+			template.txn = txn
+			template.navbar.txn = txn
+
+			return template
+		}
+	end
+
+
+	### Actions
+	
+	# 'home' is an implicit (template-only) action
+
+
+end # class TimeClock
+
+

data/data/arrow/applets/view-applet.rb

@@ -0,0 +1,123 @@
+#!/usr/bin/env ruby
+# 
+# The AppletViewer class, a derivative of Arrow::Applet. It is
+# an introspection applet that can be used to view the code for Arrow applets in
+# a running Arrow application.
+# 
+# == VCS Id
+# 
+# $Id$
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'arrow/applet'
+
+
+### An introspection applet that can be used to view the code for Arrow
+### applets in a running Arrow application.
+class AppletViewer < Arrow::Applet
+
+
+	# Width of tabs in prettified code
+	DefaultTabWidth = 4
+
+	# Applet signature
+	Signature = {
+		:name => "Applet Viewer",
+		:description => "An introspection applet that can be used to view the " +
+			"code for Arrow applets in a running Arrow application.",
+		:maintainer => "ged@FaerieMUD.org",
+		:default_action => 'display',
+		:templates => {
+			:display	=> 'view-applet.tmpl',
+			:nosuch		=> 'view-applet-nosuch.tmpl',
+		},
+	}
+
+
+	### Read configuration values from the 'viewapplet' section of the config
+	### (if it exists)
+	def initialize( *args )
+		super
+
+		@tabwidth = DefaultTabWidth
+
+		if @config.respond_to?( :viewapplet )
+			@tabwidth = Integer( @config.viewapplet.tabwidth ) rescue DefaultTabWidth
+		end
+
+		self.log.debug "Tab width set to %d" % @tabwidth
+	end
+
+
+	######
+	public
+	######
+
+	### The main applet-code display action
+	def display_action( txn, *appleturi )
+		self.log.debug "In the 'display' action of the '%s' app." % self.signature.name 
+
+		# Pick out the applet to view from the URI, if present
+		templ = nil
+		uri = appleturi.join( "/" )
+		applet = txn.broker.registry[ uri ]
+
+		# If the URI matched a loaded applet, display its source
+		if applet
+
+			# The applet's class knows from whence it was loaded.
+			fn = applet.class.filename
+			fn.untaint
+
+			# Plug the loaded values into the template
+			templ = self.load_template( :display )
+			templ.displayed_applet = applet
+			templ.filename = fn
+
+			# Read the code. This will later undergo some sort of greater
+			# fancification.
+			code = File.read( fn )
+			templ.code = self.format_code( code )
+			
+		else
+
+			# If there wasn't an applet to load, load the generic "oops"
+			# template and plug a message in.
+			templ = self.load_template( :nosuch )
+			templ.message = "Invalid or missing applet URI"
+		end
+
+		# Plug some more values into the template no matter what happened
+		templ.txn = txn
+		templ.applet = self
+
+		return templ
+	end
+
+	# Allow <uri>/<viewuri> as well as <uri>/display/<viewuri>
+	alias_method :action_missing_action, :display_action
+
+
+	#########
+	protected
+	#########
+
+	### Format the code prettily for display as HTML
+	def format_code( code )
+		newstr = code.split( /\n/ ).collect {|line|
+			line.gsub( /(.*?)\t/ ) do
+				$1 + ' ' * (@tabwidth - $1.length % @tabwidth)
+			end
+		}.join("\n")
+
+		return newstr
+	end
+
+
+end # class AppletViewer
+
+

data/data/arrow/applets/view-template.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+# 
+# The TemplateViewer class, a derivative of
+# Arrow::Applet. It is an introspection applet that displays information about
+# Arrow templates.
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'arrow/applet'
+require 'arrow/htmltokenizer'
+
+### A template viewer applet
+class TemplateViewer < Arrow::Applet
+
+
+	# Applet signature
+	applet_name "Template Viewer"
+	applet_description "It is an introspection applet that displays "\
+			"Arrow templates with syntax highlighting."
+	applet_maintainer "ged@FaerieMUD.org"
+
+	default_action :default
+
+
+
+	######
+	public
+	######
+
+
+	#################################################################
+	###	A C T I O N S
+	#################################################################
+	
+	def display_action( txn, *args )
+		self.log.debug "In the 'display' action of the '%s' applet." %
+			self.signature.name 
+
+		templ = self.load_template( :display )
+		templ.txn = txn
+		templ.applet = self
+
+		if txn.vargs && txn.vargs[:template]
+			args.replace( txn.vargs[:template].split(%r{/}) )
+		end
+		
+		# Eliminate harmful parts of the path and try to load the template
+		# specified by it
+		self.log.debug "Args: %p" % [ args ]
+		args.reject! {|dir|
+			dir.nil? || dir.empty? || /^\./ =~ dir || /[^-\w.]/ =~ dir
+		}
+		tpath = File.join( *args ).untaint
+		templ.path = tpath
+
+		unless tpath.empty?
+			begin
+				dtempl = self.templateFactory.get_template( tpath )
+			rescue Arrow::TemplateError => err
+				templ.error = err
+			else
+				templ.template = dtempl
+				templ.tokenizer = Arrow::HTMLTokenizer.new( dtempl._source )
+			end
+		end
+
+		return templ
+	end
+	template :display	=> 'view-template.tmpl',
+		:default	=> 'templateviewer.tmpl'
+	validator :display, {
+		:optional		=> [:template],
+		:constraints	=> {
+			:template	=> %r{^([\w./-]+)$},
+		},
+		:untaint_constraint_fields => %w{template},
+	}
+
+
+end # class TemplateViewer
+
+

data/data/arrow/applets/wiki.rb

@@ -0,0 +1,274 @@
+#!/usr/bin/env ruby
+# 
+# The ArrowWiki class, a derivative of Arrow::Applet. It's a
+# simple wiki to demonstrate the Arrow framework.
+# 
+# == VCS Id
+# 
+# $Id$
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'arrow/applet'
+
+
+### It's a simple wiki that can serve as a proof of concept
+class WikiApplet < Arrow::Applet
+
+
+	# Applet signature
+	Signature = {
+		:name => "Arrow Wiki Toplevel Applet",
+		:description => "A wiki for FaerieMUD documentation",
+		:maintainer => "ged@FaerieMUD.org",
+		:default_action => 'index',
+		:templates => {
+			:main		=> 'wiki/main.tmpl',
+			:new_system => 'wiki/new_system.tmpl',
+			:show		=> 'wiki/show.tmpl',
+			:new		=> 'wiki/new.tmpl',
+			:save		=> 'wiki/save.tmpl',
+			:formerror	=> 'wiki/formerror.tmpl',
+		},
+
+		:validator_profiles => {
+
+			# Target for the form in /new_system
+			:create_system => {
+				:untaint_all_constraints => true,
+				:required       => [:password, :web_name, :web_address],
+                :constraints    => {
+                    :password		=> /^([\x20-\xff]+)$/,
+                    :web_name		=> /^([\x20-\xff]+)$/,
+					:web_address	=> /^([a-z0-9]+)$/i,
+                },
+			},
+
+			# Target for the forms in /edit and /new
+			:save => {
+				:untaint_all_constraints => true,
+				:required       => [:author, :content],
+                :constraints    => {
+                    :author			=> /^([\x20-\xff]+)$/,
+					:content		=> /^([\r\n\t\x20-\xff]+)$/,
+                },
+			},
+		},
+	}
+
+	# Default location for the wiki storage
+	DefaultStoragePath = "/tmp/wikiapplet"
+
+
+	### Create a new wiki controller applet.
+	def initialize( *args )
+		super
+
+		# Read configuration values from the config file if it exists
+		if @config.respond_to?( :wiki )
+			wconfig = @config.wiki
+			WikiService.storage_path = wconfig.storage
+		else
+			WikiService.storage_path = DefaultStoragePath
+		end
+	end
+
+
+	######
+	public
+	######
+
+	# Notes:
+	#
+	#   In instiki the action is stuck between the web and the topic like:
+	#     /<web>/view/<topic>
+	#   In this implementation the action always precedes the data, like so:
+	#     /view/<web>/<topic>
+	#   This might require tinkering a bit with the WikiService's innards, as I
+	#   don't know if its link-builder is coupled with its internal urispace,
+	#   but I suspect it is.
+
+	### Debugging action /inspect
+	def inspect_action( txn, *args )
+		txn.content_type = "text/plain"
+		return "%p: %d" % [ self.wiki, Process.pid ]
+	end
+
+
+	### Default "/" action -- redirects to the system init if the wiki's not yet
+	### set up, redirects to the web list if there are more than one web, or
+	### redirects to the home page if there's only one web.
+	def index_action( txn, web=nil, *args )
+		if !self.wiki.setup?
+			return txn.redirect( txn.action + "/new_system/" )
+		elsif self.wiki.webs.length == 1
+			return txn.redirect( txn.action + "/show/" +
+				self.wiki.webs.values.first.address )
+		else
+			return txn.redirect( txn.action + "/web_list/" )
+		end
+	end
+
+
+	### /new_system action -- Initializes a new wiki.
+	def new_system_action( txn, *args )
+		if self.wiki.setup?
+			return txn.redirect( txn.action )
+		end
+
+		tmpl = self.load_template( :new_system )
+		tmpl.txn = txn
+		tmpl.applet = self
+		tmpl.wiki = self.wiki
+
+		return tmpl
+	end
+
+
+	### /create_system action -- the target for the /new_system action's
+	### form. Untaints the incoming arguments, does the creation of the new wiki
+	### if they check out, or displays /new_system's template again with errors
+	### if the args were bad.
+	def create_system_action( txn, *args )
+		if !(txn.vargs.missing.empty? && txn.vargs.invalid.empty?)
+			badargs = txn.vargs.missing | txn.vargs.invalid.keys
+			self.log.error "Invalid or missing arguments: %p" % badargs
+
+			tmpl = self.new_system_action( txn )
+			badargs.each do |field|
+				tmpl.errors << "Invalid or missing field '#{field}'"
+			end
+
+			return tmpl
+		else
+			vargs = txn.vargs
+			self.log.info "Creating new web with args: %p" % [ vargs.valid.to_a ]
+
+			self.wiki.setup(
+				vargs[:password],
+				vargs[:web_name],
+				vargs[:web_address] ) unless
+				self.wiki.setup?
+
+			return txn.redirect( txn.action + "/new/" + vargs[:web_address] +
+				"/HomePage" )
+		end
+	end
+
+
+	### /new/+web+/+topic+ -- create a new topic on the specified +web+ called
+	### +topic+.
+	def new_action( txn, web=nil, topic=nil, *args )
+		return txn.redirect( txn.action ) unless web
+		return txn.redirect( txn.action + "/show/" + web ) unless topic
+
+		templ = self.load_template( :new )
+
+		templ.txn = txn
+		templ.topic = topic
+		templ.web = web
+		templ.author = txn.session[:author] || "AnonymousCoward"
+
+		return templ
+	end
+
+
+	### /show/+web+/+topic+ -- Show the specified +topic+ from the given +web+.
+	def show_action( txn, web=nil, topic="HomePage", *args )
+		return txn.redirect( txn.action ) unless web
+
+		self.log.debug "Showing '#{web}/#{topic}'"
+
+		if page = self.wiki.read_page( web, topic )
+			templ = self.load_template( :show )
+			templ.txn = txn
+			templ.web = web
+			templ.page = page
+
+			return templ
+		else
+			return txn.redirect( txn.applet + "/new/" + topic )
+		end
+	end
+
+
+	### /save/+web+/+topic+ -- Save the values for the specified +topic+ to the
+	### given +web+, creating it if it didn't already exist.
+	def save_action( txn, web=nil, topic=nil, *args )
+		self.log.debug "Save: web: %p, topic: %p" % [web, topic]
+		return txn.redirect( txn.applet ) unless web
+		return txn.redirect( txn.applet + "/show/" + web ) unless topic
+
+		templ = nil
+		txn.session[:wiki_author] = txn.vargs[:author] if txn.vargs.key?( :author )
+
+		# If the arguments don't validate, fetch the template from the referring
+		# action again and inject explanatory errors into it.
+		return self.report_form_errors( txn, web, topic ) if txn.vargs.errors?
+
+		webobj = self.wiki.webs[ web ] or return txn.redirect( txn.applet )
+		author = Author.new( txn.vargs[:author], txn.remote_ip )
+		self.log.debug "Save for web: %p, author: %p" % [webobj, author]
+		
+		# If it already exists, add a revision to the page
+		if webobj.pages[ topic ]
+			self.log.debug "Revising page '#{topic}'"
+			page = self.wiki.
+				revise_page( web, topic, txn.params[:content], Time.now, author )
+			page.unlock
+
+		# Otherwise it's a new page
+		else
+			self.log.debug "Creating page '#{topic}'"
+			page = self.wiki.
+				write_page( web, topic, txn.params[:content], Time.now, author )
+		end
+
+		return txn.redirect( txn.applet + "/" + ["show", web, topic].join("/") )
+	end
+
+
+	### /web_list -- List the webs that are available
+	def web_list_action( txn, *args )
+		txn.content_type = "text/plain"
+		return "Would be listing the available webs"
+	end
+
+
+	#########
+	protected
+	#########
+
+
+	### Call the referring action again, but add any validator error messages to
+	### the returned template's 'formerrors' field.
+	def report_form_errors( txn, web, topic, *args )
+		templ = nil
+		refaction = txn.referringAction
+				
+		if refaction && self.actions[ refaction ]
+			templ = self.subrun( refaction, txn, web, topic, *args )
+		else
+			templ = self.load_template( :formerror )
+
+			templ.txn = txn
+			templ.applet = self
+		end			
+
+		templ.formerrors = txn.vargs.error_messages
+		return templ
+	end
+	
+
+	### Return the WikiService instance
+	def wiki
+		WikiService.instance
+	end
+
+
+end # class ArrowWiki
+
+