beetle_reporter 0.1.0 → 0.1.1

data/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,80 @@
+body {
+  background-color: #fff;
+  color: #333;
+  margin: 33px;
+}
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a {
+  color: #000;
+}
+
+a:visited {
+  color: #666;
+}
+
+a:hover {
+  color: #fff;
+  background-color: #000;
+}
+
+th {
+  padding-bottom: 5px;
+}
+
+td {
+  padding: 0 5px 7px;
+}
+
+div.field,
+div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px 7px 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px -7px 0;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
+
+label {
+  display: block;
+}

data/app/controllers/beetle_reporter/application_controller.rb

@@ -0,0 +1,11 @@
+module BeetleReporter
+  class ApplicationController < ActionController::Base
+    include ActionView::RecordIdentifier
+
+    include Pagy::Backend
+
+    def current_user
+      main_app.scope.request.env['warden']&.user
+    end
+  end
+end

data/app/controllers/beetle_reporter/home_controller.rb

@@ -0,0 +1,8 @@
+require_dependency "beetle_reporter/application_controller"
+
+module BeetleReporter
+  class HomeController < ApplicationController
+    def index
+    end
+  end
+end

data/app/controllers/beetle_reporter/reports_controller.rb

@@ -0,0 +1,143 @@
+module BeetleReporter
+  class ReportsController < BeetleReporter::ApplicationController
+    before_action :load_report, only: %w[show edit update destroy ignore undo suspend hide remove mute forbid]
+
+    def index
+      # authorize Report
+  
+      load_reports
+  
+      # skip_policy_scope
+    end
+  
+    def show
+      # authorize @report
+    end
+  
+    def new
+      # authorize Report
+  
+      @report = Report.new
+    end
+  
+    def create
+      # authorize Report
+  
+      create_params = report_params.to_hash.deep_symbolize_keys
+      @report = report_scope.new(create_params)
+      @report.user = current_user
+  
+      respond_to do |format|
+        if @report.save
+          format.turbo_stream { render turbo_stream: turbo_stream.replace(dom_id(@report), partial: "report", locals: {report: @report}) }
+          format.html { redirect_to reports_path, notice: "report was successfully created." }
+        else
+          format.html { render :edit, status: :unprocessable_entity }
+        end
+      end
+    end
+  
+    def edit
+      # authorize @report
+    end
+  
+    def update
+      # authorize @report
+  
+      update_params = report_params.to_hash.deep_symbolize_keys
+  
+      respond_to do |format|
+        if @report.update(update_params)
+          format.turbo_stream { render turbo_stream: turbo_stream.replace(dom_id(@report), partial: "report", locals: {report: @report}) }
+          format.html { redirect_to reports_path, notice: "report was successfully updated." }
+        else
+          format.html { render :edit, status: :unprocessable_entity }
+        end
+      end
+    end
+  
+    def destroy
+      # authorize @report
+  
+      @report.discard
+  
+      respond_to do |format|
+        format.turbo_stream
+      end
+    end
+
+    def ignore
+      @report.ignore!
+
+      redirect_to reports_url, notice: 'report was successfully ignored.'
+    end
+
+    def suspend
+      @report.suspend!
+
+      redirect_to reports_url, notice: 'report was successfully ignored.'
+    end
+
+    def hide
+      @report.beetle_hide("fooobar hide")
+
+      redirect_to reports_url, notice: 'report was successfully hidden.'
+    end
+
+    def remove
+      @report.beetle_remove("fooobar remove")
+
+      redirect_to reports_url, notice: 'report was successfully removed.'
+    end
+
+    def mute
+      @report.beetle_mute("fooobar mute")
+
+      redirect_to reports_url, notice: 'report was successfully muted.'
+    end
+
+    def forbid
+      @report.beetle_forbid("fooobar forbid")
+
+      redirect_to reports_url, notice: 'report was successfully forbiden.'
+    end
+
+    def undo
+      @report.undo!
+
+      redirect_to reports_url, notice: 'report was successfully ignored.'
+    end
+  
+    private
+  
+    def load_reports
+      builder = report_scope.includes(:record)
+      builder = builder.where("reason ilike ?", "%#{params[:q]}%") if params[:q].present?
+      if params[:filter] != 'all'
+        builder = builder.pending
+        builder = builder.unscope(where: :aasm_state).where(aasm_state: params[:state]) if params[:state].present?
+      end
+      builder = builder.where(record_type: params[:type]&.classify) if params[:type]
+
+      builder = builder.order(id: :desc, reported_count: :desc)
+      builder = builder.reorder(updated_at: :desc) if params[:order] == 'last_updated'
+      builder = builder.reorder(created_at: :desc) if params[:order] == 'last_created'
+      builder = builder.reorder(updated_at: :asc) if params[:order] == 'oldest_updated'
+      builder = builder.reorder(created_at: :asc) if params[:order] == 'oldest_created'
+  
+      @pagy, @reports = pagy(builder)
+    end
+  
+    def load_report
+      @report = report_scope.find(params[:id] || params[:report_id])
+    end
+  
+    def report_scope
+      BeetleReporter::Report.kept
+    end
+  
+    def report_params
+      params.require(:report).permit(:id, :record_id, :record_type, :reason, :user_id, :device_id)
+    end
+  end
+end

