HornsAndHooves-publify_core 10.0.0

data/app/models/article.rb

@@ -0,0 +1,308 @@
+# frozen_string_literal: true
+
+require "aasm"
+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 :triggers, as: :pending_item
+  has_many :comments, dependent: :destroy
+
+  belongs_to :resource
+
+  before_create :create_guid
+  before_save :set_permalink
+  after_save :keywords_to_tags, :shorten_url
+
+  scope :child_of, ->(article_id) { where(parent_id: article_id) }
+  scope :published_since, ->(time) { published.where("published_at > ?", time) }
+  scope :withdrawn, -> { where(state: "withdrawn").order(default_order) }
+  scope :pending, -> { where(state: "publication_pending"). order(default_order) }
+
+  scope :bestof, lambda {
+    joins(:feedback).
+      where("feedback.type" => "Comment",
+            "contents.state" => "published").
+      group("contents.id").
+      select("contents.*, count(feedback.id) as comment_count").
+      order("comment_count DESC").
+      limit(5)
+  }
+
+  setting :password, :string, ""
+
+  attr_accessor :draft, :keywords
+
+  include AASM
+
+  aasm column: :state do
+    state :draft, initial: true
+    # TODO: Disallow if published_at in past
+    state :publication_pending, after_enter: :trigger_publication
+    state :published, after_enter: :really_send_notifications
+    state :withdrawn
+
+    event :withdraw do
+      transitions from: :published, to: :withdrawn
+      transitions from: :publication_pending, to: :draft
+    end
+
+    event :publish do
+      before do
+        self.published_at ||= Time.zone.now
+      end
+
+      transitions from: [:new, :draft], to: :publication_pending do
+        guard do
+          published_at > Time.zone.now
+        end
+      end
+
+      transitions from: [:new, :draft, :publication_pending], to: :published do
+        guard do
+          published_at <= Time.zone.now
+        end
+      end
+    end
+  end
+
+  def set_permalink
+    return if 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)
+    return unless published?
+
+    @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.each_value { |f| save_attachment!(f) }
+  end
+
+  def save_attachment!(file)
+    resources.create!(upload: file, blog: blog)
+  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 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 publication_month
+    published_at.strftime("%Y-%m")
+  end
+
+  def self.publication_months
+    result = select("published_at").where("published_at is not NULL").where(type: "Article")
+    result.map { |it| [it.publication_month] }.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|
+      urls.push(Regexp.last_match[2].strip) if tag =~ /\bhref=(["']?)([^ >"]+)\1/
+    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.present?
+  end
+
+  def add_comment(params)
+    comments.build(params)
+  end
+
+  def access_by?(user)
+    user.admin? || user_id == user.id
+  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
+
+  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::DEFAULT_PARSER.escape(permalink.to_s))
+    if format_url[0, 1] == "/"
+      format_url[1..-1]
+    else
+      format_url
+    end
+  end
+
+  def trigger_publication
+    # TODO: Skip if already published, update when published_at changes
+    Trigger.post_action(published_at, self, "publish!")
+  end
+end

data/app/models/blog.rb

