censor_bear 0.1.0

data/app/views/censor_bear/stop_words/_stop_word.html.haml

@@ -0,0 +1,33 @@
+= turbo_frame_tag dom_id(stop_word) 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: "font-bold"}
+        = "##{stop_word.id}"
+      %span{class: "text-gray-500"}
+        = link_to stop_word.created_at, stop_word, data: {turbo: false}
+    %div{class: "space-y-0.5"}
+      %div{class: "text-xl font-meidum"}= stop_word.key
+      %div{class: "flex space-x-2"}
+        %div{class: "flex flex-col justify-center border rounded-md p-1"}
+          %div{class: "text-center"}=I18n.t("censor_log.action.#{stop_word.ugc}")
+          %div{class: "text-gray-500 text-xs text-center"} UGC内容处理
+        %div{class: "flex flex-col justify-center border rounded-md p-1"}
+          %div{class: "text-center"}=I18n.t("censor_log.action.#{stop_word.username}")
+          %div{class: "text-gray-500 text-xs text-center"} 用户名处理
+        %div{class: "flex flex-col justify-center border rounded-md p-1"}
+          %div{class: "text-center"}=I18n.t("censor_log.action.#{stop_word.nickname}")
+          %div{class: "text-gray-500 text-xs text-center"} 用户昵称处理
+        %div{class: "flex flex-col justify-center border rounded-md p-1"}
+          %div{class: "text-center"}=I18n.t("censor_log.action.#{stop_word.signature}")
+          %div{class: "text-gray-500 text-xs text-center"} 签名处理
+        %div{class: "flex flex-col justify-center border rounded-md p-1"}
+          %div{class: "text-center"}=I18n.t("censor_log.action.#{stop_word.dialog}")
+          %div{class: "text-gray-500 text-xs text-center"} 私信处理
+        %div{class: "flex flex-col justify-center border rounded-md p-1"}
+          %div{class: "text-center"}=stop_word.replacement
+          %div{class: "text-gray-500 text-xs text-center"} 过滤词替换
+    %div{class: "flex justify-end space-x-2 text-sm text-blue-600"}
+      %span
+        = link_to '编辑', edit_stop_word_path(stop_word)
+      %span
+        = button_to '删除', stop_word, method: :delete, data: { confirm: 'Are you sure?' }, class: "cursor-pointer bg-white text-red-600"

data/app/views/censor_bear/stop_words/destroy.turbo_stream.haml

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

data/app/views/censor_bear/stop_words/edit.html.haml

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

data/app/views/censor_bear/stop_words/index.html.haml