data/app/helpers/beetle_reporter/application_helper.rb

@@ -0,0 +1,9 @@
+module BeetleReporter
+  module ApplicationHelper
+    include Pagy::Frontend
+
+    def current_user
+      main_app.scope.request.env['warden']&.user
+    end
+  end
+end

data/app/helpers/beetle_reporter/home_helper.rb

@@ -0,0 +1,4 @@
+module BeetleReporter
+  module HomeHelper
+  end
+end

data/app/helpers/beetle_reporter/reports_helper.rb

@@ -0,0 +1,4 @@
+module BeetleReporter
+  module ReportsHelper
+  end
+end

data/app/jobs/beetle_reporter/application_job.rb

@@ -0,0 +1,4 @@
+module BeetleReporter
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/beetle_reporter/application_mailer.rb

@@ -0,0 +1,6 @@
+module BeetleReporter
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/beetle_reporter/application_record.rb

@@ -0,0 +1,5 @@
+module BeetleReporter
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/beetle_reporter/report.rb

@@ -0,0 +1,126 @@
+module BeetleReporter
+  class Report < ApplicationRecord
+    include AASM
+    include Discard::Model
+
+    belongs_to :record, polymorphic: true, required: false
+    belongs_to :user, class_name: BeetleReporter.config.user_class, optional: true
+
+    aasm do
+      state :pending, initial: true
+      state :ignored, :hidden, :removed, :muted, :forbiden, :suspended
+
+      event :ignore do
+        transitions from: :pending, to: :ignored
+      end
+
+      event :hide do
+        transitions from: %i[pending ignored], to: :hidden, after: Proc.new {|*args| set_reason(*args) }
+      end
+
+      event :remove do
+        transitions from: %i[pending ignored], to: :removed, after: Proc.new {|*args| set_reason(*args) }
+      end
+
+      event :mute do
+        transitions from: %i[pending ignored], to: :muted, after: Proc.new {|*args| set_reason(*args) }
+      end
+
+      event :forbid do
+        transitions from: %i[pending muted], to: :forbiden, after: Proc.new {|*args| set_reason(*args) }
+      end
+
+      event :suspend do
+        transitions from: :pending, to: :suspended
+      end
+
+      event :undo do
+        transitions from: %i[ignored hidden removed muted forbiden suspended], to: :pending, after: :undo_callback
+      end
+    end
+
+    def beetle_hide(reason)
+      return if record.blank?
+      raise NoMethodError unless record.respond_to?(:beetle_hide)
+
+      ret = record.beetle_hide
+      hide!(reason) if ret
+    end
+
+    def beetle_remove(reason)
+      return if record.blank?
+      raise NoMethodError unless record.respond_to?(:beetle_remove)
+
+      ret = record.beetle_remove
+      remove!(reason) if ret
+    end
+
+    def beetle_mute(reason)
+      return if record.blank?
+      return if record&.user.blank?
+      raise NoMethodError unless record.respond_to?(:beetle_mute)
+
+      ret = record.beetle_mute
+      mute!(reason) if ret
+    end
+
+    def beetle_mute(reason)
+      return if record.blank?
+      return if record&.user.blank?
+      raise NoMethodError unless record.respond_to?(:beetle_mute)
+
+      ret = record.beetle_mute
+      mute!(reason) if ret
+    end
+
+    def beetle_forbid(reason)
+      return if record.blank?
+      return if record&.user.blank?
+      raise NoMethodError unless record.respond_to?(:beetle_forbid)
+
+      ret = record.beetle_forbid
+      forbid!(reason) if ret
+    end
+
+    def record_path
+      return '#' if record.blank?
+
+      record.beetle_record_path
+    end
+
+    def undo_callback
+      if hidden?
+        ret = record.beetle_undo_hide
+        update_columns(reason: nil) if ret
+      elsif removed?
+        ret = record.beetle_undo_remove
+        update_columns(reason: nil) if ret
+      elsif muted?
+        ret = record.beetle_undo_mute
+        update_columns(reason: nil) if ret
+      elsif forbiden?
+        ret = record.beetle_undo_forbid
+        update_columns(reason: nil) if ret
+      else
+        update_columns(reason: nil)
+      end
+    end
+
+    def images
+      return [] if record.blank?
+
+      raise NoMethodError, 'undefined beetle_images for record' unless record.respond_to?(:beetle_images)
+
+      record.beetle_images
+    end
+
+
+    def set_reason(reason)
+      update_columns(reason: reason)
+    end
+
+    def self.record_type_options
+      select(:record_type).where.not(record_type: nil).distinct.map{|t| [t.record_type, t.record_type.downcase]}
+    end
+  end
+end