@@ -0,0 +1,280 @@
+# frozen_string_literal: true
+
+# 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 < ApplicationRecord
+  include ConfigManager
+  include Rails.application.routes.url_helpers
+
+  has_many :contents
+  has_many :articles
+  has_many :feedback, through: :articles
+
+  has_many :published_articles, ->() { published }, 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"
+
+  # 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, 9
+  setting :limit_archives_display, :integer, 9
+  setting :limit_rss_display, :integer, 10
+  setting :default_allow_pings, :boolean, false
+  setting :default_allow_comments, :boolean, false
+  setting :default_moderate_comments, :boolean, false
+  # deprecated but still needed for backward compatibility
+  setting :show_extended_on_rss, :boolean, false
+  setting :hide_extended_on_rss, :boolean, false
+  setting :theme, :string, "plain"
+  setting :plugin_avatar, :string, ""
+  setting :global_pings_disable, :boolean, false
+  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, 360
+  setting :image_medium_size, :integer, 805
+
+  # SEO
+  setting :meta_description, :string, ""
+  setting :meta_keywords, :string, ""
+  setting :google_analytics, :string, ""
+  setting :rss_description, :boolean, false
+  setting :rss_description_text, :string, <<-HTML.strip_heredoc
+    <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>
+  HTML
+  setting :permalink_format, :string, "/%year%/%month%/%day%/%title%"
+  setting :robots, :string, 'User-agent: *\nAllow: /\nDisallow: /admin\n'
+  setting :humans, :string, <<-TEXT.strip_heredoc
+    /* TEAM */
+    Your title: Your name.
+    Site: email, link to a contact form, etc.
+    Twitter: your Twitter username.
+
+    /* SITE */
+    Software: Publify [https://publify.github.io/] #{PublifyCore::VERSION}
+  TEXT
+  # deprecated but still needed for backward compatibility
+  setting :index_categories, :boolean, true
+  setting :unindex_categories, :boolean, false
+  # deprecated but still needed for backward compatibility
+  setting :index_tags, :boolean, true
+  setting :unindex_tags, :boolean, false
+  setting :admin_display_elements, :integer, 10
+  setting :google_verification, :string, ""
+  # deprecated but still needed for backward compatibility
+  setting :nofollowify, :boolean, true
+  setting :dofollowify, :boolean, false
+  setting :use_meta_keyword, :boolean, true
+  setting :home_title_template, :string, "%blog_name% | %blog_subtitle%"
+  setting :home_desc_template, :string, "%blog_name% | %blog_subtitle% | %meta_keywords%"
+  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, "Category: %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
+
+  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
+
+  module BasedUrlFor
+    # 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(options = {}, extra_params = {})
+      case options
+      when String
+        options = options.sub(%r{^/}, "")
+        url_generated = if extra_params[:only_path]
+                          root_path
+                        else
+                          base_url
+                        end
+        # They asked for 'url_for "/some/path"', so return it unedited.
+        url_generated += "/#{options}"
+        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, super(merged_opts))
+        end
+        Rails.cache.read(cache_key)
+      else
+        raise "Invalid URL in url_for: #{options.inspect}"
+      end
+    end
+  end
+
+  prepend BasedUrlFor
+
+  # The URL for a static file.
+  def file_url(filename)
+    if CarrierWave.configure { |config| config.storage.name == "CarrierWave::Storage::Fog" }
+      filename
+    else
+      url_for 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 /(%title%)/.match?(permalink_format)
+      errors.add(:base, I18n.t("errors.permalink_need_a_title"))
+    end
+
+    if /\.(atom|rss)$/.match?(permalink_format)
+      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.make_filter(text_filter)
+  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
+      raise "Invalid base_url: #{base_url}" unless base_url =~ %r{(https?)://([^/]*)(.*)}
+
+      @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/comment.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "timeout"
+
+class Comment < Feedback
+  belongs_to :user, optional: true
+  content_fields :body
+  validates :author, :body, presence: true
+
+  attr_accessor :referrer, :permalink
+
+  scope :spam, -> { where(state: "spam") }
+  scope :not_spam, -> { where("state != 'spam'") }
+  scope :presumed_spam, -> { where(state: "presumed_spam") }
+  scope :presumed_ham, -> { where(state: "presumed_ham") }
+  scope :ham, -> { where(state: "ham") }
+  scope :unconfirmed, -> { where(state: %w(presumed_spam presumed_ham)) }
+
+  scope :last_published, -> { published.limit(5).order("created_at DESC") }
+
+  def notify_user_via_email(user)
+    # EmailNotify.send_comment(self, user) if user.notify_via_email?
+  end
+
+  def interested_users
+    User.where(notify_on_comments: true)
+  end
+
+  def default_text_filter
+    TextFilter.find_or_default(blog.comment_text_filter)
+  end
+
+  def feed_title
+    "Comment on #{article.title} by #{author}"
+  end
+
+  def send_notifications
+    really_send_notifications
+  end
+
+  protected
+
+  def article_allows_feedback?
+    return true if article.allow_comments?
+
+    errors.add(:article, "Article is not open to comments")
+    false
+  end
+
+  def originator
+    author
+  end
+
+  def content_fields
+    [:body]
+  end
+end