instiki/app/models/web.rb

217 lines
5.4 KiB
Ruby
Raw Normal View History

2007-01-22 14:43:50 +01:00
class Web < ActiveRecord::Base
## Associations
2009-08-29 20:33:09 +02:00
has_many :pages, :dependent => :destroy
has_many :wiki_files, :dependent => :destroy
2007-01-22 14:43:50 +01:00
has_many :revisions, :through => :pages
## Hooks
before_save :sanitize_markup
after_save :create_files_directory
before_validation :validate_address
## Validations
validates_uniqueness_of :address
validates_length_of :color, :in => 3..6
## Methods
2009-09-06 02:47:48 +02:00
# @return [Wiki] a new Wiki instance
2007-01-22 14:43:50 +01:00
def wiki
Wiki.new
end
2009-08-29 20:33:09 +02:00
2007-01-22 14:43:50 +01:00
def settings_changed?(markup, safe_mode, brackets_only)
self.markup != markup ||
self.safe_mode != safe_mode ||
self.brackets_only != brackets_only
end
2009-08-29 20:33:09 +02:00
2007-01-22 14:43:50 +01:00
def add_page(name, content, time, author, renderer)
page = page(name) || pages.build(:name => name)
page.revise(content, name, time, author, renderer)
2007-01-22 14:43:50 +01:00
end
2009-08-29 20:33:09 +02:00
# @return [Array<String>] a collection of all the names of the authors that
# have ever contributed to the pages for this Web
2007-01-22 14:43:50 +01:00
def authors
revisions.all(
:select => "DISTINCT revisions.author",
:order => "1"
).collect(&:author)
2007-01-22 14:43:50 +01:00
end
def categories
select.map { |page| page.categories }.flatten.uniq.sort
end
# @param [String] name the name of some associated Page record to find
# @return [Page, nil] the associated Page record, or +nil+ if no record is
# found with the provided name
2007-01-22 14:43:50 +01:00
def page(name)
pages.find_by_name(name)
2007-01-22 14:43:50 +01:00
end
2009-08-29 20:33:09 +02:00
# @return [Page] the last associated Page record
2007-01-22 14:43:50 +01:00
def last_page
pages.last
2007-01-22 14:43:50 +01:00
end
2009-08-29 22:54:50 +02:00
# @param [String] name the name of some potential Page record
# @return [Boolean] whether or not a given Page record exists with a given
# name
2007-01-22 14:43:50 +01:00
def has_page?(name)
2009-08-29 22:54:50 +02:00
pages.exists?(:name => name)
2007-01-22 14:43:50 +01:00
end
2009-08-29 20:33:09 +02:00
def has_redirect_for?(name)
WikiReference.page_that_redirects_for(self, name)
end
def page_that_redirects_for(name)
page(WikiReference.page_that_redirects_for(self, name))
end
2007-01-22 14:43:50 +01:00
def has_file?(file_name)
wiki_files.exists?(:file_name => file_name)
2007-01-22 14:43:50 +01:00
end
2009-08-29 20:33:09 +02:00
def file_list(sort_order="file_name")
wiki_files.all(:order => sort_order)
end
2007-01-22 14:43:50 +01:00
def pages_that_link_to(page_name)
WikiReference.pages_that_link_to(self, page_name)
end
def pages_that_link_to_file(file_name)
WikiReference.pages_that_link_to_file(self, file_name)
end
# @param [String] file_name the name of some WikiFile of interest
# @return [String, nil] the description of some WikiFile of interest, nil if
# the WikiFile could not be found
def description(file_name)
wiki_files.find_by_file_name(file_name).try(:description)
end
# @return [Symbol] the type of markup used by this Web
2007-01-22 14:43:50 +01:00
def markup
self[:markup].to_sym
2007-01-22 14:43:50 +01:00
end
# @return [Hash] a Hash wherein the key is some author's name, and the
# values are an array of page names for that author.
2007-01-22 14:43:50 +01:00
def page_names_by_author
data = revisions.all(
:select => "DISTINCT revisions.author AS author, pages.name AS page_name",
:order => "pages.name"
)
data.inject({}) do |result, revision|
result[revision.author] ||= []
result[revision.author] << revision.page_name
result
end
2007-01-22 14:43:50 +01:00
end
2009-09-06 02:47:48 +02:00
# OPTIMIZE Use the +delete_all+ with conditions for extra efficiency
2007-01-22 14:43:50 +01:00
def remove_pages(pages_to_be_removed)
pages_to_be_removed.each { |p| p.destroy }
end
2009-08-29 20:33:09 +02:00
2007-01-22 14:43:50 +01:00
def revised_at
select.most_recent_revision
end
2009-08-29 20:33:09 +02:00
2007-01-22 14:43:50 +01:00
def select(&condition)
PageSet.new(self, pages, condition)
end
2009-08-29 20:33:09 +02:00
2007-01-22 14:43:50 +01:00
def select_all
PageSet.new(self, pages, nil)
end
2009-08-29 20:33:09 +02:00
2009-09-06 02:47:48 +02:00
# @return [String] uses the +address+ attribute for this record's parameter name
2007-01-22 14:43:50 +01:00
def to_param
address
end
2009-08-29 20:33:09 +02:00
# Called by an +after_save+ hook. Creates the directory that houses this
# Web's associated files.
#
# TODO Move this into the WikiFile model
2007-01-22 14:43:50 +01:00
def create_files_directory
return unless allow_uploads == 1
dummy_file = wiki_files.build(
:file_name => "0",
:description => "0",
:content => "0"
)
File.umask(0002)
2007-01-22 14:43:50 +01:00
begin
dummy_file.content_path.parent.mkpath
2007-01-22 14:43:50 +01:00
dummy_file.save
dummy_file.destroy
rescue => e
logger.error "Failed create files directory for #{address}: #{e}"
2007-01-22 14:43:50 +01:00
raise "Instiki could not create directory to store uploaded files. " +
"Please make sure that Instiki is allowed to create directory " +
"#{dummy_file.content_path.expand_path} and add files to it."
2007-01-22 14:43:50 +01:00
end
end
2009-09-06 02:47:48 +02:00
# @return [Pathname] the path to the files for this record
def files_path
path = Rails.root.join("webs")
if default_web?
path.join("files")
else
path.join(address, "files")
end
end
2009-09-06 02:47:48 +02:00
# @return [Pathname] the path to PNGs for this record
def blahtex_pngs_path
files_path.join("pngs")
end
2007-01-22 14:43:50 +01:00
private
# Returns an array of all the wiki words in any current revision
def wiki_words
pages.inject([]) { |wiki_words, page| wiki_words << page.wiki_words }.flatten.uniq
end
2009-08-29 20:33:09 +02:00
2007-01-22 14:43:50 +01:00
# Returns an array of all the page names on this web
def page_names
pages.map { |p| p.name }
end
2009-08-29 20:33:09 +02:00
2007-01-22 14:43:50 +01:00
protected
2009-08-29 20:33:09 +02:00
2007-01-22 14:43:50 +01:00
def sanitize_markup
self.markup = markup.to_s
end
2009-08-29 20:33:09 +02:00
2007-01-22 14:43:50 +01:00
def validate_address
unless address == CGI.escape(address)
self.errors.add(:address, 'should contain only valid URI characters')
raise Instiki::ValidationError.new("#{self.class.human_attribute_name('address')} #{errors.on(:address)}")
end
end
2009-08-29 20:33:09 +02:00
2009-08-31 07:12:13 +02:00
# @return [Boolean] whether or not this record is considered the default Web
2007-01-22 14:43:50 +01:00
def default_web?
2009-08-31 07:12:13 +02:00
defined?(DEFAULT_WEB) && address == DEFAULT_WEB
2007-01-22 14:43:50 +01:00
end
end