data/app/views/beetle_reporter/home/index.html.haml

@@ -0,0 +1,4 @@
+%h1{class: "text-red-400 text-xl"} Home#index
+%p Find me in app/views/beetle_reporter/home/index.html.erb2
+
+%div=link_to "举报中心", reports_path

data/app/views/beetle_reporter/reports/_form.html.haml

@@ -0,0 +1,14 @@
+- url = report&.id.blank? ? reports_path : report_path(report)
+
+= form_with(model: report, id: dom_id(report), url: url, local: true ) do |form|
+  - if report.errors.any?
+    %h2= "#{pluralize(report.errors.count, "error")} prohibited this report from being saved:"
+    %ul
+      - report.errors.each do |error|
+        %li= error.full_message
+  %div{class: "space-y-2"}
+    %div
+      %div{class: "text-gray-500 text-xs"}= form.label :reason, "举报原因"
+      %div= form.text_field :reason, class: "border p-1 w-full rounded-md"
+    %div
+      %div= form.submit "确认", class: "px-2 py-0.5 rounded-md bg-gray-800 text-white"

data/app/views/beetle_reporter/reports/_report.html.haml

@@ -0,0 +1,57 @@
+= turbo_frame_tag dom_id(report) do
+  %div{class: "flex flex-col space-y-2 border rounded-md p-2 mt-2"}
+    %div{class: "flex justify-between text-xs"}
+      %span{class: "space-x-2"}
+        - unless report.record.blank?
+          = link_to report.record_path, data: { turbo: false }, target: "_blank" do
+            %span{class: "bg-indigo-100 text-indigo-600 py-1 px-2 rounded-lg"}="#{report.record_type.upcase}##{report.record_id}"
+          %span{class: "bg-yellow-100 text-yellow-600 rounded-md p-1"}=t("beetle_reporter.aasm_state.#{report.aasm_state}")
+      %span{class: "flex space-x-2 items-center text-sm"}
+        - if report.reason
+          %span{class: "bg-red-100 text-red-600 p-1 rounded-lg"}= "处置原因：#{report.reason}"
+        %span{class: "space-x-1"}
+          - report.user_ids.each do |uid|
+            = link_to main_app.send(BeetleReporter.config.main_app_user_path_method.to_sym, uid), data: {turbo: false} do
+              %span{class: "bg-blue-100 rounded-lg px-1 py-0.5"}= "#{uid}"
+        %span{class: "bg-red-600 text-white rounded-full w-5 h-5 flex justify-center items-center"}= "#{report.reported_count}"
+        %span{class: "bg-gray-100 text-gray-600 py-1 px-2 rounded-lg"}
+          = link_to report.created_at, report_path(report), data: {turbo: false}
+        - unless current_user&.admin?
+          = button_to '删除', report, method: :delete, data: { confirm: 'Are you sure?'}, class: "bg-red-600 text-white rounded-md px-2 py-0.5 cursor-pointer"
+    %div{class: "flex justify-between items-center py-2 w-full"}
+      %div{class: "flex flex-col rounded-lg bg-gray-50 p-3 text-sm space-y-4 w-full"}
+        -unless report.record
+          %h3{class: "text-2xl text-red-600"} 对应条目已被永久删除，当前审核请求已无效，请删除
+        - else
+          %div
+            %span{class: "#{report.record.is_private ? 'bg-black text-white' : 'border border-black text-black' } rounded-lg text-xs p-0.5 px-1"}=report.record.is_private ? "🙈 隐私" : "🙉 公开"
+            %span{class: "border border-blue-600 text-blue-600 rounded-lg text-xs p-0.5"}=report.record.is_approved ? "审核通过" : "审核中..."
+            - unless report.reasons.blank?
+              - report.reasons.each do |reason|
+                %span{class: "border border-red-600 text-red-600 rounded-lg text-xs p-0.5"}= reason
+            - unless report&.record&.user_id&.blank?
+              = link_to main_app.send(CensorBear.config.main_app_user_path_method.to_sym, report.record.user_id), data: {turbo: false} do
+                %span{class: "text-sm bg-gray-100 text-gray-600 py-1 px-2 rounded-lg font-bold"}="✍️ ##{report.record.user_id}"
+          - if report.record.discarded?
+            %div{class: "text-gray-900 leading-relaxed"}
+              %del= report.record.content
+          - else
+            %div{class: "text-gray-900 leading-relaxed"}= report.record.content
+          %div
+            - report.images.each do |img|
+              = image_tag img[:src], class: "w-16 rounded-md"
+    %div{class: "flex space-x-2 items-center justify-end"}
+      - if report.may_ignore?
+        = link_to "忽略", report_ignore_path(report), class: "text-yellow-600 cursor-pointer"
+      - if report.may_hide?
+        = link_to "隐藏内容", report_hide_path(report), class: "text-purple-600 cursor-pointer"
+      - if report.may_remove?
+        = link_to "删除内容", report_remove_path(report), class: "text-red-800 cursor-pointer"
+      - if report.may_mute?
+        = link_to "禁言用户", report_mute_path(report), class: "text-red-600 cursor-pointer"
+      - if report.may_forbid?
+        = link_to "封禁用户",report_forbid_path(report), class: "text-red-700 cursor-pointer"
+      - if report.may_suspend?
+        = link_to "暂缓处理", report_suspend_path(report), class: "text-indigo-600 cursor-pointer"
+      - if report.may_undo?
+        = link_to "撤销", report_undo_path(report), class: "text-red-600 cursor-pointer"

