publify_core 9.0.0.pre1

data/app/models/article.rb

@@ -0,0 +1,321 @@
+# coding: utf-8
+require 'uri'
+require 'net/http'
+
+class Article < Content
+  include PublifyGuid
+  include ConfigManager
+
+  serialize :settings, Hash
+
+  content_fields :body, :extended
+
+  validates :guid, uniqueness: true
+  validates :title, presence: true
+
+  has_many :pings, dependent: :destroy
+  has_many :trackbacks, dependent: :destroy
+  has_many :feedback
+  has_many :resources, dependent: :nullify
+  has_many :triggers, as: :pending_item
+  has_many :comments, dependent: :destroy
+
+  has_and_belongs_to_many :tags, join_table: 'articles_tags'
+
+  before_create :create_guid
+  before_save :set_published_at, :set_permalink
+  after_save :post_trigger, :keywords_to_tags, :shorten_url
+  after_save :send_pings
+  after_save :send_notifications
+
+  scope :drafts, -> { where(state: 'draft').order('created_at DESC') }
+  scope :child_of, ->(article_id) { where(parent_id: article_id) }
+  scope :published_at, ->(time_params) { published.where(published_at: PublifyTime.delta(*time_params)).order('published_at DESC') }
+  scope :published_since, ->(time) { published.where('published_at > ?', time).order('published_at DESC') }
+  scope :withdrawn, -> { where(state: 'withdrawn').order('published_at DESC') }
+  scope :pending, -> { where('state = ? and published_at > ?', 'publication_pending', Time.now).order('published_at DESC') }
+
+  scope :bestof, lambda {
+    joins(:feedback).
+      where('feedback.published' => true, 'feedback.type' => 'Comment',
+            'contents.published' => true).
+      group('contents.id').
+      order('count(feedback.id) DESC').
+      select('contents.*, count(feedback.id) as comment_count').
+      limit(5)
+  }
+
+  setting :password, :string, ''
+
+  attr_accessor :draft, :keywords
+
+  include Article::States
+
+  has_state(:state, valid_states: [:new, :draft,
+                                   :publication_pending, :just_published, :published,
+                                   :just_withdrawn, :withdrawn],
+                    initial_state: :new,
+                    handles: [:withdraw,
+                              :post_trigger,
+                              :send_pings, :send_notifications,
+                              :published_at=, :published=, :just_published?])
+
+  def set_permalink
+    return if state == 'draft' || permalink.present?
+    self.permalink = title.to_permalink
+  end
+
+  def has_child?
+    Article.exists?(parent_id: id)
+  end
+
+  def post_type
+    post_type = self[:post_type]
+    post_type = 'read' if post_type.blank?
+    post_type
+  end
+
+  def self.last_draft(article_id)
+    article = Article.find(article_id)
+    article = Article.child_of(article.id).first while article.has_child?
+    article
+  end
+
+  def self.search_with(params)
+    params ||= {}
+    scoped = super(params)
+    if %w(no_draft drafts published withdrawn pending).include?(params[:state])
+      scoped = scoped.send(params[:state])
+    end
+
+    scoped.order('created_at DESC')
+  end
+
+  # FIXME: Use keyword params to clean up call sites.
+  def permalink_url(anchor = nil, only_path = false)
+    @cached_permalink_url ||= {}
+    @cached_permalink_url["#{anchor}#{only_path}"] ||= blog.url_for(permalink_url_options, anchor: anchor, only_path: only_path)
+  end
+
+  def save_attachments!(files)
+    files ||= {}
+    files.values.each { |f| save_attachment!(f) }
+  end
+
+  def save_attachment!(file)
+    resources.create!(upload: file, blog: blog)
+  end
+
+  def trackback_url
+    blog.url_for("trackbacks?article_id=#{id}", only_path: false)
+  end
+
+  def comment_url
+    blog.url_for("comments?article_id=#{id}", only_path: true)
+  end
+
+  def preview_comment_url
+    blog.url_for("comments/preview?article_id=#{id}", only_path: true)
+  end
+
+  def feed_url(format)
+    "#{permalink_url}.#{format.gsub(/\d/, '')}"
+  end
+
+  def really_send_pings
+    return unless blog.send_outbound_pings
+
+    blog.urls_to_ping_for(self).each do |url_to_ping|
+      begin
+        url_to_ping.send_weblogupdatesping(blog.base_url, permalink_url)
+      rescue => e
+        logger.error(e)
+        # in case the remote server doesn't respond or gives an error,
+        # we should throw an xmlrpc error here.
+      end
+    end
+
+    html_urls_to_ping.each do |url_to_ping|
+      begin
+        url_to_ping.send_pingback_or_trackback(permalink_url)
+      rescue => e
+        logger.error(e)
+        # in case the remote server doesn't respond or gives an error,
+        # we should throw an xmlrpc error here.
+      end
+    end
+  end
+
+  def next
+    Article.where('published_at > ?', published_at).order('published_at asc').limit(1).first
+  end
+
+  def previous
+    Article.where('published_at < ?', published_at).order('published_at desc').limit(1).first
+  end
+
+  def self.publication_months
+    result = select('published_at').where('published_at is not NULL').where(type: 'Article')
+    result.map { |d| [d.published_at.strftime('%Y-%m')] }.uniq
+  end
+
+  # Finds one article which was posted on a certain date and matches the supplied dashed-title
+  # params is a Hash
+  def self.requested_article(params)
+    date_range = PublifyTime.delta(params[:year], params[:month], params[:day])
+
+    req_params = {}
+    req_params[:permalink] = params[:title] if params[:title]
+    req_params[:published_at] = date_range if date_range
+
+    return if req_params.empty? # no search if no params send
+    article = published.find_by(req_params)
+    return article if article
+
+    if params[:title]
+      req_params[:permalink] = CGI.escape(params[:title])
+      article = published.find_by(req_params)
+      return article if article
+    end
+  end
+
+  # Fulltext searches the body of published articles
+  def self.search(query, args = {})
+    query_s = query.to_s.strip
+    if !query_s.empty? && args.empty?
+      Article.searchstring(query)
+    elsif !query_s.empty? && !args.empty?
+      Article.searchstring(query).page(args[:page]).per(args[:per])
+    else
+      []
+    end
+  end
+
+  def keywords_to_tags
+    Tag.create_from_article!(self)
+  end
+
+  def interested_users
+    User.where(notify_on_new_articles: true)
+  end
+
+  def notify_user_via_email(user)
+    EmailNotify.send_article(self, user) if user.notify_via_email?
+  end
+
+  def comments_closed?
+    !(allow_comments? && in_feedback_window?)
+  end
+
+  def html_urls
+    urls = []
+    html.gsub(/<a\s+[^>]*>/) do |tag|
+      if tag =~ /\bhref=(["']?)([^ >"]+)\1/
+        urls.push(Regexp.last_match[2].strip)
+      end
+    end
+    urls.uniq
+  end
+
+  def pings_closed?
+    !(allow_pings? && in_feedback_window?)
+  end
+
+  # check if time to comment is open or not
+  def in_feedback_window?
+    blog.sp_article_auto_close.zero? ||
+      published_at.to_i > blog.sp_article_auto_close.days.ago.to_i
+  end
+
+  def content_fields
+    [:body, :extended]
+  end
+
+  # The web interface no longer distinguishes between separate "body" and
+  # "extended" fields, and instead edits everything in a single edit field,
+  # separating the extended content using "\<!--more-->".
+  def body_and_extended
+    if extended.blank?
+      body
+    else
+      body + "\n<!--more-->\n" + extended
+    end
+  end
+
+  # Split apart value around a "\<!--more-->" comment and assign it to our
+  # #body and #extended fields.
+  def body_and_extended=(value)
+    parts = value.split(/\n?<!--more-->\n?/, 2)
+    self.body = parts[0]
+    self.extended = parts[1] || ''
+  end
+
+  def password_protected?
+    !password.blank?
+  end
+
+  def add_comment(params)
+    comments.build(params)
+  end
+
+  def access_by?(user)
+    user.admin? || user_id == user.id
+  end
+
+  def already_ping?(url)
+    pings.map(&:url).include?(url)
+  end
+
+  def allow_comments?
+    return allow_comments unless allow_comments.nil?
+    blog.default_allow_comments
+  end
+
+  def allow_pings?
+    return allow_pings unless allow_pings.nil?
+    blog.default_allow_pings
+  end
+
+  def published_comments
+    comments.published.oldest_first
+  end
+
+  def published_trackbacks
+    trackbacks.published.oldest_first
+  end
+
+  def published_feedback
+    feedback.published.oldest_first
+  end
+
+  protected
+
+  def set_published_at
+    if published && self[:published_at].nil?
+      self[:published_at] = created_at || Time.now
+    end
+  end
+
+  private
+
+  def permalink_url_options
+    format_url = blog.permalink_format.dup
+    format_url.gsub!('%year%', published_at.year.to_s)
+    format_url.gsub!('%month%', sprintf('%.2d', published_at.month))
+    format_url.gsub!('%day%', sprintf('%.2d', published_at.day))
+    format_url.gsub!('%title%', URI.encode(permalink.to_s))
+    if format_url[0, 1] == '/'
+      format_url[1..-1]
+    else
+      format_url
+    end
+  end
+
+  def html_urls_to_ping
+    urls_to_ping = []
+    html_urls.delete_if { |url| already_ping?(url) }.uniq.each do |url_to_ping|
+      urls_to_ping << pings.build('url' => url_to_ping)
+    end
+    urls_to_ping
+  end
+end

