web_sandbox_console 0.1.0 → 0.6.0

data/lib/web_sandbox_console/sandbox_error.rb

@@ -0,0 +1,4 @@
+module WebSandboxConsole
+  class SandboxError < StandardError
+  end
+end

data/lib/web_sandbox_console/version.rb

@@ -1,3 +1,3 @@
 module WebSandboxConsole
-  VERSION = '0.1.0'
+  VERSION = '0.6.0'
 end

data/lib/web_sandbox_console/view_file.rb

@@ -0,0 +1,257 @@
+module WebSandboxConsole
+  class ViewFile
+    attr_accessor :file_or_dir         # 文件或目录
+    attr_accessor :start_line_num      # 起始行数
+    attr_accessor :end_line_num        # 结束行数
+    attr_accessor :sed_start_time      # 开始时间
+    attr_accessor :sed_end_time        # 结束时间
+    attr_accessor :grep_content        # 过滤内容
+    attr_accessor :touch_grep_protect  # 是否触发过滤保护
+    attr_accessor :content_is_trimed   # 内容是否有裁剪
+    
+    # 页面相关提示
+    PageTips = {
+      touch_grep_protect: "由于过滤执行时间太长，已触发过滤保护，返回内容为最后1000行",
+      content_is_trimed: "当前返回内容太多，仅展示满足条件的1000行",
+      is_big_file_return: "当前文件视为大文件，返回最后1000行",
+      special_line_return: "当前按指定行数返回,若未指定行数，则默认返回文件前100行"
+    }.freeze
+
+    def initialize(opts = {})
+      @file_or_dir     = opts[:file_or_dir]
+      @start_line_num  = (opts[:start_line_num].presence || 1).to_i
+      @end_line_num    = (opts[:end_line_num].presence || 100).to_i
+      @sed_start_time  = opts[:sed_start_time]
+      @sed_end_time    = opts[:sed_end_time]
+      @grep_content    = opts[:grep_content]
+      @touch_grep_protect  = false
+      @content_is_trimed   = false
+      @is_big_file_return  = false
+      @special_line_return = false
+    end
+
+    def view
+      begin
+        check_param
+        correction_line_num
+        file_or_dir_exists
+        check_blacklist
+        check_only_view_log
+        view_file
+      rescue ViewFileError => e
+        {lines: [e.message]}
+      end
+    end
+
+    # 检查参数
+    def check_param
+      raise ViewFileError, '文件或目录参数不能为空' if file_or_dir.blank?
+      raise ViewFileError, "过滤内容中不能出现单引号" if grep_content.to_s.include?("'")
+    end
+
+    # 纠正起始行数
+    def correction_line_num
+      if @start_line_num > @end_line_num
+        @end_line_num = @start_line_num + 100
+      end
+    end
+
+    # 转换成项目路径
+    def project_path(path)
+      "#{Rails.root}/#{path}"
+    end
+
+    # 绝对路径
+    def file_or_dir_path
+      "#{Rails.root}/#{file_or_dir}"
+    end
+
+    # 是否存在
+    def file_or_dir_exists
+      raise ViewFileError, '文件或目录不存在' unless File.exists?(file_or_dir_path)
+    end
+
+    # 是目录？
+    def is_directory?(path)
+      File.directory?(path)
+    end
+
+    # 目录下所有子文件 目录
+    def dir_all_sub_file_or_dir(current_dir)
+      Dir["#{current_dir}**/*"]
+    end
+
+    # 黑名单 包含自身 及其 子目录/文件
+    def blacklist_all_file_dir_arr
+      black_lists = WebSandboxConsole.view_file_blacklist
+      return [] if black_lists.blank?
+
+      result_arr = black_lists.inject([]) do |result_arr, black_item_path|
+        current_path = project_path(black_item_path)
+
+        if is_directory?(current_path)
+          result_arr.concat(dir_all_sub_file_or_dir(current_path))
+        else
+          result_arr
+        end
+      end
+      black_lists.map{|i| project_path(i)}.concat(result_arr)
+    end
+    
+    # 检查是否为黑名单 文件 / 目录
+    def check_blacklist
+      black_lists = blacklist_all_file_dir_arr
+      raise ViewFileError, '文件或目录无权限查看' if black_lists.include?(file_or_dir_path) || black_lists.include?(file_or_dir_path + '/')
+    end
+
+    # 检查 仅能查看日志
+    def check_only_view_log
+      if WebSandboxConsole.only_view_log_file
+        raise ViewFileError, '仅可查看日志目录/文件' unless file_or_dir.split("/")[0] == 'log'
+      end
+    end
+
+    # 目录下文件
+    def files_in_dir
+      lines = Dir["#{file_or_dir_path}/*"].map do |path|
+        path += is_directory?(path) ? '(目录)' : '(文件）'
+        path[file_or_dir_path.length..-1]
+      end
+      {lines: lines}
+    end
+
+    # 是否为大文件
+    def is_big_file?
+      File.new(file_or_dir_path).size > 10.megabytes
+    end
+
+    # 是否需要过滤
+    def need_grep?
+      @sed_start_time || @grep_content.present?
+    end
+
+    # 查看文件/目录
+    def view_file
+      if is_directory?(file_or_dir_path)
+        files_in_dir
+      else # 文件
+        parse_start_and_end_time
+        lines = if need_grep?
+          grep_file_content
+        elsif is_big_file?
+          @is_big_file_return = true
+          tail_any_line(1000)
+        else
+          @special_line_return = true
+          special_line_content
+        end
+        # 修剪行数
+        lines = content_trim(lines)
+
+        {
+          lines: add_line_num(lines), 
+          total_line_num: cal_file_total_line_num,
+          touch_grep_protect: @touch_grep_protect,
+          content_is_trimed: @content_is_trimed,
+          is_big_file_return: @is_big_file_return,
+          special_line_return: @special_line_return
+        }
+      end
+    end
+
+    # 计算文件总行数
+    def cal_file_total_line_num
+      `wc -l < #{file_or_dir_path}`.to_i
+    end
+
+    # 最后 xx 行
+    def tail_any_line(num)
+      tail_any_line_content(num).split("\n")
+    end
+
+    # 最后多少行内容
+    def tail_any_line_content(num)
+      `tail -n #{num} #{file_or_dir_path}`
+    end
+
+    # 按指定行返回
+    def special_line_content
+      File.readlines(file_or_dir_path)[(start_line_num - 1)..(end_line_num - 1)]
+    end
+    
+    # 过滤超时保护 
+    def grep_timeout_protect
+      begin
+        Timeout::timeout(8) {yield}
+      rescue Timeout::Error => e
+        # 触发过滤保护
+        @touch_grep_protect = true
+        tail_any_line_content(1000)
+      end
+    end
+
+    # 过滤文件
+    def grep_file_content
+      content = if @sed_start_time && @grep_content.present?
+        grep_timeout_protect {`sed -n '/#{@sed_start_time}/,/#{@sed_end_time}/p' #{file_or_dir_path} | fgrep '#{@grep_content}'`}
+      elsif @sed_start_time
+        grep_timeout_protect {`sed -n '/#{@sed_start_time}/,/#{@sed_end_time}/p' #{file_or_dir_path}`}
+      else
+        grep_timeout_protect {`fgrep '#{@grep_content}' #{file_or_dir_path}`}
+      end
+      content.split("\n")
+    end
+    
+    # 修剪过滤内容
+    def content_trim(lines)
+      if lines.length > 1000
+        @content_is_trimed = true
+        # 内容太多时 只返回前1000行
+        lines.first(1000)
+      else
+        lines
+      end
+    end
+
+    # 添加行号
+    def add_line_num(lines)
+      start_num = is_big_file? ? 1 : start_line_num
+      lines.each_with_index.map do |line, index| 
+        line = "#{index + start_num}:  #{line}"
+        hightlight_grep_content(line)
+      end
+    end
+
+    # 高亮内容
+    def hightlight_grep_content(content)
+      if @grep_content.present?
+        content.gsub(@grep_content.to_s, "<span style='color: #E35520;'> #{@grep_content}</span>").html_safe
+      else
+        content
+      end
+    end
+
+    private
+      # 解析时间
+      def parse_start_and_end_time
+        formatter = datetime_formatter
+        @sed_start_time = DateTime.parse(@sed_start_time).strftime(formatter) rescue nil
+        @sed_end_time   = DateTime.parse(@sed_end_time).strftime(formatter) rescue nil
+      end
+
+      # 日志时间格式是否为标准格式
+      def logger_datetime_is_default_formatter
+        # 抽取日志的第二行
+        logger_line   = `head -n 2 #{file_or_dir_path} | tail -n 1`
+        datatime_part = logger_line.split(/DEBUG:|INFO:|WARN:|ERROR:|FATAL:|UNKNOWN:/).first.to_s
+        datatime_part.include?("T")
+      end
+      
+      # 解析日期格式
+      def datetime_formatter
+        logger_datetime_is_default_formatter ? "%FT%T" : "%F %T"
+      end
+
+
+  end
+end