data/app/views/beetle_reporter/reports/destroy.turbo_stream.haml

@@ -0,0 +1 @@
+= turbo_stream.remove(@report)

data/app/views/beetle_reporter/reports/edit.html.haml

@@ -0,0 +1,6 @@
+= turbo_frame_tag dom_id(@report) do
+  %div{class: "bg-gray-100 p-2 rounded-lg"}
+    %div{class: "flex justify-between"}
+      %div{class: "text-lg font-bold"} 编辑
+      %div= link_to '返回', reports_path, class: "text-gray-500"
+    = render 'form', report: @report

data/app/views/beetle_reporter/reports/index.html.haml

@@ -0,0 +1,38 @@
+%div{class: "flex flex-col space-y-2 justify-center"}
+  %div{class: "flex justify-between"}
+    %div
+      = form_with(url: reports_path, method: :get, class: "flex items-center") do |f|
+        %div{class: "space-x-0.5"}
+          = f.text_field :q, value: params[:q], placeholder: "关键词", class: "border rounded-md m py-0.5 px-1"
+          = f.select :type, options_for_select(BeetleReporter::Report.record_type_options, params[:type]), {include_blank: "-- 筛选 --"}, class: "border rounded-md m py-0.5 px-1"
+          = f.select :order, options_for_select([%w[按最近创建 last_created], %w[按最晚创建 oldest_created]], params[:order]), {include_blank: "-- 排序 --"}, class: "border rounded-md m py-0.5 px-1"
+          = f.hidden_field :state, value: params[:state]
+          = f.hidden_field :filter, value: params[:filter]
+          = f.submit "检索", class: "rounded-md px-2 py-1 text-sm bg-black text-white cursor-pointer"
+          = link_to "重置", reports_path, class: "text-sm"
+    %div{class: "flex items-center space-x-2"}
+      %div{class: "text-sm text-gray-600"}="共 #{@pagy.count} 条"
+      %div{class: "bg-gray-200 rounded-full px-3 py-1 text-xs #{params[:state].blank? && params[:filter].blank? ? 'font-bold' : ''}"}
+        = link_to "待处理", request.params.merge(state: "", filter: "")
+      %div{class: "bg-gray-200 rounded-full px-3 py-1 text-xs #{params[:state] == 'ignored' ? 'font-bold' : ''}"}
+        = link_to "无效举报", request.params.merge(state: "ignored", filter: "")
+      %div{class: "bg-gray-200 rounded-full px-3 py-1 text-xs #{params[:state] == 'hidden' ? 'font-bold' : ''}"}
+        = link_to "已隐藏", request.params.merge(state: "hidden", filter: "")
+      %div{class: "bg-gray-200 rounded-full px-3 py-1 text-xs #{params[:state] == 'removed' ? 'font-bold' : ''}"}
+        = link_to "已删除", request.params.merge(state: "removed", filter: "")
+      %div{class: "bg-gray-200 rounded-full px-3 py-1 text-xs #{params[:state] == 'muted' ? 'font-bold' : ''}"}
+        = link_to "已禁言用户", request.params.merge(state: "muted", filter: "")
+      %div{class: "bg-gray-200 rounded-full px-3 py-1 text-xs #{params[:state] == 'forbiden' ? 'font-bold' : ''}"}
+        = link_to "已封禁用户", request.params.merge(state: "forbiden", filter: "")
+      %div{class: "bg-gray-200 rounded-full px-3 py-1 text-xs #{params[:state] == 'suspended' ? 'font-bold' : ''}"}
+        = link_to "暂缓处理", request.params.merge(state: "suspended", filter: "")
+      %div{class: "bg-gray-200 rounded-full px-3 py-1 text-xs #{params[:filter] == "all" ? 'font-bold' : ''}"}
+        = link_to "全部", request.params.merge(filter: "all", state: "")
+  %div
+    - if @reports.blank?
+      %div{class: "flex justify-center text-gray-500 p-8 border rounded-md"} 空空如也
+    - else
+      - @reports.each do |report|
+        = render report
+    %div{class: "flex justify-center mt-2"}
+      = raw pagy_nav(@pagy)

