radiant-vhost-extension 2.1.0

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/scoped_access"]
+	path = vendor/scoped_access
+	url = git://github.com/maiha/scoped_access.git

data/README

@@ -0,0 +1,64 @@
+Host multiple separate websites on the same Radiant installation each with their 
+own users, pages, snippets and layouts (soon to be supporting other extensions).  
+Administer users and sites from any domain using your administrative accounts 
+and manage website content by logging into each domain.
+
+IMPORTANT NOTES ABOUT VHOST
+- Not compatible with the multi_site extension
+- Uses the scoped_access plugin, make sure none of your extensions have a 
+  conflicting version of the plugin.
+- Hooks into the Radiant 'bootstrap' functionality and currently overwrites the
+  standard templates with a modified version of the Simple Blog (i.e. no Styled
+  Blog or Coffee template)
+
+INSTRUCTIONS
+Currently (April 26th, 2009) you need the freshest version of Radiant (0.7.1) 
+which includes Rails 2.2.2 to run vhost. The following instructions use git
+to directly check out the latest version of Radiant so you may need to adjust
+them slightly. Once the Radiant gem supports Rails 2.2.2 these instructions
+will reflect the proper way to run and install vhost.
+
+* Run 'git clone git://github.com/radiant/radiant.git yoursite'
+* In /yoursite run:
+  * git submodule init
+  * git submodule update
+* Create production, development and test database schemas
+* Update /yoursite/config/database.yml to point to the schemas
+* In /yoursite/vendor/extensions run:
+  * git clone git://github.com/saturnflyer/radiant-vhost-extension.git vhost
+* In /yoursite/vendor/extensions/vhost run:
+  * git submodule init
+  * git submodule update
+* In /yoursite run:
+  * rake development db:bootstrap
+  * rake db:test:clone_structure (this one may be unnecessary)
+  * rake db:test:clone
+* Finally, in /yoursite run:
+  * rake spec:extensions EXT=vhost
+
+You should see a number of spec examples running and passing. If you don't, 
+or they're failing, something has gone wrong!
+
+VHOST SUPPORT FOR OTHER EXTENSIONS
+Vhost support for other extensions is enabled by creating a /config/vhost.yml
+file containing the names of the models that should be scoped down per site. If
+site scoping for an extension cannot be specified through the model (i.e. it
+uses the file system to present data or otherwise doesn't use an ActiveRecord)
+then currently you cannot enable site scoping.
+
+Example vhost.yml:
+
+models:
+ # Class name
+ ManagedFile: 
+   # Property requiring definition of validates_uniqueness_of
+   filename: 
+     # Parameters to pass to validates_uniqueness_of
+     scope: 
+       - site_id
+     message:
+       'file name is already in use'
+   # Any classes used in Single Table Inheritance(STI)
+   sti_classes:
+     - OneClass
+     - TwoClass

data/Rakefile

@@ -0,0 +1,125 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-vhost-extension"
+    gem.summary = %Q{Vhost Extension for Radiant CMS}
+    gem.description = %Q{Host more than one site in a single instance of Radiant.}
+    gem.email = "jim@saturnflyer.com"
+    gem.homepage = "http://github.com/saturnflyer/radiant-vhost-extension"
+    gem.authors = ["Jason Garber",'Kaleb Walton', 'Jim Gay']
+    gem.add_development_dependency "radiant"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package vhost as a gem."
+end
+
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+if defined? RADIANT_ROOT
+  rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+  $LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+end
+
+require 'spec/rake/spectask'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the vhost extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'VhostExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the vhost extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/VERSION

@@ -0,0 +1 @@
+2.1.0

data/app/controllers/admin/sites_controller.rb

@@ -0,0 +1,16 @@
+class Admin::SitesController < Admin::ResourceController
+  only_allow_access_to :index, :show, :new, :create, :edit, :update, :remove, :destroy, :switch_to,
+    :when => :site_admin,
+    :denied_url => { :controller => 'pages', :action => 'index' },
+    :denied_message => 'You must have administrative privileges to perform this action.'
+    
+  def switch_to
+    site = Site.find(params[:id])
+    if site
+      redirect_to "http://#{site.hostname}#{request.port.to_s == '80' ? '' : ":#{request.port}"}/admin"
+    else
+      render :index
+    end 
+  end
+
+end

data/app/models/site.rb

@@ -0,0 +1,26 @@
+class Site < ActiveRecord::Base
+  has_and_belongs_to_many :users
+  has_many :pages
+  
+  accepts_nested_attributes_for :users
+  VhostExtension.MODELS.each do |model|
+    has_many model.tableize.to_sym unless model.tableize.match(/pages|users/) # unless already defined
+  end
+  
+  def allow_access_for(user)
+    # Site Admins can access all sites. Users can only access sites to which they belong
+    user.site_admin? || self.users.include?(user)
+  end
+  
+  def homepage
+    self.pages.find(:first, :conditions => {:parent_id => nil})
+  end
+
+  def self.find_by_hostname(hostname)
+    # allow vhost to be added to existing sites
+    if Site.count == 0
+      Site.create!(:hostname => hostname)
+    end
+    self.find(:first, :conditions => ["hostname LIKE ?", "%#{hostname}%"])
+  end
+end

data/app/models/site_association_observer.rb

@@ -0,0 +1,8 @@
+class SiteAssociationObserver < ActiveRecord::Observer
+  observe *VhostExtension::SITE_SPECIFIC_MODELS.collect(&:constantize)
+  
+  def before_validation(model)
+    # Set the site_id automatically if it's not already set 
+    model.site_id ||= model.class.current_site.id
+  end
+end

data/app/views/admin/sites/_form.html.haml

@@ -0,0 +1,19 @@
+- form_for [:admin, @site] do |f|
+  = render_region :form_top
+  .form-area
+    - render_region :form do |form|
+      - form.edit_hostname do
+        %p.hostname
+          %label{:for=>"site_hostname"} Hostname
+          = f.text_field "hostname", :class => 'textbox', :maxlength => 100
+      - form.edit_users do
+        %p.users
+          %label{:for=>"site_users"} Users
+          = f.collection_select :user_ids, User.find(:all), :id, :name, {}, :multiple => true, :name => 'site[user_ids][]', :size => '10'
+  - render_region :form_bottom do |form_bottom|
+    - form_bottom.edit_buttons do
+      %p.buttons
+        = save_model_button(@site)
+        = save_model_and_continue_editing_button(@site)
+        or
+        = link_to 'Cancel', admin_sites_url

data/app/views/admin/sites/edit.html.haml

@@ -0,0 +1,5 @@
+- render_region :main do |main|
+  - main.edit_header do
+    %h1 Edit Site
+  - main.edit_form do
+    = render :partial => 'form'

data/app/views/admin/sites/index.html.haml

@@ -0,0 +1,24 @@
+.outset
+  %table#sites.index{:cellpadding=>"0", :cellspacing=>"0", :border=>"0"}
+    %thead
+      %tr
+        %th.hostname Host
+        %th Administration
+        %th.users Users
+        %th.modify Modify
+    %tbody
+      - unless @sites.empty?
+        - for site in @sites
+          %tr.node.level-1
+            %td.site
+              = link_to site.hostname, edit_admin_site_url(:id => site)
+            %td.site
+              = link_to 'Go', switch_to_admin_site_url(site)
+            %td.users= site.users.collect(&:name).join(', ')
+            %td.remove= link_to('Remove Site', remove_admin_site_url(:id => site))
+      - else
+        %tr
+          %td.note{:colspan=>3} No Sites
+#actions
+  %ul
+    %li= link_to 'New Site', new_admin_site_url

data/app/views/admin/sites/new.html.haml

@@ -0,0 +1,5 @@
+- render_region :main do |main|
+  - main.edit_header do
+    %h1 New Site
+  - main.edit_form do
+    = render :partial => 'form'

data/app/views/admin/sites/remove.html.haml

@@ -0,0 +1,19 @@
+%h1 Remove Site
+
+%p 
+  Are you sure you want to 
+  %strong.warning permanently remove
+  the following site?
+
+%table.index#sites{:cellpadding=>0, :cellspacing=>0, :border=>0}
+  %tbody
+    %tr.node.level-1
+      %td.site 
+        = image('page', :alt => "page-icon")
+        = @site.hostname
+
+- form_for [:admin, @site], :html => {:method => :delete} do
+  %p.buttons
+    %input.button{:type=>"submit", :value=>"Delete Site"}/
+    or
+    = link_to 'Cancel', admin_sites_url

data/app/views/admin/users/_edit_sites.html.haml

@@ -0,0 +1,4 @@
+- if current_user.site_admin?
+  %p
+    = f.label :site_ids, 'Sites', :class => "optional"
+    ~ f.collection_select :site_ids, current_user.site_admin? ? Site.find(:all) : current_user.sites, :id, :hostname, {}, :multiple => true, :name => 'user[site_ids][]', :size => '10', :class => "textarea"

data/app/views/admin/users/_site_admin_roles.html.haml

@@ -0,0 +1,5 @@
+- if current_user.site_admin?
+  %p
+    = f.check_box "site_admin", :class => "checkbox"
+    = f.label :site_admin, 'Site admin', :class => "checkbox"
+    A site admin can make changes to all sites.

data/app/views/admin/users/_sites_td.html.haml

@@ -0,0 +1,2 @@
+- if current_user.site_admin?
+  %td.sites= sites(user)

data/app/views/admin/users/_sites_th.html.haml

@@ -0,0 +1,2 @@
+- if current_user.site_admin?
+  %th Sites

data/config/routes.rb

@@ -0,0 +1,5 @@
+ActionController::Routing::Routes.draw do |map|
+  map.namespace :admin, :member => { :remove => :get } do |admin|
+    admin.resources :sites, :member => {:switch_to => :get}
+  end
+end

data/db/migrate/001_create_sites.rb

@@ -0,0 +1,11 @@
+class CreateSites < ActiveRecord::Migration
+  def self.up
+    create_table :sites do |t|
+      t.column :hostname, :string
+    end
+  end
+
+  def self.down
+    drop_table :sites
+  end
+end

data/db/migrate/002_add_sites_users.rb

@@ -0,0 +1,18 @@
+class AddSitesUsers < ActiveRecord::Migration
+  def self.up
+    create_table :sites_users, :id => false do |t|
+      t.column :site_id, :integer
+      t.column :user_id, :integer
+    end
+    
+    add_index :sites_users, [:site_id, :user_id], :unique => true
+    add_index :sites_users, :user_id
+  end
+  
+  
+  def self.down
+    remove_index :sites_users, [:site_id, :user_id]
+    remove_index :sites_users, :user_id
+    drop_table :sites_users
+  end
+end

data/db/migrate/003_replace_snippet_name_unique_index.rb

@@ -0,0 +1,10 @@
+class ReplaceSnippetNameUniqueIndex < ActiveRecord::Migration
+  def self.up
+    remove_index :snippets, :name => :name
+  end
+  
+  
+  def self.down
+    add_index "snippets", ["name"], :name => "name", :unique => true
+  end
+end

data/db/migrate/004_add_site_admin_to_users.rb

@@ -0,0 +1,9 @@
+class AddSiteAdminToUsers < ActiveRecord::Migration
+  def self.up
+    add_column :users, :site_admin, :boolean
+  end
+
+  def self.down
+    remove_column :users, :site_admin
+  end
+end

data/db/templates/empty.yml

@@ -0,0 +1,7 @@
+name: Empty
+description: Don't create any pages, layouts, or snippets.
+records:
+  Sites:
+    main:
+      id: 1
+      hostname: '*'

data/db/templates/simple-blog.yml

@@ -0,0 +1,213 @@
+name: Simple Blog
+description: Setup Radiant as a simple weblog.
+records:
+  Sites:
+    main:
+      id: 1
+      hostname: '*'
+  Layouts:
+    main:
+      id: 1
+      site_id: 1
+      name: Normal
+      content: |
+        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+          "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+        <html>
+          <head>
+            <title><r:title /></title>
+            <link href="/rss/" rel="alternate" title="RSS" type="application/rss+xml" />
+            <link rel="stylesheet" type="text/css" href="/styles.css" />
+          </head>
+          <body>
+            <r:snippet name="header" />
+            <div id="content">
+              <r:content />
+              <div id="extended">
+                <r:content part="extended" />
+              </div>
+            </div>
+            <r:snippet name="footer" />
+          </body>
+        </html>
+    css:
+      id: 2
+      site_id: 1
+      name: Stylesheet
+      content_type: text/css
+      content: |
+        <r:content />
+    xml_feed:
+      id: 3
+      site_id: 1
+      name: XML Feed
+      content_type: text/xml
+      content: |
+        <r:content />
+  Snippets:
+    header:
+      id: 1
+      site_id: 1
+      name: header
+      content: |
+        <div id="header">
+          <h1><r:title /></h1>
+        </div>
+        <hr />
+    footer:
+      id: 2
+      site_id: 1
+      name: footer
+      content: |
+        <hr />
+        <div id="footer">
+          <p>Powered by <a href="http://radiantcms.org/">Radiant CMS</a></p>
+        </div>
+  Pages:
+    home_page:
+      id: 1
+      site_id: 1
+      title: Home Page
+      breadcrumb: Home
+      slug: /
+      layout_id: 1
+      status_id: 100
+    file_not_found:
+      id: 2
+      site_id: 1
+      title: File Not Found
+      breadcrumb: File Not Found
+      slug: file-not-found
+      class_name: FileNotFoundPage
+      parent_id: 1
+      status_id: 100
+    rss_feed:
+      id: 3
+      site_id: 1
+      title: RSS Feed
+      breadcrumb: RSS Feed
+      slug: rss
+      layout_id: 3
+      parent_id: 1
+      status_id: 100
+    articles:
+      id: 4
+      site_id: 1
+      title: Articles
+      breadcrumb: Articles
+      slug: articles
+      class_name: ArchivePage
+      parent_id: 1
+      status_id: 100
+    first_post:
+      id: 5
+      site_id: 1
+      title: First Post
+      breadcrumb: First Post
+      slug: first-post
+      parent_id: 4
+      status_id: 100
+    second_post:
+      id: 6
+      site_id: 1
+      title: Second Post
+      breadcrumb: Second Post
+      slug: second-post
+      parent_id: 4
+      status_id: 100
+    styles:
+      id: 7
+      site_id: 1
+      title: Styles
+      breadcrumb: Styles
+      slug: styles.css
+      parent_id: 1
+      layout_id: 2
+      status_id: 100
+  PageParts:
+    home_page:
+      id: 1
+      name: body
+      page_id: 1
+      content: |
+        <r:find url="/articles/">
+        <r:children:each limit="5" order="desc">
+        <div class="entry">
+          <h3><r:link /> <small><r:author /></small></h3>
+          <r:content />
+          <r:if_content part="extended"><r:link anchor="extended">Continue Reading&#8230;</r:link></r:if_content>
+        </div>
+        </r:children:each>
+        </r:find>
+    file_not_found:
+      id: 2
+      name: body
+      page_id: 2
+      filter_id: Textile
+      content: |
+        The file you were looking for could not be found.
+
+        Attempted URL: @<r:attempted_url />@
+
+        It is possible that you typed the URL incorrectly or that you clicked on a bad link.
+
+        "<< Back to Home Page":/
+    rss_feed:
+      id: 3
+      name: body
+      page_id: 3
+      content: |
+        <?xml version="1.0" encoding="UTF-8"?>
+        <rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/">
+          <channel>
+            <title>Article RSS Feed</title>
+            <link>http://your-web-site.com<r:url /></link>
+            <language>en-us</language>
+            <ttl>40</ttl>
+            <description>The main blog feed for my Web site.</description>
+            <r:find url="/articles/">
+            <r:children:each limit="10">
+                <item>
+                  <title><r:title /></title>
+                  <description><r:escape_html><r:content /></r:escape_html></description>
+                  <pubDate><r:rfc1123_date /></pubDate>
+                  <guid>http://your-web-site.com<r:url /></guid>
+                  <link>http://your-web-site.com<r:url /></link>
+                </item>
+            </r:children:each>
+            </r:find>
+          </channel>
+        </rss>
+    articles:
+      id: 4
+      name: body
+      page_id: 4
+      content: |
+        <ul>
+        <r:children:each order="desc">
+          <li><r:link /></li>
+        </r:children:each>
+        </ul>
+    first_post:
+      id: 5
+      name: body
+      page_id: 5
+      filter_id: Textile
+      content: |
+        This post uses "textile":http://www.textism.com/tools/textile/.
+    second_post:
+      id: 6
+      name: body
+      page_id: 6
+      filter_id: Markdown
+      content: |
+        This post uses **Markdown**.
+    styles:
+      id: 7
+      name: body
+      page_id: 7
+      content: |
+        body {
+          font-family: "Trebuchet MS", Arial, Helvetica, sans-serif;
+          font-size: 80%;
+        }