data/lib/web_sandbox_console/view_file_error.rb

@@ -0,0 +1,4 @@
+module WebSandboxConsole
+  class ViewFileError < StandardError
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web_sandbox_console
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - dongmingyan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,8 +38,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 工作中许多时候，都需要我们连到服务器进入rails c下查询或一些数据。当运维人员时间比较充足的时候，情况还相对较好；如果一个运维人员，同时负责许多台服务器，让其帮忙负责查询就会浪费很大的一部分时间；为了解决这个问题，我想找到一种即安全、又方便的查询控制台，搜索了一些gem后，发现并没有符合我预期的gem,于是决定写一个相关功能的gem，旨在提供一个安全、方便的web
-  控制台.
+description: At work, many times, we need to connect to the server to enter the rails
+  c query or some data. When the operator has plenty of time, the situation is relatively
+  good; if an operator is responsible for many servers at the same time, it will waste
+  a lot of time to help with the query; to solve this problem, I want to find a secure
+  and convenient query console, after searching some gem, found and did not meet my
+  expectations gem, so decided to write a related function of the console designed
+  to provide a safe, convenient web.
 email:
 - dongmingyan01@gmail.com
 executables: []
@@ -50,23 +55,37 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/web_sandbox_console_manifest.js
+- app/assets/images/web_sandbox_console/logo-icon.png
 - app/assets/javascripts/web_sandbox_console/application.js