data/app/views/beetle_reporter/reports/new.html.haml

@@ -0,0 +1,5 @@
+%div{class: "bg-gray-100 p-2 rounded-lg"}
+  %div{class: "flex justify-between"}
+    %div{class: "text-lg font-bold"} 添加
+    %div= link_to '返回', reports_path, class: "text-gray-500"
+  = render 'form', report: @report

data/app/views/beetle_reporter/reports/show.html.haml

@@ -0,0 +1 @@
+= render @report

data/app/views/layouts/beetle_reporter/application.html.haml

@@ -0,0 +1,22 @@
+!!! 5
+%html
+  %head
+    %title 🐞 举报中心
+    = csrf_meta_tags
+    = csp_meta_tag
+    = stylesheet_link_tag    "beetle_reporter/application", media: "all"
+    = javascript_include_tag "turbo", type: "module"
+    = yield :head
+  %body{class: "flex flex-col space-y-6 p-4"}
+    %div{class: "flex justify-between items-center"}
+      %h2{class: "text-xl bg-black text-white rounded-full py-1 px-4 cursor-pointer"}
+        %span{class: "shadow-lg"} 🐞
+        %span 举报中心
+
+      %ul{class: "flex justify-end items-center space-x-2 text-blue-600"}
+        %li= link_to "待处理(#{BeetleReporter::Report.pending.count})", reports_path
+        %li= link_to "控制台", main_app.send(BeetleReporter.config.main_app_root_path_method.to_sym)
+        %li= current_user.email
+
+    %div
+      = yield

