trusty-multi-site-extension 1.0.0

data/db/migrate/001_create_sites.rb

@@ -0,0 +1,13 @@
+class CreateSites < ActiveRecord::Migration
+  def self.up
+    create_table :sites do |t|
+      t.column :name, :string
+      t.column :domain, :string
+      t.column :homepage_id, :integer
+    end
+  end
+
+  def self.down
+    drop_table :sites
+  end
+end

data/db/migrate/002_add_order_to_sites.rb

@@ -0,0 +1,9 @@
+class AddOrderToSites < ActiveRecord::Migration
+  def self.up
+    add_column :sites, :position, :integer, :default => 0
+  end
+  
+  def self.down
+    remove_column :sites, :position
+  end
+end

data/db/migrate/003_add_base_domain_to_sites.rb

@@ -0,0 +1,9 @@
+class AddBaseDomainToSites < ActiveRecord::Migration
+  def self.up
+    add_column :sites, :base_domain, :string
+  end
+  
+  def self.down
+    remove_column :sites, :base_domain
+  end
+end

data/db/migrate/004_add_admin_fields_to_sites.rb

@@ -0,0 +1,17 @@
+class AddAdminFieldsToSites < ActiveRecord::Migration
+  def self.up
+    add_column :sites, :created_by_id, :integer
+    add_column :sites, :created_at, :datetime
+    add_column :sites, :updated_by_id, :integer
+    add_column :sites, :updated_at, :datetime
+    add_column :sites, :subtitle, :string
+  end
+  
+  def self.down
+    remove_column :sites, :created_by_id
+    remove_column :sites, :created_at
+    remove_column :sites, :udpated_by_id
+    remove_column :sites, :updated_at
+    remove_column :sites, :subtitle
+  end
+end

data/db/migrate/005_add_sites.rb

@@ -0,0 +1,13 @@
+class AddSites < ActiveRecord::Migration
+  def self.up
+    [:layouts, :snippets, :users].each do |table|
+      add_column table, :site_id, :integer
+    end
+  end
+
+  def self.down
+    [:layouts, :snippets, :users].each do |table|
+      add_column table, :site_id, :integer
+    end
+  end
+end

data/db/migrate/006_remove_user_login_index.rb

@@ -0,0 +1,8 @@
+class RemoveUserLoginIndex < ActiveRecord::Migration
+  def self.up
+    remove_index "users", :name => "login"
+  end
+  
+  def self.down
+  end
+end

data/db/migrate/20090810145840_site_abbreviation.rb

@@ -0,0 +1,9 @@
+class SiteAbbreviation < ActiveRecord::Migration
+  def self.up
+    add_column :sites, :abbreviation, :string
+  end
+
+  def self.down
+    remove_column :sites, :abbreviation
+  end
+end

data/db/migrate/201411031415046078_recreate_non_unique_index_on_snippets_name.rb

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

data/lib/multi_site/admin_ui.rb

@@ -0,0 +1,46 @@
+# This is included into AdminUI and defines editing regions for the site administration pages.
+# Note that the AdminUI object is a singleton and it is not sufficient to add to its initialization routines: you also have to call load_default_site_regions on the admin singleton that has already been defined.
+
+module MultiSite::AdminUI
+
+ def self.included(base)
+   base.class_eval do
+
+      attr_accessor :site
+      alias_method :sites, :site
+      
+      protected
+
+        # The site-admin pages have these regions:
+        
+        # Edit view:
+        # * main: edit_header, edit_form
+        # * form: edit_name edit_domain edit_homepage
+        # * form_bottom: edit_timestamp edit_buttons
+
+        # Index view
+        # * thead: title_header domain_header basedomain_header modify_header order_header
+        # * tbody: title_cell domain_cell basedomain_cell modify_cell order_cell (repeating row)
+        # * bottom: new_button
+
+        def load_default_site_regions
+          OpenStruct.new.tap do |site|
+            site.edit = TrustyCms::AdminUI::RegionSet.new do |edit|
+              edit.main.concat %w{edit_header edit_form}
+              edit.form.concat %w{edit_name edit_domain edit_homepage}
+              edit.form_bottom.concat %w{edit_timestamp edit_buttons}
+            end
+            site.index = TrustyCms::AdminUI::RegionSet.new do |index|
+              index.thead.concat %w{title_header domain_header basedomain_header modify_header order_header}
+              index.tbody.concat %w{title_cell domain_cell basedomain_cell modify_cell order_cell}
+              index.bottom.concat %w{new_button}
+            end
+            site.remove = site.index
+            site.new = site.edit
+          end
+        end
+      
+    end
+  end
+end
+

data/lib/multi_site/application_controller_extensions.rb

