nitro 0.1.2 → 0.2.0

data/lib/n/app/user.rb

@@ -1,15 +1,8 @@
-# = User
-#
-# A user of the Web Application. This is a base object, typically
-# extended by the users part.
-#
-#--
 # code:
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
-# (c) 2002-2003 Navel, all rights reserved.
-# $Id: user.rb 86 2004-10-19 13:58:40Z gmosx $
-#++
+# (c) 2004 Navel, all rights reserved.
+# $Id: user.rb 99 2004-10-22 09:50:28Z gmosx $
 
 require "singleton"
 
@@ -17,6 +10,9 @@ module N
 
 # = Anonymous User
 #
+# An anonymous user of the Web Application. This is a base 
+# object, typically extended by the users part.
+#
 # Implemented as singleton.
 #
 class AnonymousUser
@@ -38,10 +34,13 @@ class AnonymousUser
 	end
 	
 	def login
+		# nop
 	end
 	
 	def logout
-	end	
+		# nop
+	end
+
 end
 
 end # module

data/lib/n/app/webrick-servlet.rb

@@ -1,10 +1,8 @@
-# = Webrick Servlet.
-#
 # code:
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: webrick-servlet.rb 87 2004-10-19 17:27:45Z gmosx $
+# $Id: webrick-servlet.rb 106 2004-10-25 11:31:11Z gmosx $
 
 require "drb"
 require "singleton"
@@ -18,7 +16,7 @@ require "n/app/handlers"
 require "n/app/session"
 
 # Override WEBrick to suit our needs.
-
+#
 module WEBrick
 	class HTTPRequest
 		alias_method :old_parse_uri, :parse_uri
@@ -43,6 +41,8 @@ module WEBrick
 		end		
 	end
 
+	# Expose some response variables.
+	#
   class HTTPResponse
 		attr_writer :header
 		attr_writer :cookies
@@ -53,15 +53,26 @@ module N; module App
 
 # = WebrickServlet
 #
+# A webrick servlet that implements the Nitro Engine.
+# 
+# TODO: Lots of stuff should be factored out!
+#
 class WebrickServlet < WEBrick::HTTPServlet::AbstractServlet
 	include WEBrick
 
+	# Handle a HTTP GET request.
+	# 
 	def do_GET(wreq, wres)
 		request = create_request(wreq)
 		request.session = create_session(request)
 
 		extension = N::StringUtils.extension_from_path(request.path)
-		handler = $srv_extension_map[extension][1]
+		if handler = $srv_extension_map[extension]
+			handler = handler[1]
+		else
+			$log.error "Cannot handle '#{request.path}'"
+			return nil
+		end
 
 		begin
 			fragment, script = handler.process(request)
@@ -117,6 +128,8 @@ class WebrickServlet < WEBrick::HTTPServlet::AbstractServlet
 		wres.body = request.out_buffer
 	end
 
+	# Just reuse the GET code.
+	#
 	def do_POST(wreq, wres)
 		do_GET(wreq, wres)
 	end
@@ -135,12 +148,13 @@ class WebrickServlet < WEBrick::HTTPServlet::AbstractServlet
 		request.uri = wreq.unparsed_uri
 		request.translated_uri = wreq.path_info
 		request.path = wreq.path
+		# enforce filename if missing, FIXME: improve this.
+		request.path << $index_filename if request.path[-1] == ?/ 
 #		request.path_info = wreq.path_info
 		request.query_string = wreq.query_string
 		request.method = wreq.request_method
-#		request.remote_addr = wreq["REMOTE_ADDR"]
-		# gmosx: we use an apache proxy for the moment.
-		request.remote_addr = wreq["X-FORWARDED-FOR"]
+		# gmosx: X-FORWARDED-FOR is used in a proxy configuration.
+		request.remote_addr = wreq["X-FORWARDED-FOR"] || wreq["REMOTE_ADDR"]
 
 		# gmosx: remove this ??		
 		request.in = {}
@@ -170,7 +184,6 @@ class WebrickServlet < WEBrick::HTTPServlet::AbstractServlet
 		# INVESTIGATE, FIXME: this is a hack!
 		# apache prepends $srv_url and fucks up msie.
 		# FIXME: add unit test for this!
-
 		if ref = request.in["REFERER"]
 			split_re = Regexp.new($srv_url) unless split_re
 			xref = ref.split(split_re).last

data/lib/n/app/webrick.rb