@@ -0,0 +1,20 @@
+%div{class: "flex flex-col space-y-2 justify-center"}
+  %div{class: "flex justify-between"}
+    %div
+      = form_with(url: stop_words_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.submit "检索", class: "rounded-md px-2 py-1 text-sm bg-black text-white cursor-pointer"
+          = link_to "重置", stop_words_path, class: "text-sm"
+
+    %div
+      = link_to '批量导入', "#", class: "text-sm"
+      = link_to '新增', new_stop_word_path, class: "rounded-md px-2 py-1 text-sm bg-black text-white cursor-pointer"
+  %div
+    - if @stop_words.blank?
+      %div{class: "flex justify-center text-gray-500 p-8 border rounded-md"} 空空如也
+    - else
+      - @stop_words.each do |stop_word|
+        = render stop_word
+  %div{class: "flex justify-center"}
+    = raw pagy_nav(@pagy)

data/app/views/censor_bear/stop_words/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 '返回', stop_words_path, class: "text-gray-500"
+  = render 'form', stop_word: @stop_word

data/app/views/censor_bear/stop_words/show.html.haml

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

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

@@ -0,0 +1,18 @@
+!!! 5
+%html
+  %head
+    %title 🐻 内容审核
+    = csrf_meta_tags
+    = csp_meta_tag
+    = stylesheet_link_tag    "censor_bear/application", media: "all"
+    = javascript_include_tag "turbo", type: "module"
+    = yield :head
+  %body{class: "flex flex-col space-y-6 p-4"}
+    %ul{class: "flex justify-end items-center space-x-2 text-blue-600"}
+      %li= link_to "审查(#{CensorBear::ModLog.pending.count})", mod_logs_path
+      %li= link_to "敏感词", stop_words_path
+      %li= link_to "日志", logs_path
+      %li= link_to "回主站", "/"
+      %li= current_user.email
+    %div
+      = yield

data/config/cable.yml

@@ -0,0 +1,9 @@
+development:
+  adapter: redis
+  url: redis://localhost:6379/1
+test:
+  adapter: test
+production:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  channel_prefix: dummy_production

data/config/initializers/censor_bear.rb

@@ -0,0 +1,6 @@
+CensorBear.configure do |config|
+  # class name of you User model, default: 'User'
+  # config.user_class = 'User'
+  # current_user method name in your Controller, default: 'current_user'
+  # config.user_name_method = 'current_user'
+end

data/config/locales/censor_bear.yml

@@ -0,0 +1,7 @@
+en:
+  censor_log:
+    action:
+      mod: 审核
+      banned: 禁用
+      ignore: 忽略
+      replace: 替换

data/config/routes.rb

@@ -0,0 +1,12 @@
+CensorBear::Engine.routes.draw do
+  resources :mod_logs do
+    get :ignore
+    get :approve
+    get :delete
+    get :ban
+  end
+  resources :logs
+  resources :stop_words
+
+  root to: "stop_words#index"
+end

data/db/migrate/20211126133758_create_censor_bear_stop_words.rb

@@ -0,0 +1,16 @@
+class CreateCensorBearStopWords < ActiveRecord::Migration[6.1]
+  def change
+    create_table :censor_bear_stop_words do |t|
+      t.string :key
+      t.bigint :user_id
+      t.string :ugc
+      t.string :username
+      t.string :nickname
+      t.string :signature
+      t.string :dialog
+      t.string :replacement
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20211129093508_create_censor_bear_logs.rb

@@ -0,0 +1,12 @@
+class CreateCensorBearLogs < ActiveRecord::Migration[6.1]
+  def change
+    create_table :censor_bear_logs do |t|
+      t.text :original_content
+      t.string :action
+      t.text :filtered_content
+      t.string :mod_words, array: true, default: []
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20211129110218_create_censor_bear_mod_logs.rb

@@ -0,0 +1,18 @@
+class CreateCensorBearModLogs < ActiveRecord::Migration[6.1]
+  def change
+    create_table :censor_bear_mod_logs do |t|
+      t.bigint :record_id
+      t.string :record_type
+      t.text :content
+      t.string :reason
+      t.string :mod_words, array: true, default: []
+      t.integer :status, default: 0
+      t.bigint :user_id
+
+      t.timestamps
+
+      t.index %w[record_type record_id], using: :btree
+    end
+
+  end
+end

data/lib/censor_bear/censor.rb

@@ -0,0 +1,64 @@
+module CensorBear
+  class Result
+    attr_accessor :is_mod, :mod_words, :content
+
+    def initialize(content, is_mod = false, mod_words = [])
+      @is_mod = is_mod
+      @mod_words = mod_words
+      @content = content || ''
+    end
+  end
+
+  class Censor
+    def initialize(content, type = 'ugc')
+      @is_mod = false
+      @mod_words = []
+      @content = content
+      @type = type.to_s
+    end
+
+    def check_text
+      return Result.new(@content) if @content.blank?
+      return Result.new(@content) unless CensorBear::StopWord::FIELDS.include?(@type)
+
+      local_check
+
+      # 用户相关类型直接封禁，速错
+      raise NotPassedException if @is_mod && %w[username signature dialog nickname].include?(@type)
+
+      Result.new(@content, @is_mod, @mod_words.uniq)
+    end
+
+    def local_check
+      original_content = @content.dup
+      stop_words = CensorBear::StopWord.where("#{@type} != 'IGNORE'")
+      stop_words.each do |word|
+        finder = Regexp.new(Regexp.escape(word.key))
+        action = word.send(@type.to_sym).upcase
+        next unless finder.match(@content)
+        @mod_words.push(word.key)
+        case action
+        when 'REPLACE'
+          @content = @content.gsub(finder, word.replacement)
+          CensorBear::Log.create(original_content: original_content, action: "#{@type}_#{action}", filtered_content: @content, mod_words: [word.key])
+        when 'MOD'
+          @is_mod = true
+          CensorBear::Log.create(original_content: original_content, action: "#{@type}_#{action}", filtered_content: nil, mod_words: [word.key])
+        when 'BANNED'
+          @is_mod = true
+          # 禁止的直接抛出异常
+          CensorBear::Log.create(original_content: original_content, action: "#{@type}_#{action}", filtered_content: nil, mod_words: [word.key])
+          raise NotPassedException
+        end
+      end
+    end
+
+    def cloud_check() end
+
+    private
+
+    def tencent_check() end
+
+    def aliyun_check() end
+  end
+end

data/lib/censor_bear/configuration.rb

@@ -0,0 +1,12 @@
+module CensorBear
+  class Configuration
+    # class name of you User model, default: 'User'
+    attr_accessor :user_class
+
+    # current_user method name in your Controller, default: 'current_user'
+    attr_accessor :current_user_method
+
+    # user name method, default: "name"
+    attr_accessor :user_name_method
+  end
+end

data/lib/censor_bear/engine.rb

@@ -0,0 +1,11 @@
+require "turbo-rails"
+
+module CensorBear
+  class Engine < ::Rails::Engine
+    isolate_namespace CensorBear
+
+    initializer "censor_bear.assets.precompile" do |app|
+      app.config.assets.precompile += %w( censor_bear/application.css )
+    end
+  end
+end

data/lib/censor_bear/version.rb

@@ -0,0 +1,3 @@
+module CensorBear
+  VERSION = '0.1.0'
+end

data/lib/censor_bear.rb

@@ -0,0 +1,36 @@
+require "censor_bear/version"
+require "censor_bear/engine"
+require "censor_bear/censor"
+require "censor_bear/configuration"
+
+require "hamlit"
+require 'pagy'
+
+module CensorBear
+  class NotPassedException < StandardError; end
+
+  class << self
+    def config
+      return @config if defined?(@config)
+
+      @config = Configuration.new
+      @config.user_class = 'User'
+      @config.current_user_method = 'current_user'
+      @config.user_name_method = 'name'
+      @config
+    end
+
+    def configure
+      yield(config)
+    end
+
+    def check_text(content, type = 'ugc')
+      Censor.new(content, type).check_text
+    end
+
+
+    def action_options
+      I18n.t('censor_log.action').map { |k, v| [v, k.to_s] }
+    end
+  end
+end

data/lib/tasks/censor_bear_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :censor_bear do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: censor_bear
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 42up
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+- !ruby/object:Gem::Dependency
+  name: hamlit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+description: Description of CensorBear.
+email:
+- foobar@v2up.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/censor_bear_manifest.js
+- app/assets/stylesheets/censor_bear/application.css
+- app/assets/stylesheets/censor_bear/logs.css
+- app/assets/stylesheets/censor_bear/mod_logs.css
+- app/assets/stylesheets/censor_bear/stop_words.css
+- app/assets/stylesheets/censor_bear/tailwind.min.css
+- app/assets/stylesheets/scaffold.css
+- app/controllers/censor_bear/application_controller.rb
+- app/controllers/censor_bear/logs_controller.rb
+- app/controllers/censor_bear/mod_logs_controller.rb
+- app/controllers/censor_bear/stop_words_controller.rb
+- app/helpers/censor_bear/application_helper.rb
+- app/helpers/censor_bear/logs_helper.rb
+- app/helpers/censor_bear/mod_logs_helper.rb
+- app/helpers/censor_bear/stop_words_helper.rb
+- app/jobs/censor_bear/application_job.rb
+- app/mailers/censor_bear/application_mailer.rb
+- app/models/censor_bear/application_record.rb
+- app/models/censor_bear/log.rb
+- app/models/censor_bear/mod_log.rb
+- app/models/censor_bear/stop_word.rb
+- app/views/censor_bear/logs/_form.html.erb
+- app/views/censor_bear/logs/edit.html.erb
+- app/views/censor_bear/logs/index.html.erb
+- app/views/censor_bear/logs/new.html.erb
+- app/views/censor_bear/logs/show.html.erb
+- app/views/censor_bear/mod_logs/_form.html.erb
+- app/views/censor_bear/mod_logs/edit.html.erb
+- app/views/censor_bear/mod_logs/index.html.erb
+- app/views/censor_bear/mod_logs/new.html.erb
+- app/views/censor_bear/mod_logs/show.html.erb
+- app/views/censor_bear/stop_words/_form.html.haml
+- app/views/censor_bear/stop_words/_stop_word.html.haml
+- app/views/censor_bear/stop_words/destroy.turbo_stream.haml
+- app/views/censor_bear/stop_words/edit.html.haml
+- app/views/censor_bear/stop_words/index.html.haml
+- app/views/censor_bear/stop_words/new.html.haml
+- app/views/censor_bear/stop_words/show.html.haml
+- app/views/layouts/censor_bear/application.html.haml
+- config/cable.yml
+- config/initializers/censor_bear.rb
+- config/locales/censor_bear.yml
+- config/routes.rb
+- db/migrate/20211126133758_create_censor_bear_stop_words.rb
+- db/migrate/20211129093508_create_censor_bear_logs.rb
+- db/migrate/20211129110218_create_censor_bear_mod_logs.rb
+- lib/censor_bear.rb
+- lib/censor_bear/censor.rb
+- lib/censor_bear/configuration.rb
+- lib/censor_bear/engine.rb
+- lib/censor_bear/version.rb
+- lib/tasks/censor_bear_tasks.rake
+homepage: https://github.com/42up/censor_bear
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/42up/censor_bear
+  source_code_uri: https://github.com/42up/censor_bear
+  changelog_uri: https://github.com/42up/censor_bear
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Summary of CensorBear.
+test_files: []