@@ -0,0 +1,40 @@
+module MultiSite::ApplicationControllerExtensions
+
+  def current_site
+    Page.current_site
+  end
+
+  def current_site=(site=nil)
+    Page.current_site = site
+  end
+
+  # this is overridden in Admin::ResourceController to respond correctly
+  
+  def sited_model?
+    false
+  end
+
+
+  def set_site
+    true if self.current_site = discover_current_site
+  end
+
+  # chains will attach here
+
+  def discover_current_site
+    site_from_host
+  end
+
+  # and add more ways to determine the current site
+
+  def site_from_host
+    Site.find_for_host(request.host)
+  end
+
+  def self.included(base)
+    base.class_eval {
+      helper_method :current_site, :current_site=
+    }
+  end
+
+end

data/lib/multi_site/application_controller_filter_extensions.rb

@@ -0,0 +1,21 @@
+module MultiSite::ApplicationControllerFilterExtensions
+
+  def self.included(base)
+    base.class_eval {
+      prepend_before_filter :set_site
+      alias_method_chain :authenticate, :site
+    }
+  end
+
+protected
+
+  def authenticate_with_site
+    self.current_site = discover_current_site
+    authenticate_without_site
+  end
+
+  def set_site
+    true if self.current_site = discover_current_site
+  end
+
+end

data/lib/multi_site/engine.rb

@@ -0,0 +1,5 @@
+module MultiSite
+  class Engine < Rails::Engine
+    paths["app/helpers"] = []
+  end
+end

data/lib/multi_site/page_extensions.rb

@@ -0,0 +1,43 @@
+# Unlike other scoped classes, there is no site association in the Page class. Instead, Site has a homepage association and Page has some retrieval methods that turn a page request into site information.
+
+module MultiSite::PageExtensions
+  def self.included(base)
+    base.class_eval {
+      alias_method_chain :url, :sites
+      mattr_accessor :current_site
+      has_one :site, :foreign_key => "homepage_id", :dependent => :nullify
+    }
+    base.extend ClassMethods
+    class << base
+      def find_by_path(path, live=true)
+        root = homepage
+        raise Page::MissingRootPageError unless root
+        root.find_by_path(path, live)
+      end
+      def current_site
+        @current_site ||= Site.default
+      end
+      def current_site=(site)
+        @current_site = site
+      end
+    end
+  end
+  
+  module ClassMethods
+    def homepage
+      if current_site.is_a?(Site)
+        homepage = self.current_site.homepage
+      end
+      homepage ||= find_by_parent_id(nil)
+    end
+  end
+  
+  def url_with_sites
+    if parent
+      parent.child_url(self)
+    else
+      "/"
+    end
+  end
+  
+end

data/lib/multi_site/pages_controller_extensions.rb

@@ -0,0 +1,48 @@
+module MultiSite::PagesControllerExtensions
+  def self.included(base)
+    base.class_eval {
+      alias_method_chain :discover_current_site, :root
+      alias_method_chain :index, :site
+      alias_method_chain :continue_url, :site
+      alias_method_chain :remove, :back
+      responses.destroy.default do
+        return_url = session[:came_from]
+        session[:came_from] = nil
+        if model.class == Page
+          redirect_to return_url || admin_pages_url(:root => model.root.id)
+        else
+          redirect_to continue_url(params)
+        end
+      end
+    }
+  end
+
+  # for compatibility with the standard issue of multi_site, 
+  # a root parameter overrides other ways of setting site
+
+  def discover_current_site_with_root
+    site_from_root || discover_current_site_without_root
+  end
+
+  def site_from_root
+    if params[:root] && @homepage = Page.find(params[:root])
+      @site = @homepage.root.site
+    end
+  end
+
+  def index_with_site
+    @site ||= Page.current_site
+    @homepage ||= @site.homepage if @site
+    @homepage ||= Page.homepage
+    response_for :plural
+  end
+
+  def remove_with_back
+    session[:came_from] = request.env["HTTP_REFERER"]
+    remove_without_back
+  end
+  
+  def continue_url_with_site(options={})
+    options[:redirect_to] || (params[:continue] ? edit_admin_page_url(model) : admin_pages_url(:root => model.root.id))
+  end
+end

data/lib/multi_site/resource_controller_extensions.rb

@@ -0,0 +1,41 @@
+module MultiSite::ResourceControllerExtensions
+
+  def self.included(base)
+    base.class_eval {
+      alias_method_chain :discover_current_site, :input
+    }
+  end
+
+  def current_site=(site=nil)
+    Page.current_site = site
+    set_session_site
+  end
+  
+  # among other things this determines whether the site chooser is shown in the submenu
+
+  def sited_model?
+    model_class == Page || model_class.is_site_scoped?
+  end
+  
+protected
+
+  def discover_current_site_with_input
+    site_from_param || site_from_session || discover_current_site_without_input
+  end
+  
+  # for interface consistency we want to be able to remember site choices between requests
+  
+  def set_session_site(site_id=nil)
+    site_id ||= current_site.id.to_s if current_site.is_a? Site
+    session[:site_id] = site_id
+  end
+
+  def site_from_session
+    session[:site_id] && Site.find(session[:site_id]) rescue nil
+  end
+
+  def site_from_param
+    params[:site_id] && Site.find(params[:site_id]) rescue nil
+  end
+
+end

