YurtCMS 0.2.0

data/README

@@ -0,0 +1,18 @@
+== Welcome to Yurt CMS
+
+Yurt CMS is a content management system designed for web developers who create 
+mostly static web sites.  In building this software, I tried to realize the
+following key features:
+
+	* No Database: Content for mostly static sites should reside in editable 
+		files, not databases.
+	* Version Control System Friendly: The web site should be easy to store 
+		in a revision control system.
+	* Two-step deployment: Starting a new website should be as easy as running a
+		single command in the console and updating your webserver configuration.
+	* One-step go-live: Yurt CMS websites can be deployed simply by rsync'ing or 
+		copying from the preview webroot to the live webroot.
+	* Web-based *and* console-based admin interfaces: Work where you're most
+		comfortable!
+	
+

data/bin/yurt

@@ -0,0 +1,282 @@
+#! /usr/bin/env ruby
+
+
+# == Synopsis
+# 
+# A simple commandline tool for basic site management
+# 
+# == Usage
+#    
+#  yurt newsite  foldername [port] <- creates a new directory structure for a 
+#                                     Yurt CMS site, with a preconfigured 
+#                                     apache conf file
+#  yurt newfile    path/to/file   <- creates a new content file
+#  yurt update     [path/to/file] <- updates yurt infrastructure to latest 
+#                                    version. path/to/file is optional if you're
+#                                    in the top level directory of your yurt 
+#                                    install
+#  yurt newpartial path/to/file   <- creates a new partial content file
+#  yurt generate   path/to/file   <- generates html from supplied content file
+#  yurt delete     path/to/file   <- deletes content file and html files
+# 
+# == Author
+# 
+# Robert Hahn <yurt_at_roberthahn_dot_ca>
+# 
+# == Copyright
+# 
+# Copyright (c)2006 Robert Hahn.  Licensed under the same terms as the Camping framework
+# 
+
+require File.dirname( __FILE__ ) + "/../lib/yurtcms"
+require 'rdoc/usage'
+require 'rbconfig.rb'
+include Config
+
+# this is needed to support the generate() function
+class Hash
+	def method_missing(methID)
+		self[methID.id2name]
+	end
+end
+
+
+
+def newsite yurt_root, port
+	# create directory
+	Dir.mkdir yurt_root
+
+	# copy template from CONFIG["datadir"]/yurt/dir_template.zip
+	source_files = Dir.glob( File.dirname( __FILE__ ) + "/../site/**/*" )
+
+	source_files.each do |sf|
+		local_f = [ yurt_root, sf.gsub( /^.*?site\//, "" ) ].join( "/" )
+		case File.stat( sf ).ftype
+		when "directory"
+			Dir.mkdir local_f
+			File.chmod( 0777, local_f )
+		when "file"
+			source = File.read( sf )
+
+			# if the file we read in is yurt.conf, we need to modify it to point to the web root.
+			if File.basename( sf ) == "yurt.conf"
+				source.gsub!( /<%= port %>/, port )
+				source.gsub!( /<%= yurt_root %>/, yurt_root )
+				local_f.gsub!( /yurt\.conf/, File.basename( yurt_root ) + ".conf" )
+			end
+
+			writefile( source,local_f )
+		end
+	end
+
+	# write out a preferences file
+
+	writefile( "yurt_root: " + yurt_root, yurt_root + "/yurt.prefs" )
+end
+	
+def update yurt_root
+
+	# copy template from CONFIG["datadir"]/yurt/dir_template.zip
+	source_files = Dir.glob( File.dirname( __FILE__ ) + "/../site/yurt/**/*" )
+
+	source_files.each do |sf|
+		local_f = [ yurt_root, sf.gsub( /^.*?site\//, "" ) ].join( "/" )
+		case File.stat( sf ).ftype
+		when "directory"
+			begin
+				Dir.mkdir local_f
+			rescue SystemCallError => e
+				unless e.errno == Errno::EEXIST::Errno
+					exit
+				end
+			end
+			File.chmod( 0777, local_f )
+		when "file"
+			source = File.read( sf )
+			writefile( source,local_f )
+		end
+	end
+end
+
+def writefile sf_str, df
+	File.open( df, "w" ) do |dest|
+		dest.puts sf_str
+	end
+	File.chmod( 0777, df )
+end
+
+def normalize_path path
+	# This wasn't something that could easily be done, as I realized there was 
+	# a number of situations that could legitimately occur.   The following comment
+	# block will describe the logic required:
+	#
+	# 1. Is the supplied #{ path } absolute (begins with "/")?
+	#
+	# - if 1., then test 2.
+	# - if not 1., compute final path by concatenating cwd to #{ path }, call it 
+	# 	full_path, then test 2.
+
+	if path[0,1] != "/"
+		# it's a relative path
+		path = [ Dir.getwd, path ].join( "/" )
+	end
+
+	# 2. Can I chdir to full_path?
+	#
+	# - If 2., getwd, then use it to locate yurt.prefs, then test 3.
+	# - If not 2, raise an error (destination not valid)
+	
+	begin
+		Dir.chdir( File.dirname( path ) )
+		path = [ Dir.getwd, File.basename( path ) ].join( "/" )
+	rescue Exception => e
+		puts e.message
+		exit 1
+	end
+
+	# The following yield statement allows for implementation-specific tests to 
+	# validate the path
+	yield path if block_given?
+
+	return path
+end
+
+def find_yurt_pref full_path
+	fp = full_path
+	yurt_root = nil
+	if File.exists? [ fp, "yurt.prefs" ].join( "/" )
+		yurt_root = fp
+	else
+		puts fp
+		while fp.include? "/content"
+			fp = fp.gsub( /content\/.*?$/, "" )
+			if File.exists? [ fp, "yurt.prefs" ].join( "/" )
+				yurt_root = fp
+				break
+			end
+		end
+	end
+
+	return yurt_root
+end
+
+def newfile path
+	# create file
+	File.open( path, "w" ) do |f|
+		f.puts "---"
+		f.puts "template: template.html"
+		f.puts "title: enter page title"
+		f.puts "description: enter page meta description content"
+		f.puts "keywords: enter keywords here"
+		f.puts "content: |-"
+		f.puts "  Enter your content here. Please ensure that you begin each new line with two spaces while in this area."
+	end
+	File.chmod( 0777, path )
+end
+
+def newpartial path
+	# create file
+	File.open( path, "w" ) do |f|
+		f.puts "---"
+		f.puts "partial: yes"
+		f.puts "content: |-"
+		f.puts "  Enter your content here. Please ensure that you begin each new line with two spaces while in this area."
+	end
+	File.chmod( 0777, path )
+end
+
+def get_yurt_path_pieces path
+	path = normalize_path path do |p|
+		# Is the computed path in #{ yurt_root }/content, and does a yurt.prefs file exist?
+		unless ( p.include? "/content" ) && find_yurt_pref( p )
+			puts "Not a valid yurt CMS web path - the file must be in /content, and a yurt.prefs file must be present."
+			exit 1
+		end
+		# are we about to generate a file?
+		#unless File.exists?( p ) && File.ftype( p ) == "file"
+		#	puts "Not a valid yurt CMS file.  If you need to generate a file, please check your path."
+		#	exit 1
+		#end
+	end
+
+	yurt_root = find_yurt_pref( path )
+
+	file_to_generate = path
+	file_to_generate[ yurt_root + "content/" ] = ''
+	return [ yurt_root, file_to_generate ]
+end
+
+def generate yurt_root, file_to_generate
+	y = YurtCMS.new( yurt_root )
+
+	y.write_all_files( y.get_file_metadata( file_to_generate ) )
+end
+
+def delete yurt_root, file_to_generate
+	y = YurtCMS.new( yurt_root )
+	y.delete( file_to_generate )
+end
+
+def mkdir yurt_root, file_to_generate
+	y = YurtCMS.new( yurt_root )
+	y.make_new_dir( File.dirname( file_to_generate ), File.basename( file_to_generate ) )
+end
+
+case
+when ARGV[0] == "newsite"
+	# check for and collect folder name
+	yurt_root = normalize_path ARGV[ 1 ]
+
+	port = "9878"
+	port = ARGV[ 2 ] if ARGV[ 2 ] && ARGV[ 2 ].match( /^\d*$/ )
+
+	newsite( yurt_root, port )
+when ARGV[0] == "update"
+	if ARGV[ 1 ]
+		yurt_root = find_yurt_pref ARGV[ 1 ]
+	else
+		yurt_root = find_yurt_pref Dir.getwd
+	end
+	update yurt_root
+when ARGV[0] == "newfile"
+	# check for a path/to/file
+	path = normalize_path ARGV[ 1 ] do |p|
+		# Is the computed path in #{ yurt_root }/content, and does a yurt.prefs file exist?
+		unless ( p.include? "/content" ) && find_yurt_pref( p )
+			puts "Not a valid yurt CMS web path - the file must be in /content, and a yurt.prefs file must be present."
+			exit 1
+		end
+	end
+
+	newfile( path )
+when ARGV[0] == "newpartial"
+	# check for a path/to/file
+	path = normalize_path ARGV[ 1 ] do |p|
+		# Is the computed path in #{ yurt_root }/content, and does a yurt.prefs file exist?
+		unless ( p.include? "/content" ) && find_yurt_pref( p )
+			puts "Not a valid yurt CMS web path - the file must be in /content, and a yurt.prefs file must be present."
+			exit 1
+		end
+	end
+
+	newpartial( path )
+when ARGV[0] == "generate"
+	# check for a path/to/file
+	yurt_root, file_to_generate = get_yurt_path_pieces( ARGV[1] )
+
+	generate( yurt_root, file_to_generate )
+when ARGV[0] == "mkdir"
+	# check for a path/to/file
+	yurt_root, file_to_generate = get_yurt_path_pieces( ARGV[1] )
+
+	mkdir( yurt_root, file_to_generate )
+when ARGV[0] == "delete"
+	# check for a path/to/file
+	yurt_root, file_to_generate = get_yurt_path_pieces( ARGV[1] )
+
+	delete( yurt_root, file_to_generate )
+else
+	RDoc::usage
+end
+
+

data/lib/yurtcms.rb

@@ -0,0 +1,175 @@
+
+	require 'yaml'
+
+	class YurtCMS
+		attr_reader :data_store, :web_root, :includes, :metatags, :partial, :ext
+		def initialize yurt_root
+			require 'rubygems'
+			require_gem 'BlueCloth'
+
+			@yurt_root = sanitize_path( yurt_root )
+			@data_store = [ @yurt_root, "content/" ].join
+			@web_root = [ @yurt_root, "htdocs/" ].join
+			@includes = [ @web_root, "includes/content/" ].join
+			@metatags = ".metatags"
+			@partial = ".partial"
+			@ext = ".html"
+		end
+		
+		def merge path, file
+			[ path, '/', file ].join.gsub( /\/\/*/, "/" )
+		end
+		
+		def path_to_orig_content path
+			[ @data_store, path ].join
+		end
+		
+		def path_to_metatags path
+			[ @includes, path, @metatags, @ext ].join
+		end
+		
+		def path_to_content path
+			[ @includes, path, @ext ].join
+		end
+		
+		def path_to_placeholder path
+			[ @web_root, path, @ext].join
+		end
+		
+		def get_dir_listing path
+		 	@contents = Hash.new
+			Dir.chdir( path_to_orig_content( path ) ) do
+				Dir.foreach(".") do |entry|
+					@contents[entry] = [ File.ftype(entry) ] unless ( entry =~ /^\./ or entry =~ /~$/ )
+				end
+			end
+
+			@contents
+		end
+
+		def sanitize_path path
+			if path == ""
+				"/"
+			else 
+				path.gsub!( /^\//, '' )
+				path.gsub!( /\/$/, '' )
+				[ '/', path, '/' ].join.gsub( /\/\/*/,"/" )
+			end
+		end
+		
+		def sanitize_filename f
+			f.gsub!(/^\//, "")
+			f.gsub!(/[^\w\.\-]/, "_")
+			
+			f
+		end
+
+		def make_new_dir path, name
+			p = merge( path, sanitize_filename( name ) )
+
+			Dir.mkdir( [ @data_store, p ].join )
+			Dir.mkdir( [ @includes, p ].join )
+			Dir.mkdir( [ @web_root, p ].join )
+
+			File.chmod( 0777, [ @data_store, p ].join )
+			File.chmod( 0777, [ @includes, p ].join )
+			File.chmod( 0777, [ @web_root, p ].join )
+		end
+		
+		def make_content_as_yaml input
+			content = Hash.new
+			if input.partial == "y"
+				content[ "partial" ] = input.partial
+			else
+				content[ "title" ] = input.title
+				content[ "description" ] = input.description
+				content[ "keywords" ] = input.keywords
+				content[ "template" ] = input.template
+			end
+			content[ "content" ] = input.content
+
+			content.to_yaml
+		end
+
+		def make_metatags input
+			t = [ '<!--#set var="TITLE" value="', input.title, '" -->', "\n" ].join if input.title =~ /\w/
+			d = [ '<!--#set var="DESCRIPTION" value="', input.description, '" -->', "\n" ].join if input.description =~ /\w/
+			k = [ '<!--#set var="KEYWORDS" value="', input.keywords, '" -->', "\n" ].join if input.keywords =~ /\w/
+
+			[ t, d, k ].join
+		end
+		
+		def parse_content c
+			BlueCloth.new(c).to_html
+		end
+		
+		def make_placeholder path, template
+			if template == nil or template == ""
+				template = "template.html"
+			end
+
+			[
+				'<!--#set var="PAGE" value="',
+				path,
+				'" -->',
+				"\n",
+				'<!--#include virtual="/includes/',
+				template,
+				'" -->',
+				"\n"
+			].join
+		end
+		
+		def delete obj
+			f = path_to_orig_content( obj )
+
+			if File.exists?( f )
+				if File.ftype( f ) == "directory"
+					Dir.delete( f )
+					[ :path_to_content,
+						:path_to_placeholder ].each do |p|
+						f = send( p, obj ).gsub(/\.html/, '')
+						Dir.delete( f )
+					end
+				else
+					File.delete( f )
+					[ :path_to_metatags,
+						:path_to_content,
+						:path_to_placeholder ].each do |p|
+						f = send( p, obj )
+						File.delete( f )
+					end
+				end
+			end
+		end
+		
+		def get_file_metadata path
+			metadata = YAML.load( File.open( path_to_orig_content( path ) ) )
+			metadata[ "filename" ] = File.basename( path_to_orig_content( path ) )
+			metadata[ "path" ] = File.dirname( path )
+			
+			metadata
+		end
+		
+		def write_file path, contents
+			f = File.new( path, "w" )
+				f.puts contents
+			f.close
+			begin
+				File.chmod(0776,path) 
+			rescue 
+			end
+		end
+
+		def write_all_files input
+			path = merge( input.path, sanitize_filename( input.filename ) )
+
+			write_file( path_to_orig_content( path ), make_content_as_yaml( input ) )
+			write_file( path_to_placeholder( path ), make_placeholder( path, input.template ) )
+			write_file( path_to_content( path ), parse_content( input.content ) )
+
+			if input.partial != "y"
+				write_file( path_to_metatags( path ), make_metatags( input ) )
+			end
+		end
+	end

data/site/content/index

@@ -0,0 +1,14 @@
+--- 
+title: ""
+description: ""
+content: |-
+  # Congratulations! #
+  
+  You have successfully completed a Yurt CMS installation!  At this point you have a few possible next steps in building your site:
+  
+  * Designing a new template to use with this site
+  * Setting up and pouring in the content through the [web interface](/yurt/)
+  * Setting up and pouring in content in your terminal app.
+  
+  (Help files to come)
+keywords: ""

data/site/htdocs/includes/content/index.html

@@ -0,0 +1,11 @@
+<h1>Congratulations!</h1>
+
+<p>You have successfully completed a Yurt CMS installation!  At this point you have a few possible next steps in building your site:</p>
+
+<ul>
+<li>Designing a new template to use with this site</li>
+<li>Setting up and pouring in the content through the <a href="/yurt/">web interface</a></li>
+<li>Setting up and pouring in content in your terminal app.</li>
+</ul>
+
+<p>(Help files to come)</p>

data/site/htdocs/includes/content/index.metatags.html

@@ -0,0 +1 @@
+

data/site/htdocs/includes/template.html

@@ -0,0 +1,22 @@
+<!--#include virtual="/includes/template.metatags.html" -->
+<!--#include virtual="/includes/content/${PAGE}.metatags.html" -->
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+	<head>
+		<title><!--#echo var="TITLE" --></title>
+		<meta name="keywords" content="<!--#echo var="KEYWORDS" -->" />
+		<meta name="description" content="<!--#echo var="DESCRIPTION" -->" />
+		<meta http-equiv="content-type" content="text/html; charset=utf-8" /> 
+		<link rel="stylesheet" type="text/css" href="/media/css/styles.css" />
+		<script type="text/javascript" language="javascript" src="/media/js/prototype.js"></script>
+	</head>
+	<body>
+		<img src="/yurt/media/images/admin_head.jpg" width="481" height="79" border="0" alt="yurt: a content management system" id="header_img" />
+
+		<div id="main">
+			<!--#include virtual="/includes/content/${PAGE}.html" -->
+		</div>
+	</body>
+</html>

data/site/htdocs/includes/template.metatags.html

@@ -0,0 +1,4 @@
+<!--#set var="TITLE" value="Yurt CMS site" -->
+<!--#set var="DESCRIPTION" value="This is a fresh Yurt CMS installation. Please change the generic site metatags!" -->
+<!--#set var="KEYWORDS" value="yurt cms" -->
+

data/site/htdocs/index.html

@@ -0,0 +1,2 @@
+<!--#set var="PAGE" value="/index" -->
+<!--#include virtual="/includes/template.html" -->

data/site/htdocs/media/css/styles.css

@@ -0,0 +1,106 @@
+					body {
+						margin: 0;
+						padding: 0;
+						background-color: #eeeeea;
+						background-image: url("/yurt/media/images/admin_bg.gif");
+						background-position: top left;
+						background-repeat: repeat-x;
+						font-size: 100%;
+					}
+
+					#header_img {
+						position: absolute;
+						margin: 0;
+						padding: 0;
+					}
+
+					#menu {
+						padding: 0;
+						position: absolute;
+						margin-left: 50px;
+						margin-top: 100px;
+						width: 220px;
+						font-size: 0.8em;
+						font-family: arial, sans-serif;
+					}
+
+					#menu ul {
+						margin: 0;
+						padding: 0;
+						font-size: 1.0em;
+						margin-bottom: 1.0em;
+						list-style: none;
+					}
+
+					#menu li {
+						margin: 0;
+						margin-bottom: 0.3em;
+						padding: 0;
+					}
+
+					#menu a {
+						text-decoration: none;
+					}
+
+					#menu a:hover {
+						text-decoration: underline;
+					}
+
+					#main {
+						padding: 0;
+						position: absolute;
+						margin-left: 285px;
+						margin-top: 100px;
+						width: 600px;
+						font-size: 1.0em;
+						font-family: optima, arial, sans-serif;
+						line-height: 1.3em;
+					}
+
+					#main h1 {
+						margin: 0;
+						padding: 0;
+						font-size: 1.4em;
+						margin-bottom: 0.3em;
+					}
+
+					#main h2 {
+						margin: 0;
+						padding: 0;
+						font-size: 1.2em;
+						margin-bottom: 0.2em;
+					}
+
+					#main h3 {
+						margin: 0;
+						padding: 0;
+						font-size: 1.1em;
+						margin-bottom: 0.2em;
+					}
+
+					#main h4, #main h5, #main h6 {
+						margin: 0;
+						padding: 0;
+						font-size: 1.0em;
+					}
+
+					#main p {
+						margin: 0;
+						padding: 0;
+						font-size: 1.0em;
+						margin-bottom: 1.0em;
+						text-indent: 2em;
+					}
+
+					#main ul {
+						margin: 0;
+						padding: 0;
+						padding-left: 2em;
+						font-size: 1.0em;
+						margin-bottom: 1.0em;
+						list-style: square;
+					}
+
+					#main li {
+						margin-bottom: 0.3em;
+					}