mysociety/alaveteli

# app/helpers/application_helper.rb:
# Methods added to this helper will be available to all views (i.e. templates)
# in the application.
#
# Copyright (c) 2007 UK Citizens Online Democracy. All rights reserved.
# Email: hello@mysociety.org; WWW: http://www.mysociety.org/

require 'languages'

module ApplicationHelper
  # URL generating functions are needed by all controllers (for redirects),
  # views (for links) and mailers (for use in emails), so include them into
  # all of all.
  include LinkToHelper

  # Some extra date and time formatters
  include DateTimeHelper

  # Site-wide access to configuration settings
  include ConfigHelper

  # Useful for sending emails
  include MailerHelper

  # Extra highlight helpers
  include HighlightHelper

  # Currency helpers
  include CurrencyHelper

  # Stripe helpers
  include StripeHelper

  # Copied from error_messages_for in active_record_helper.rb
  def foi_error_messages_for(*params)
    options = params.last.is_a?(Hash) ? params.pop.symbolize_keys : {}
    objects = params.collect { |object_name| instance_variable_get("@#{object_name}") }.compact
    count   = objects.inject(0) { |sum, object| sum + object.errors.count }
    return if count.zero?

    html = {}
    [:id, :class].each do |key|
      if options.include?(key)
        value = options[key]
        html[key] = value unless value.blank?
      else
        html[key] = 'errorExplanation'
      end
    end

    error_messages = "".html_safe

    objects.each do |object|
      object.errors.each do |error|
        error_messages << content_tag(:li, h(error.message))
      end
    end

    content_tag(:div, content_tag(:ul, error_messages), html)
  end

  def locale_name(locale)
    LanguageNames.get_language_name(locale)
  end

  def admin_value(v)
    if v.nil?
      nil
    elsif v.is_a?(Time)
      admin_date(v)
    else
      h(v)
    end
  end

  def admin_date(date, ago: true, ago_only: false)
    ago_text = _('{{length_of_time}} ago', length_of_time: time_ago_in_words(date))
    text = ago_text if ago_only

    exact_date = I18n.l(date, format: "%e %B %Y %H:%M:%S")
    text ||= "#{exact_date} (#{ago_text})" if ago

    time_tag(date, text || exact_date, title: date)
  end

  def read_asset_file(asset_name)
    assets = Rails.application.assets_manifest.find_sources(asset_name)
    if assets.first
      assets.first.force_encoding('utf-8')
    else
      raise Sprockets::FileNotFound,
            "Asset file '#{asset_name}' was not found in the assets directory"
    end
  end

  # Public: Checks whether there is an active theme
  # Relies on the convention that themes prepend their view path to the
  # standard Rails view path in the view_paths array
  #
  # Returns a Boolean
  def theme_installed?
    view_paths.paths.count > 1
  end

  # Public: Whether the asset file is overridden in the current theme
  # Relies on the convention that themes prepend their view path to the
  # standard Rails view path in the view_paths array
  #
  # Returns a Boolean
  def theme_asset_exists?(asset_path)
    file_path =
      if theme_installed?
        view_paths.paths.first.to_s.
          gsub("/lib/views", "/app/assets/#{asset_path}")
      else
        view_paths.paths.first.to_s.
          gsub("/app/views", "/app/assets/#{asset_path}")
      end
    File.exist?(file_path)
  end

  # Note that if the admin interface is proxied via another server, we can't
  # rely on a session being shared between the front end and admin interface,
  # so need to check the status of the user.
  def is_admin?
    !session[:using_admin].nil? || (!@user.nil? && @user.is_admin?)
  end

  def cache_if_caching_fragments(*args)
    if AlaveteliConfiguration.cache_fragments
      cache(*args) { yield }
    else
      yield
    end
  end

  def inside_layout(layout = 'application', &block)
    render inline: capture(&block), layout: "layouts/#{layout}"
  end

  def render_flash(message)
    message = { plain: message } if message.is_a?(String)
    render message.deep_symbolize_keys
  end

  # We only want to cache request lists that have a reasonable chance of not expiring
  # before they're requested again. Don't cache lists returned from specific searches
  # or anything except the first page of results, just the first page of the default
  # views
  def request_list_cache_key
    cacheable_param_list = %w[controller action locale view]
    if params.keys.all? { |key| cacheable_param_list.include?(key) }
      "request-list-#{@view}-#{@locale}"
    end
  end

  def event_description(event)
    body_link = public_body_link_absolute(event.info_request.public_body)
    user_link = request_user_link_absolute(event.info_request)
    date = simple_date(event.created_at)
    case event.event_type
    when 'sent'
      _('Request sent to {{public_body_name}} by {{info_request_user}} on {{date}}.',
        public_body_name: body_link,
        info_request_user: user_link,
        date: date)
    when 'followup_sent'
      case event.calculated_state
      when 'internal_review'
        _('Internal review request sent to {{public_body_name}} by {{info_request_user}} on {{date}}.',
          public_body_name: body_link,
          info_request_user: user_link,
          date: date)
      when 'waiting_response'
        _('Clarification sent to {{public_body_name}} by {{info_request_user}} on {{date}}.',
          public_body_name: body_link,
          info_request_user: user_link,
          date: date)
      else
        _('Follow up sent to {{public_body_name}} by {{info_request_user}} on {{date}}.',
          public_body_name: body_link,
          info_request_user: user_link,
          date: date)
      end
    when 'response'
      _('Response by {{public_body_name}} to {{info_request_user}} on {{date}}.',
        public_body_name: body_link,
        info_request_user: user_link,
        date: date)
    when 'comment'
      _('Request to {{public_body_name}} by {{info_request_user}}. Annotated by {{event_comment_user}} on {{date}}.',
        public_body_name: body_link,
        info_request_user: user_link,
        event_comment_user: user_link_absolute(event.comment.user),
        date: date)
    end
  end

  def can_ask_the_eu?(code)
    WorldFOIWebsites.can_ask_the_eu?(code)
  end

  def controller?(*controllers)
    controllers.include?(params[:controller])
  end

  def action?(*actions)
    actions.include?(params[:action])
  end

  def site_wide_announcement
    @site_wide_announcement ||= Announcement.site_wide_for_user(
      current_user,
      session[:announcement_dismissals]
    ).first
  end

  def show_pro_upsell?(user)
    feature_enabled?(:alaveteli_pro) && (!user || user && !user.is_pro?)
  end

  def pro_upsell_text
    pro_link = link_to(account_request_index_path) do
      pro_site_name
    end

    pro_site_name_link = content_tag(:strong, pro_link)

    _('{{pro_site_name}} is a powerful, fully-featured FOI toolkit for ' \
      'journalists.',
      pro_site_name: pro_site_name_link)
  end
end