data/lib/multi_site/route_extensions.rb

@@ -0,0 +1,21 @@
+module MultiSite
+  module RouteExtensions
+
+    def self.included(base)
+      base.alias_method_chain(:recognition_conditions, :site)
+    end
+
+    def recognition_conditions_with_site
+      result = recognition_conditions_without_site
+      if site_names = conditions.delete(:site)
+        domains = [*site_names].map{ |site| Regexp.compile(::Site.find_by_name(site).domain) }
+        conditions[:site] = Regexp.union(*domains)
+        result << "conditions[:site] === env[:site]"
+      end
+      result
+    end
+
+  end
+end
+
+ActionController::Routing::Route.send :include, MultiSite::RouteExtensions

data/lib/multi_site/route_set_extensions.rb

@@ -0,0 +1,16 @@
+module MultiSite
+  module RouteSetExtensions
+
+    def self.included(base)
+      base.alias_method_chain :extract_request_environment, :site
+    end
+
+    def extract_request_environment_with_site(request)
+      env = extract_request_environment_without_site(request)
+      env.merge! :site => request.host
+    end
+
+  end
+end
+
+ActionController::Routing::RouteSet.send :include, MultiSite::RouteSetExtensions

data/lib/multi_site/scoped_model.rb

@@ -0,0 +1,145 @@
+module MultiSite
+  
+  module ScopedModel
+    def self.included(base)
+      base.extend ClassMethods
+    end
+  
+    module ClassMethods
+      def is_site_scoped?
+        false
+      end
+      
+      # only option at the moment is :shareable, which we take to mean that sites are optional:
+      # if true it causes us not to set the site automatically or to validate its presence,
+      # and to extend the scoping conditions so that objects with no site are returned as 
+      # well as objects with the specified site
+      # that is, anything without a site is considered to be shared among all sites
+      # the default is false
+      
+      def is_site_scoped(options={})
+        return if is_site_scoped?
+        
+        options = {
+          :shareable => false
+        }.merge(options)
+
+        class_eval <<-EO
+          extend MultiSite::ScopedModel::ScopedClassMethods
+          include MultiSite::ScopedModel::ScopedInstanceMethods
+        EO
+        
+        belongs_to :site
+        Site.send(:has_many, plural_symbol_for_class)
+
+        before_validation :set_site
+        validates_presence_of :site unless options[:shareable]
+
+        class << self
+          attr_accessor :shareable
+          alias_method_chain :all, :site
+          alias_method_chain :where, :site
+          alias_method_chain :paginate, :site
+          %w{count average minimum maximum sum}.each do |getter|
+            alias_method_chain getter.intern, :site
+          end
+        end
+        
+        self.shareable = options[:shareable]
+      end
+    end
+
+    module ScopedClassMethods
+      def all_with_site(options = {})
+        return all_without_site(options) unless sites?
+        with_scope(:find => {:conditions => site_scope_condition}) do
+          all_without_site(options)
+        end
+      end
+
+      def where_with_site(options = {})
+        return where_without_site(options) unless sites?
+        with_scope(:find => {:conditions => site_scope_condition}) do
+          where_without_site(options)
+        end
+      end
+
+      def paginate_with_site(options={})
+        return paginate_without_site(options) unless sites?
+        with_scope(:find => {:conditions => site_scope_condition}) do
+          paginate_without_site(options)
+        end
+      end
+
+      %w{count average minimum maximum sum}.each do |getter|
+        define_method("#{getter}_with_site") do |*args|
+          return send("#{getter}_without_site".intern, *args) unless sites?
+          with_scope(:find => {:conditions => site_scope_condition}) do
+            send "#{getter}_without_site".intern, *args
+          end
+        end
+      end
+      
+      # this only works with :all and :first
+      # and should only be used in odd cases like migration.
+      def find_without_site(*args)
+        options = args.extract_options!
+        #set_readonly_option!(options)
+
+        case args.first
+          when :first then find_initial_without_site(options)     # defined here
+          when :all   then all_without_site(options)       # already defined by the alias chain
+        end
+      end
+      
+      def find_initial_without_site(options)
+        options.update(:limit => 1)
+        all_without_site(options).first
+      end
+      
+      def sites?
+        Site.table_exists? && Site.several?
+      end
+
+      def current_site!
+        raise(ActiveRecord::SiteNotFound, "#{self} is site-scoped but current_site is #{self.current_site.inspect}", caller) if sites? && !self.current_site && !self.is_shareable?
+        self.current_site
+      end
+
+      def current_site
+        Page.current_site
+      end
+            
+      def site_scope_condition
+        if self.shareable
+          condition = ""
+          condition << "#{self.table_name}.site_id = #{self.current_site.id} OR " if self.current_site
+          condition << "#{self.table_name}.site_id IS NULL" 
+        else
+          condition = "#{self.table_name}.site_id = #{self.current_site!.id}"
+        end
+        condition
+      end
+    
+      def plural_symbol_for_class
+        self.to_s.pluralize.underscore.intern
+      end
+      
+      def is_site_scoped?
+        true
+      end
+
+      def is_shareable?
+        !!self.shareable
+      end
+    end
+  
+    module ScopedInstanceMethods
+      protected
+        def set_site
+          self.site ||= self.class.current_site! unless self.class.is_shareable?
+        end
+    end
+  end
+end
+