data/app/models/blog.rb

@@ -0,0 +1,290 @@
+# The Blog class represents the one and only blog.  It stores most
+# configuration settings and is linked to most of the assorted content
+# classes via has_many.
+#
+# Once upon a time, there were plans to make publify handle multiple blogs,
+# but it never happened and publify is now firmly single-blog.
+#
+class Blog < ActiveRecord::Base
+  include ConfigManager
+  include Rails.application.routes.url_helpers
+
+  has_many :contents
+  has_many :articles
+  has_many :feedback, through: :articles
+
+  has_many(:published_articles,
+           ->() { includes(:tags).where(published: true).order('contents.published_at DESC') },
+           class_name: 'Article')
+
+  has_many :pages
+  has_many :tags
+  has_many :notes
+
+  has_many :redirects
+  has_many :sidebars, ->() { order('active_position ASC') }
+
+  attr_accessor :custom_permalink
+
+  default_scope -> { order('id') }
+
+  validates :blog_name, presence: true
+
+  serialize :settings, Hash
+
+  # Description
+  setting :blog_name, :string, 'My Shiny Weblog!'
+  setting :blog_subtitle, :string, ''
+  setting :geourl_location, :string, ''
+  setting :canonical_server_url, :string, '' # Deprecated
+  setting :lang, :string, 'en_US'
+  setting :title_prefix, :integer, 0 # Deprecated but needed for a migration
+
+  # Spam
+  setting :sp_global, :boolean, false
+  setting :sp_article_auto_close, :integer, 0
+  setting :sp_url_limit, :integer, 0
+  setting :sp_akismet_key, :string, ''
+  setting :use_recaptcha, :boolean, false
+
+  # Mostly Behaviour
+  setting :text_filter, :string, 'markdown smartypants'
+  setting :comment_text_filter, :string, 'markdown smartypants'
+  setting :limit_article_display, :integer, 10
+  setting :limit_archives_display, :integer, 20
+  setting :limit_rss_display, :integer, 10
+  setting :default_allow_pings, :boolean, false
+  setting :default_allow_comments, :boolean, true
+  setting :default_moderate_comments, :boolean, false
+  setting :link_to_author, :boolean, false
+  setting :show_extended_on_rss, :boolean, true # deprecated but still needed for backward compatibility
+  setting :hide_extended_on_rss, :boolean, false
+  setting :theme, :string, 'plain'
+  setting :plugin_avatar, :string, ''
+  setting :global_pings_disable, :boolean, false
+  setting :ping_urls, :string, "http://blogsearch.google.com/ping/RPC2\nhttp://rpc.technorati.com/rpc/ping\nhttp://ping.blo.gs/\nhttp://rpc.weblogs.com/RPC2"
+  setting :send_outbound_pings, :boolean, true
+  setting :email_from, :string, 'publify@example.com'
+  setting :allow_signup, :integer, 0
+  setting :date_format, :string, '%d/%m/%Y'
+  setting :time_format, :string, '%Hh%M'
+  setting :image_avatar_size, :integer, 48
+  setting :image_thumb_size, :integer, 125
+  setting :image_medium_size, :integer, 600
+
+  # SEO
+  setting :meta_description, :string, ''
+  setting :meta_keywords, :string, ''
+  setting :google_analytics, :string, ''
+  setting :feedburner_url, :string, ''
+  setting :rss_description, :boolean, false
+  setting :rss_description_text, :string, <<EOS
+<hr />
+<p><small>Original article written by %author% and published on <a href='%blog_url%'>%blog_name%</a>
+| <a href='%permalink_url%'>direct link to this article</a>
+| If you are reading this article anywhere other than on <a href='%blog_url%'>%blog_name%</a>,
+  it has been illegally reproduced and without proper authorization.</small></p>
+EOS
+  setting :permalink_format, :string, '/%year%/%month%/%day%/%title%'
+  setting :robots, :string, 'User-agent: *\nAllow: /\nDisallow: /admin\n'
+  setting :humans, :string, <<EOS
+/* TEAM */
+Your title: Your name.
+Site: email, link to a contact form, etc.
+Twitter: your Twitter username.
+
+/* SITE */
+Software: Publify [http://publify.co] #{PublifyCore::VERSION}
+EOS
+  setting :index_categories, :boolean, true # deprecated but still needed for backward compatibility
+  setting :unindex_categories, :boolean, false
+  setting :index_tags, :boolean, true # deprecated but still needed for backward compatibility
+  setting :unindex_tags, :boolean, false
+  setting :admin_display_elements, :integer, 10
+  setting :google_verification, :string, ''
+  setting :nofollowify, :boolean, true # deprecated but still needed for backward compatibility
+  setting :dofollowify, :boolean, false
+  setting :use_canonical_url, :boolean, false
+  setting :use_meta_keyword, :boolean, true
+  setting :home_title_template, :string, '%blog_name% | %blog_subtitle%' # spec OK
+  setting :home_desc_template, :string, '%blog_name% | %blog_subtitle% | %meta_keywords%' # OK
+  setting :article_title_template, :string, '%title% | %blog_name%'
+  setting :article_desc_template, :string, '%excerpt%'
+  setting :page_title_template, :string, '%title% | %blog_name%'
+  setting :page_desc_template, :string, '%excerpt%'
+  setting :paginated_title_template, :string, '%blog_name% | %blog_subtitle% %page%'
+  setting :paginated_desc_template, :string, '%blog_name% | %blog_subtitle% | %meta_keywords% %page%'
+  setting :tag_title_template, :string, 'Tag: %name% | %blog_name% %page%'
+  setting :tag_desc_template, :string, '%name% | %blog_name% | %blog_subtitle% %page%'
+  setting :author_title_template, :string, '%author% | %blog_name%'
+  setting :author_desc_template, :string, '%author% | %blog_name% | %blog_subtitle%'
+  setting :archives_title_template, :string, 'Archives for %blog_name% %date% %page%'
+  setting :archives_desc_template, :string, 'Archives for %blog_name% %date% %page% %blog_subtitle%'
+  setting :search_title_template, :string, 'Results for %search% | %blog_name% %page%'
+  setting :search_desc_template, :string, 'Results for %search% | %blog_name% | %blog_subtitle% %page%'
+  setting :statuses_title_template, :string, 'Notes | %blog_name% %page%'
+  setting :statuses_desc_template, :string, 'Notes | %blog_name% | %blog_subtitle% %page%'
+  setting :status_title_template, :string, '%body% | %blog_name%'
+  setting :status_desc_template, :string, '%excerpt%'
+
+  setting :custom_tracking_field, :string, ''
+  # setting :meta_author_template,       :string, "%blog_name% | %nickname%"
+
+  setting :twitter_consumer_key, :string, ''
+  setting :twitter_consumer_secret, :string, ''
+  setting :custom_url_shortener, :string, ''
+  setting :statuses_in_timeline, :boolean, true
+
+  validate :permalink_has_identifier
+  # validates :base_url, presence: true
+
+  # Find the Blog that matches a specific base URL. If no Blog object is found
+  # that matches, then grab the first blog. If *that* fails, then create a new
+  # Blog. The last case should only be used when Publify is first installed.
+  def self.find_blog(base_url)
+    Blog.find_by(base_url: base_url) || Blog.first || Blog.new
+  end
+
+  # In settings with :article_id
+  def ping_article!(settings)
+    unless global_pings_enabled? && settings.key?(:url) && settings.key?(:article_id)
+      throw :error, 'Invalid trackback or trackbacks not enabled'
+    end
+    article = Article.find(settings[:article_id])
+    throw :error, 'Trackback not saved' unless article.allow_pings?
+    article.trackbacks.create!(settings)
+  end
+
+  def global_pings_enabled?
+    !global_pings_disable?
+  end
+
+  # Check that all required blog settings have a value.
+  def configured?
+    settings.key?('blog_name')
+  end
+
+  # The +Theme+ object for the current theme.
+  def current_theme(reload = nil)
+    @current_theme = nil if reload
+    @current_theme ||= Theme.find(theme) || Theme.new('', '')
+  end
+
+  # Generate a URL based on the +base_url+.  This allows us to generate URLs
+  # without needing a controller handy, so we can produce URLs from within models
+  # where appropriate.
+  #
+  # It also caches the result in the Rails cache, so repeated URL generation
+  # requests should be fast, as they bypass all of Rails' route logic.
+  def url_for_with_base_url(options = {}, extra_params = {})
+    case options
+    when String
+      url_generated = if extra_params[:only_path]
+                        root_path
+                      else
+                        base_url
+                      end
+      url_generated += "/#{options}" # They asked for 'url_for "/some/path"', so return it unedited.
+      url_generated += "##{extra_params[:anchor]}" if extra_params[:anchor]
+      url_generated
+    when Hash
+      merged_opts = options.reverse_merge!(only_path: false, controller: '',
+                                           action: 'permalink',
+                                           host: host_with_port,
+                                           script_name: root_path)
+      cache_key = merged_opts.values.prepend('blog-urlfor-withbaseurl').join('-')
+      unless Rails.cache.exist?(cache_key)
+        Rails.cache.write(cache_key, url_for_without_base_url(merged_opts))
+      end
+      Rails.cache.read(cache_key)
+    else
+      raise "Invalid URL in url_for: #{options.inspect}"
+    end
+  end
+
+  alias_method_chain :url_for, :base_url
+
+  # The URL for a static file.
+  # FIXME: Let carrierwave handle this by itself
+  def file_url(filename)
+    if CarrierWave.configure { |config| config.storage == CarrierWave::Storage::Fog }
+      filename
+    else
+      url_for "files/#{filename}", only_path: false
+    end
+  end
+
+  def articles_matching(query, args = {})
+    Article.search(query, args)
+  end
+
+  def per_page(format)
+    return limit_article_display if format.nil? || format == 'html'
+    limit_rss_display
+  end
+
+  def rss_limit_params
+    limit = limit_rss_display.to_i
+    if limit.zero?
+      {}
+    else
+      { limit: limit }
+    end
+  end
+
+  def permalink_has_identifier
+    unless permalink_format =~ /(%title%)/
+      errors.add(:base, I18n.t('errors.permalink_need_a_title'))
+    end
+
+    if permalink_format =~ /\.(atom|rss)$/
+      errors.add(:permalink_format, I18n.t('errors.cant_end_with_rss_or_atom'))
+    end
+  end
+
+  def root_path
+    split_base_url[:root_path]
+  end
+
+  def text_filter_object
+    TextFilter.find_or_default(text_filter)
+  end
+
+  def urls_to_ping_for(article)
+    urls_to_ping = []
+    ping_urls.gsub(/ +/, '').split(/[\n\r]+/).map(&:strip).delete_if { |u| article.already_ping?(u) }.uniq.each do |url|
+      urls_to_ping << article.pings.build('url' => url)
+    end
+    urls_to_ping
+  end
+
+  def has_twitter_configured?
+    return false if twitter_consumer_key.nil? || twitter_consumer_secret.nil?
+    return false if twitter_consumer_key.empty? || twitter_consumer_secret.empty?
+    true
+  end
+
+  def allow_signup?
+    allow_signup == 1
+  end
+
+  def shortener_url
+    custom_url_shortener.present? ? custom_url_shortener : base_url
+  end
+
+  private
+
+  def host_with_port
+    split_base_url[:host_with_port]
+  end
+
+  def split_base_url
+    unless @split_base_url
+      unless base_url =~ /(https?):\/\/([^\/]*)(.*)/
+        raise "Invalid base_url: #{base_url}"
+      end
+      @split_base_url = { protocol: Regexp.last_match[1], host_with_port: Regexp.last_match[2], root_path: Regexp.last_match[3].gsub(%r{/$}, '') }
+    end
+    @split_base_url
+  end
+end

data/app/models/blog_sweeper.rb

@@ -0,0 +1,86 @@
+class BlogSweeper < ActionController::Caching::Sweeper
+  observe Blog, User, Article, Page, Comment, Trackback, Note, Tag
+
+  def pending_sweeps
+    @pending_sweeps ||= Set.new
+  end
+
+  def run_pending_page_sweeps
+    pending_sweeps.each do |each|
+      send(each)
+    end
+  end
+
+  def after_comments_create
+    expire_for(controller.send(:instance_variable_get, :@comment))
+  end
+
+  alias after_comments_update after_comments_create
+  alias after_articles_comment after_comments_create
+
+  def after_comments_destroy
+    expire_for(controller.send(:instance_variable_get, :@comment), true)
+  end
+
+  alias after_articles_nuke_comment after_comments_destroy
+
+  def after_articles_trackback
+    expire_for(controller.send(:instance_variable_get, :@trackback))
+  end
+
+  def after_articles_nuke_trackback
+    expire_for(controller.send(:instance_variable_get, :@trackback), true)
+  end
+
+  def after_save(record)
+    expire_for(record) unless record.is_a?(Article) && record.state == :draft
+  end
+
+  def after_destroy(record)
+    expire_for(record, true)
+  end
+
+  # TODO: Simplify this. Almost every sweep amounts to a sweep_all.
+  def expire_for(record, destroying = false)
+    case record
+    when Page
+      pending_sweeps << :sweep_pages
+    when Content
+      if record.invalidates_cache?(destroying)
+        pending_sweeps << :sweep_articles << :sweep_pages
+      end
+    when Tag
+      pending_sweeps << :sweep_articles << :sweep_pages
+    when Blog, User, Comment, Trackback
+      pending_sweeps << :sweep_all << :sweep_theme
+    end
+    run_pending_page_sweeps unless controller
+  end
+
+  def sweep_all
+    PageCache.sweep_all
+  end
+
+  def sweep_theme
+    PageCache.sweep_theme_cache
+  end
+
+  def sweep_articles
+    PageCache.sweep_all
+  end
+
+  def sweep_pages
+    PageCache.zap_pages(%w(pages))
+  end
+
+  def logger
+    @logger ||= ::Rails.logger || Logger.new(STDERR)
+  end
+
+  private
+
+  def callback(timing)
+    super
+    run_pending_page_sweeps if timing == :after
+  end
+end