@@ -1,11 +1,9 @@
-# = Webrick AppServer
-#
-# Used temporarily unitl we build our own app server.
-#
-# code:: gmosx, elathan
+# code:
+# * George Moschovitis  <gm@navel.gr>
+# * Elias Athanasopoulos  <elathan@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: webrick.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: webrick.rb 106 2004-10-25 11:31:11Z gmosx $
 
 require "drb"
 require "cgi"
@@ -24,17 +22,20 @@ module N; module App
 # Dont keepalive (or use a VERY SMALL keepalive). Typically this server
 # is used along with a standard http server that handles other resources.
 #
-class Webrick < N::Server
-	include N::App::ServerMixin
+# Used temporarily unitl we build our own app server.
+#
+class Webrick < N::App::Server
 	include WEBrick
 
+	# the integrated webrock server.
 	attr_accessor :webrick
 	
 	def initialize(name = "WebrickServer")
 		super
-		initialize_app()
 	end
 
+	# Start the application server.
+	#
 	def start
 		accesslog = WEBrick::BasicLog::new("/dev/null") 
 		referer = WEBrick::BasicLog::new("/dev/null")	
@@ -42,7 +43,7 @@ class Webrick < N::Server
 		@webrick = HTTPServer.new(
 			:BindAddress => $appsrv_address, 
 			:Port => $appsrv_port, 
-			:DirectoryIndex => ["index.sx"],
+			:DocumentRoot => $root_dir,
 			# gmosx, FIXME: this shit still logs!!
 			:Logger => Log.new(nil, WEBrick::Log::WARN),
 			# elathan: amateur...
@@ -61,6 +62,8 @@ class Webrick < N::Server
 		@webrick.start()
 	end
 	
+	# Stop the application server.
+	#
 	def stop
 		@webrick.stop
 	end

data/lib/n/application.rb

@@ -1,9 +1,15 @@
 # = Application
 #
-# code: gmosx, ekarak, drak, elathan
+# The default Application object of the Framework.
+#
+# code: 
+# George Moschovitis  <gm@navel.gr>
+# Anastasios Koutoumanos  <ak@navel.gr>
+# Elias Athanasopoulos  <elathan@navel.gr>
+# Elias Karakoulakis  <ekarak@ktismata.com>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: application.rb 71 2004-10-18 10:50:22Z gmosx $
+# $Id: application.rb 98 2004-10-22 07:36:20Z gmosx $
 
 require 'optparse'
 require 'ostruct'
@@ -15,7 +21,7 @@ module N
 
 # == Application
 #
-# the default Application object of the Framework.
+# The default Application object of the Framework.
 #
 class Application
 	# credentials of the application
@@ -31,12 +37,13 @@ class Application
 	# startup time of the application
 	attr_accessor :create_time
 
+	# is the application daemonized?
 	attr_reader :daemonized
 
 	# the pid of the application
 	attr_reader :pid, :pidfile
 	
-	#
+	# Intialize method
 	#
 	def initialize(name = "Unknown")
 		@name = name
@@ -45,8 +52,8 @@ class Application
 		@status = :stop
 	end
 
-	# FIXME: deleting of arguments is wrong, recode
-	# this using GETOPT.
+	# Parse the arguments passed to the application.
+	# Some standard arguments are handled by default.
 	#
 	def parse_arguments(args = ARGV)
       

data/lib/n/config.rb

@@ -1,18 +1,29 @@
-# = Config
-#
-# Configuration
+# = Configuration
+# 
+# Configuration parameters.
 #
 # code: 
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: config.rb 89 2004-10-20 12:55:58Z gmosx $
+# $Id: config.rb 106 2004-10-25 11:31:11Z gmosx $
 
+# the name of the server
 $srv_name = "Nitro"
-$srv_version = "0.1.2"
 
+# the version of the server
+$srv_version = "0.2.0"
+
+# monitor scripts for changes
+#--
+# gmosx, FIXME: replace this with reload_scripts ??
+#++
 $srv_monitor_scripts = true
-$srv_default_file = "index.sx"
+
+# the default file to view in a direcotry
+$index_filename = "index.sx"
+
+# seconds till the autologin cookie expires
 $srv_autologin_expires = 60*60*24*30
 
 # session timeout (in seconds)

data/lib/n/db.rb

@@ -1,45 +1,8 @@
-# = Database
-#
-# An efficient, yet simple Object-Relational Mapper. 
-#
-# === Design
-#
-# Keep this class backend agnostic. Put backend specific code in
-# the Connection / Managed class.
-#
-# Try to make the methods work with oids. We do keep 
-# a unified id space. Include the N::Sequenced Marker to 
-# denote custom id space.
-# Do NOT implement descendants use a root id (rid).
-#
-# For class ids we use the name instead of a hash. Class ids are
-# typically not used in querys, they are stored for completeness.
-# If we store a hash we cannot reclaim the class thus invalidating
-# the point. Instead of .name(), to_s() is used so the methods
-# are more flexible (they accept class names too!!)
-# 
-# === WARNING:
-#
-# When creating a new db exec the following:
-# CREATE SEQUENCE oids_seq;
-#
-# or
-#
-# DbTools.create_oids_seq
-#
-#
-# === Todo
-#
-# - support caching
-# - support prepared statements
-# - foreign keys (delete cascade)
-# - keep attribudes as marshaled!!
-#
 # code:
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: db.rb 79 2004-10-18 16:38:19Z gmosx $
+# $Id: db.rb 106 2004-10-25 11:31:11Z gmosx $
 
 module N; 
 
@@ -58,7 +21,59 @@ require "n/db/mixins"
 # if true, enables the read only mode
 $db_read_only_mode = false
 
-# = Database
+# = Db
+#
+# An efficient, yet simple Object-Relational Mapper. 
+#
+# == Features
+#
+# The library provides the following features:
+#
+# + Object-Relational mapping
+# + Deserialize to Ruby Objects or ResultSets
+# + Deserialize sql join queries to Ruby Objects
+# + Serialize arbitrary ruby object graphs through Marshal
+# + Connection pooling
+# + Thread safety
+# + SQL transactions
+# + Callbacks
+# + Simple support for cascading deletes
+# + Hierarchical structures (preorder traversal, materialized paths)
+# + Works safely as part of distributed application.
+# + Simple implementation < 10k lines of code.
+#
+# === Design
+#
+# Keep this class backend agnostic. Put backend specific code in
+# the Connection / Managed class.
+#
+# Try to make the methods work with oids. We do keep 
+# a unified id space. Include the N::Sequenced Marker to 
+# denote custom id space.
+# Do NOT implement descendants use a root id (rid).
+#
+# For class ids we use the name instead of a hash. Class ids are
+# typically not used in querys, they are stored for completeness.
+# If we store a hash we cannot reclaim the class thus invalidating
+# the point. Instead of .name(), to_s() is used so the methods
+# are more flexible (they accept class names too!!)
+#
+# Db allows the serialization of arbitrary Ruby objects. Just
+# mark them as Object (or Array or Hash) in the prop_accessor
+# and the engine will serialize a Marshal.dump of the object.
+# Arbitrary object graphs are supported too.
+# 
+# === Future 
+# 
+# * Support multiple DataBase backends (Postgres, MySQL, ...)
+# * Support prepared statements (pgsql)
+# * Support stored procedures (pgsql)
+# * Support caching
+# * Deserialize to OpenStruct
+# * Better documentation
+# * Code cleanup, refactoring
+# * Release as Gem, RPAbase
+# * Foreign keys (cascading delete)
 #
 # === Design:
 #
@@ -211,6 +226,7 @@ class Db
 	wrap_method :exec, "sql"
 	wrap_method :exec_and_clear, "sql"
 	wrap_method :exec_clear, "sql"
+	wrap_method :drop_table, "klass"	
 end
 
 end # module

data/lib/n/db/connection.rb

@@ -1,28 +1,8 @@
-# = Database Connection
-#
-# Encapsulates a database connection.
-#
-# === Design
-#
-# Try to make the methods to work with oids.
-# Do NOT implement descendants, use a root id (rid).
-#
-# === Todo
-#
-# - support caching
-# - support prepared statements
-# - foreign keys (delete cascade)
-# - keep attribudes as marshaled!!
-#
-# === Investigate
-#
-# - should we use retry_query ?
-#
 # code: 
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: connection.rb 79 2004-10-18 16:38:19Z gmosx $
+# $Id: connection.rb 99 2004-10-22 09:50:28Z gmosx $
 
 module N; 
 
@@ -34,6 +14,22 @@ require "n/utils/time"
 #
 # A Connection to the Database.
 #
+# === design
+#
+# try to make the methods to work with oids.
+# do not implement descendants, use a root id (rid).
+#
+# === todo
+#
+# - support caching
+# - support prepared statements
+# - foreign keys (delete cascade)
+# - keep attribudes as marshaled!!
+#
+# === investigate
+#
+# - should we use retry_query ?
+#
 class DbConnection
 	include N::DbUtils