data/lib/multi_site/scoped_validation.rb

@@ -0,0 +1,32 @@
+module MultiSite::ScopedValidation
+
+  def self.included(base)
+
+    base.class_eval do
+      # scoping validations to the site should be very simple 
+      # all you would normally need is something like this:
+      #
+      #   validates_uniqueness_of :email, :scope => :site_id
+      #
+      # but if you want to scope core trusty classes, you have a problem:
+      # their uniqueness validations have already been declared
+      # The only answer is to reach right back and change the validates_uniqueness_of method
+      # and to make it more awkward, that has to happen so early that we can't reflect on the site association.
+      # Hence the check for a site_id column. It's a hack, but a fairly harmless one.
+
+      def validates_uniqueness_of_with_site(*attr)
+        if table_exists? && column_names.include?('site_id')
+          configuration = attr.extract_options!
+          configuration[:scope] ||= :site_id
+          attr.push(configuration)
+        end
+        validates_uniqueness_of_without_site(*attr)
+      end
+
+      alias_method_chain :validates_uniqueness_of, :site
+    end
+    
+  end
+end
+
+ActiveRecord::Validations::ClassMethods.send :include, MultiSite::ScopedValidation

data/lib/multi_site/site_chooser_helper.rb

@@ -0,0 +1,14 @@
+module MultiSite::SiteChooserHelper
+
+def sites_chooser_thing
+  return "" unless admin? && defined?(Site) && defined?(controller) && controller.sited_model? && controller.template_name == 'index' && Site.several?
+  options = Site.find(:all).map{ |site| "<li>" + link_to( site.name, "#{request.path}?site_id=#{site.id}", :class => site == current_site ? 'fg' : '') + "</li>" }.join("")
+  chooser = %{<div id="site_chooser">}
+  #chooser << link_to("sites", admin_sites_url, {:id => 'show_site_list', :class => 'expandable'})
+  chooser << %{<ul id="nav"><li>Current Site: #{current_site.name}}
+  chooser << %{<ul class="expansion">#{options}</ul></li></ul>}
+  chooser << %{</div>}
+  chooser
+end
+
+end

data/lib/multi_site/site_controller_extensions.rb

@@ -0,0 +1,12 @@
+module MultiSite::SiteControllerExtensions
+  def self.included(base)
+    base.class_eval do
+      before_filter :set_site
+    end
+  end
+  
+  def set_site
+    Page.current_site = Site.find_for_host(request.host)
+    true
+  end
+end

data/lib/tasks/multi_site_extension_tasks.rake

@@ -0,0 +1,28 @@
+namespace :trusty do
+  namespace :extensions do
+    namespace :multi_site do
+      
+      desc "Runs the migration of the Multi Site extension"
+      task :migrate => :environment do
+        require 'trusty_cms/extension_migrator'
+        if ENV["VERSION"]
+          MultiSiteExtension.migrator.migrate(ENV["VERSION"].to_i)
+        else
+          MultiSiteExtension.migrator.migrate
+        end
+      end
+      
+      desc "Copies public assets of the Multi Site to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from MultiSiteExtension"
+        Dir[MultiSiteExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(MultiSiteExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+      end  
+    end
+  end
+end

data/lib/tasks/scoped_admin_extension_tasks.rake

@@ -0,0 +1,28 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :scoped_admin do
+      
+      desc "Runs the migration of the Scoped Admin extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          ScopedAdminExtension.migrator.migrate(ENV["VERSION"].to_i)
+        else
+          ScopedAdminExtension.migrator.migrate
+        end
+      end
+      
+      desc "Copies public assets of the Scoped Admin to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from ScopedAdminExtension"
+        Dir[ScopedAdminExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(ScopedAdminExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory
+          cp file, RAILS_ROOT + path
+        end
+      end  
+    end
+  end
+end

data/lib/trusty-multi-site-extension.rb

@@ -0,0 +1 @@
+# Nothing to see here