+- app/assets/javascripts/web_sandbox_console/code_editor.js
+- app/assets/javascripts/web_sandbox_console/codemirror.js
 - app/assets/javascripts/web_sandbox_console/home.js
+- app/assets/javascripts/web_sandbox_console/matchbrackets.js
+- app/assets/javascripts/web_sandbox_console/ruby.js
 - app/assets/stylesheets/web_sandbox_console/application.css
+- app/assets/stylesheets/web_sandbox_console/codemirror.css
+- app/assets/stylesheets/web_sandbox_console/common.css
+- app/assets/stylesheets/web_sandbox_console/docs.css
 - app/assets/stylesheets/web_sandbox_console/home.css
+- app/assets/stylesheets/web_sandbox_console/lucario.css
 - app/controllers/web_sandbox_console/application_controller.rb
+- app/controllers/web_sandbox_console/authorization_controller.rb
 - app/controllers/web_sandbox_console/home_controller.rb
 - app/helpers/web_sandbox_console/application_helper.rb
 - app/helpers/web_sandbox_console/home_helper.rb
-- app/jobs/web_sandbox_console/application_job.rb
 - app/mailers/web_sandbox_console/application_mailer.rb
 - app/models/web_sandbox_console/application_record.rb
 - app/views/layouts/web_sandbox_console/application.html.erb
+- app/views/web_sandbox_console/authorization/auth_page.html.erb
+- app/views/web_sandbox_console/home/do_view_file.js.erb
+- app/views/web_sandbox_console/home/download_page.html.erb
 - app/views/web_sandbox_console/home/eval_code.js.erb
 - app/views/web_sandbox_console/home/index.html.erb
+- app/views/web_sandbox_console/home/view_file.html.erb
 - config/routes.rb
 - lib/generators/web_sandbox_console/USAGE
 - lib/generators/web_sandbox_console/templates/web_sandbox_console.rb
+- lib/generators/web_sandbox_console/templates/web_sandbox_console.yml
 - lib/generators/web_sandbox_console/web_sandbox_console_generator.rb
 - lib/tasks/web_sandbox_console_tasks.rake
 - lib/web_sandbox_console.rb
@@ -75,7 +94,10 @@ files:
 - lib/web_sandbox_console/engine.rb
 - lib/web_sandbox_console/safe_ruby.rb
 - lib/web_sandbox_console/sandbox.rb
+- lib/web_sandbox_console/sandbox_error.rb
 - lib/web_sandbox_console/version.rb
+- lib/web_sandbox_console/view_file.rb
+- lib/web_sandbox_console/view_file_error.rb
 homepage: https://github.com/dongmy54/web_sandbox_console
 licenses:
 - MIT
@@ -98,5 +120,5 @@ requirements: []
 rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
-summary: 一个安全、方便的web 控制台
+summary: A secure, convenient web console
 test_files: []

data/app/jobs/web_sandbox_console/application_job.rb

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