data/config/locales/beetle_reporter.yml

@@ -0,0 +1,18 @@
+"zh-CN":
+  beetle_reporter:
+    action:
+      mod: 审核
+      banned: 禁用
+      ignore: 忽略
+      replace: 替换
+      block: 禁用
+      pass: 忽略
+      review: 审核
+    aasm_state:
+      pending: 待审
+      suspended: 暂缓处理
+      ignored: 无效举报
+      hidden: 已隐藏
+      removed: 已删除
+      muted: 已禁言用户
+      forbiden: 已封禁用户

data/config/routes.rb

@@ -0,0 +1,13 @@
+BeetleReporter::Engine.routes.draw do
+  resources :reports do
+    get :ignore
+    get :suspend
+    get :undo
+    get :hide
+    get :remove
+    get :mute
+    get :forbid
+  end
+
+  root "reports#index"
+end

data/db/migrate/20211216073022_create_beetle_reporter_reports.rb

@@ -0,0 +1,20 @@
+class CreateBeetleReporterReports < ActiveRecord::Migration[6.1]
+  def change
+    create_table :beetle_reporter_reports do |t|
+      t.bigint :record_id
+      t.string :record_type
+      t.string :reason
+      t.bigint :user_id
+      t.bigint :user_ids, array: true, default: []
+      t.string :reasons, array: true, default: []
+      t.integer :reported_count, default: 0
+      t.string :device_id
+      t.string :aasm_state
+      t.string :treatment_reason
+      t.datetime :discarded_at
+
+      t.timestamps
+    end
+    add_index :beetle_reporter_reports, :discarded_at
+  end
+end

data/lib/beetle_reporter/configuration.rb

@@ -0,0 +1,9 @@
+module BeetleReporter
+  class Configuration
+    attr_accessor :user_class
+    attr_accessor :current_user_method
+    attr_accessor :user_name_method
+    attr_accessor :main_app_root_path_method
+    attr_accessor :main_app_user_path_method
+  end
+end

data/lib/beetle_reporter/engine.rb

@@ -0,0 +1,9 @@
+module BeetleReporter
+  class Engine < ::Rails::Engine
+    isolate_namespace BeetleReporter
+
+    initializer "beetle_reporter.assets.precompile" do |app|
+      app.config.assets.precompile += %w( beetle_reporter/application.css )
+    end
+  end
+end

data/lib/beetle_reporter/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module BeetleReporter
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end