oxidized-web 0.13.0 → 0.14.0

data/lib/oxidized/web/webapp.rb

@@ -2,33 +2,42 @@ require 'sinatra/base'
 require 'sinatra/json'
 require 'sinatra/url_for'
 require 'tilt/haml'
-require 'sass'
+# We need PP in node.haml, but rubocop can't see this
+# rubocop:disable Lint/RedundantRequireStatement
 require 'pp'
+# rubocop:enable Lint/RedundantRequireStatement
 require 'oxidized/web/mig'
 require 'htmlentities'
 require 'charlock_holmes'
 module Oxidized
   module API
+    require 'oxidized/web/version'
+
     class WebApp < Sinatra::Base
       helpers Sinatra::UrlForHelper
-      set :public_folder, Proc.new { File.join(root, 'public') }
+      set :public_folder, proc { File.join(root, 'public') }
+      set :haml, { escape_html: false }
 
       get '/' do
         redirect url_for('/nodes')
       end
 
+      get '/favicon.ico' do
+        redirect url_for('/images/favicon.ico')
+      end
+
       get '/nodes/:filter/:value.?:format?' do
         @data = nodes.list.select do |node|
-          if node[params[:filter].to_sym] == params[:value]
-            node[:status] = 'never'
-            node[:time]   = 'never'
-            node[:group]  = 'default' unless node[:group]
-            if node[:last]
-              node[:status] = node[:last][:status]
-              node[:time]   = node[:last][:end]
-            end
-            node
+          next unless node[params[:filter].to_sym] == params[:value]
+
+          node[:status] = 'never'
+          node[:time]   = 'never'
+          node[:group]  = 'default' unless node[:group]
+          if node[:last]
+            node[:status] = node[:last][:status]
+            node[:time]   = node[:last][:end]
           end
+          node
         end
         out :nodes
       end
@@ -54,9 +63,7 @@ module Oxidized
         nodes_list.each do |n|
           node, @json = route_parse n[:name]
           config = nodes.fetch node, n[:group]
-          if config[@to_research]
-            @nodes_match.push({ node: n[:name], full_name: n[:full_name] })
-          end
+          @nodes_match.push({ node: n[:name], full_name: n[:full_name] }) if config[@to_research]
         end
         @data = @nodes_match
         out :conf_search
@@ -71,40 +78,42 @@ module Oxidized
       end
 
       get '/reload.?:format?' do
-        nodes.load
-        @data = 'reloaded list of nodes'
+        node = params[:node]
+        node ? (nodes.load node) : nodes.load
+        @data = node ? "reloaded #{node}" : 'reloaded list of nodes'
         out
       end
 
-      get '/node/fetch/:node' do
+      # URL: /node/fetch/<group>/<node>.json
+      # Gets the configuration of a node
+      # <group> is optional. If no group is given, nil will be passed to oxidized
+      # .json is optional. If given, will return the output in json format
+      get '/node/fetch/?*?/:node' do
+        node, @json = route_parse :node
+        group = params['splat'].first
+        group = nil if group.empty?
         begin
-          node, @json = route_parse :node
-          @data = nodes.fetch node, nil
-        rescue NodeNotFound => error
-          @data = error.message
+          @data = nodes.fetch node, group
+        rescue NodeNotFound => e
+          @data = e.message
         end
         out :text
       end
 
-      get '/node/fetch/:group/:node' do
-        node, @json = route_parse :node
-        @data = nodes.fetch node, params[:group]
-        out :text
-      end
-
-      get '/node/next/?:group?/:node' do
+      # URL: /node/fetch/<group>/<node>.json
+      # <group> is optional, and not used
+      # .json is optional. If given, will return 'ok'
+      # if not, it redirects to /nodes
+      get '/node/next/?*?/:node' do
         node, @json = route_parse :node
-        begin
-          nodes.next node
-        rescue NodeNotFound
-        end
+        nodes.next node
         redirect url_for('/nodes') unless @json
         @data = 'ok'
         out
       end
 
       # use this to attach author/email/message to commit
-      put '/node/next/?:group?/:node' do
+      put '/node/next/?*?/:node' do
         node, @json = route_parse :node
         opt = JSON.load request.body.read
         nodes.next node, opt
@@ -130,12 +139,12 @@ module Oxidized
         cloginrc_file = params['cloginrc'][:tempfile]
         path_new_file = params['path_new_file']
 
-        router_db_files = Array.new
+        router_db_files = []
 
         i = 1
-        while i <= number do
+        while i <= number
           router_db_files.push({ file: params["file#{i}"][:tempfile], group: params["group#{i}"] })
-          i = i + 1
+          i += 1
         end
 
         migration = Mig.new(router_db_files, cloginrc_file, path_new_file)
@@ -143,10 +152,6 @@ module Oxidized
         redirect url_for('//nodes')
       end
 
-      get '/css/*.css' do
-        sass "sass/#{params[:splat].first}".to_sym
-      end
-
       # show the lists of versions for a node
       get '/node/version.?:format?' do
         @data = nil
@@ -177,9 +182,12 @@ module Oxidized
         }
 
         the_data = nodes.get_version node, @info[:group], @info[:oid]
-        detection = ::CharlockHolmes::EncodingDetector.detect(the_data)
-        utf8_encoded_content = ::CharlockHolmes::Converter.convert the_data, detection[:encoding], 'UTF-8'
-        @data = HTMLEntities.new.encode(utf8_encoded_content)
+        if params[:format] == 'json' || params[:format] == 'text'
+          @data = the_data
+        else
+          utf8_encoded_content = convert_to_utf8(the_data)
+          @data = HTMLEntities.new.encode(utf8_encoded_content)
+        end
         out :version
       end
 
@@ -187,11 +195,9 @@ module Oxidized
       get '/node/version/diffs' do
         node, @json = route_parse :node
         @data = nil
-        @info = {node: node, group: params[:group], oid: params[:oid], date: params[:date], num: params[:num], num2: (params[:num].to_i - 1)}
+        @info = { node: node, group: params[:group], oid: params[:oid], date: params[:date], num: params[:num], num2: (params[:num].to_i - 1) }
         group = nil
-        if @info[:group] != ''
-          group = @info[:group]
-        end
+        group = @info[:group] if @info[:group] != ''
         @oids_dates = nodes.version node, group
         if params[:oid2]
           @info[:oid2] = params[:oid2]
@@ -199,18 +205,18 @@ module Oxidized
           num = @oids_dates.count + 1
           @oids_dates.each do |x|
             num -= 1
-            if x[:oid].to_s == params[:oid2]
-              oid2 = x[:oid]
-              @info[:num2] = num
-              break
-            end
+            next unless x[:oid].to_s == params[:oid2]
+
+            oid2 = x[:oid]
+            @info[:num2] = num
+            break
           end
           @data = nodes.get_diff node, @info[:group], @info[:oid], oid2
         else
           @data = nodes.get_diff node, @info[:group], @info[:oid], nil
         end
-        @stat = ['null', 'null']
-        if @data != 'no diffs' && @data != nil
+        @stat = %w[null null]
+        if @data != 'no diffs' && !@data.nil?
           @stat = @data[:stat]
           @data = @data[:patch]
         else
@@ -227,14 +233,14 @@ module Oxidized
 
       private
 
-      def out template = :text
-        if @json or params[:format] == 'json'
+      def out(template = :text)
+        if @json || (params[:format] == 'json')
           if @data.is_a?(String)
             json @data.lines
           else
             json @data
           end
-        elsif template == :text or params[:format] == 'text'
+        elsif (template == :text) || (params[:format] == 'text')
           content_type :text
           @data
         else
@@ -246,13 +252,16 @@ module Oxidized
         settings.nodes
       end
 
-      def route_parse param
+      # checks if param ends with .json
+      # if so, returns param without ".json" and true
+      # if not, returns param and false
+      def route_parse(param)
         json = false
-        if param.respond_to?(:to_str)
-          e = param.split '.'
-        else
-          e = params[param].split '.'
-        end
+        e = if param.respond_to?(:to_str)
+              param.split '.'
+            else
+              params[param].split '.'
+            end
         if e.last == 'json'
           e.pop
           json = true
@@ -261,40 +270,37 @@ module Oxidized
       end
 
       # give the time enlapsed between now and a date
-      def time_from_now date
+      def time_from_now(date)
         if date
-          # if the + is missing
-          unless date.include? '+'
-            date.insert(21, '+')
-          end
+          # if the + or - is missing, insert +
+          date.insert(21, '+') unless date =~ /[-+]/
           date = DateTime.parse date
           now = DateTime.now.new_offset(0)
           t = ((now - date) * 24 * 60 * 60).to_i
           mm, ss = t.divmod(60)
           hh, mm = mm.divmod(60)
           dd, hh = hh.divmod(24)
-          if dd.positive?
-            date = "#{dd} days #{hh} hours ago"
-          elsif hh.positive?
-            date = "#{hh} hours #{mm} min ago"
-          else
-            date = "#{mm} min #{ss} sec ago"
-          end
+          date = if dd.positive?
+                   "#{dd} days #{hh} hours ago"
+                 elsif hh.positive?
+                   "#{hh} hours #{mm} min ago"
+                 else
+                   "#{mm} min #{ss} sec ago"
+                 end
         end
         date
       end
 
       # method the give diffs in separate view (the old and the new) as in github
-      def diff_view diff
+      def diff_view(diff)
         old_diff = []
         new_diff = []
 
-        detection = ::CharlockHolmes::EncodingDetector.detect(diff)
-        utf8_encoded_content = ::CharlockHolmes::Converter.convert diff, detection[:encoding], 'UTF-8'
+        utf8_encoded_content = convert_to_utf8(diff)
         HTMLEntities.new.encode(utf8_encoded_content).each_line do |line|
           if /^\+/.match(line)
             new_diff.push(line)
-          elsif /^\-/.match(line)
+          elsif /^-/.match(line)
             old_diff.push(line)
           else
             new_diff.push(line)
@@ -304,20 +310,16 @@ module Oxidized
 
         length_o = old_diff.count
         length_n = new_diff.count
-        for i in 0..[length_o, length_n].max
-          if i > [length_o, length_n].min
-            break
-          end
+        (0..[length_o, length_n].max).each do |i|
+          break if i > [length_o, length_n].min
 
-          if (/^\-.*/.match(old_diff[i])) && !(/^\+.*/.match(new_diff[i]))
+          if /^-.*/.match(old_diff[i]) && !/^\+.*/.match(new_diff[i])
             # tag removed latter to add color syntax
-            insert = 'empty_line'
             # ugly way to avoid asymmetry if at display the line takes 2 line on the screen
             insert = "&nbsp;\n"
             new_diff.insert(i, insert)
             length_n += 1
-          elsif !(/^\-.*/.match(old_diff[i])) && (/^\+.*/.match(new_diff[i]))
-            insert = 'empty_line'
+          elsif !/^-.*/.match(old_diff[i]) && /^\+.*/.match(new_diff[i])
             insert = "&nbsp;\n"
             old_diff.insert(i, insert)
             length_o += 1
@@ -325,6 +327,23 @@ module Oxidized
         end
         { old_diff: old_diff, new_diff: new_diff }
       end
+
+      # Taken von Haml 5.0, so it still works in 6.0
+      HTML_ESCAPE = { '&' => '&amp;', '<' => '&lt;', '>' => '&gt;', '"' => '&quot;', "'" => '&#39;' }.freeze
+      HTML_ESCAPE_ONCE_REGEX = /['"><]|&(?!(?:[a-zA-Z]+|#(?:\d+|[xX][0-9a-fA-F]+));)/
+      def escape_once(text)
+        text = text.to_s
+        text.gsub(HTML_ESCAPE_ONCE_REGEX, HTML_ESCAPE)
+      end
+
+      def convert_to_utf8(text)
+        detection = ::CharlockHolmes::EncodingDetector.detect(text)
+        if detection[:type] == :text
+          ::CharlockHolmes::Converter.convert text, detection[:encoding], 'UTF-8'
+        else
+          'The text contains binary values - cannot display'
+        end
+      end
     end
   end
 end

data/lib/oxidized/web.rb

@@ -3,18 +3,21 @@ require 'json'
 module Oxidized
   module API
     class Web
-      require 'rack/handler'
+      require 'rack/handler/puma'
       attr_reader :thread
-      Rack::Handler::WEBrick = Rack::Handler.get(:puma)
-      def initialize nodes, listen
+
+      def initialize(nodes, listen)
         require 'oxidized/web/webapp'
         listen, uri = listen.split '/'
         addr, _, port = listen.rpartition ':'
-        port, addr = addr, nil if not port
-        uri = '/' + uri.to_s
+        unless port
+          port = addr
+          addr = nil
+        end
+        uri = "/#{uri}"
         @opts = {
           Host: addr,
-          Port: port,
+          Port: port
         }
         WebApp.set :nodes, nodes
         @app = Rack::Builder.new do
@@ -26,7 +29,7 @@ module Oxidized
 
       def run
         @thread = Thread.new do
-          Rack::Handler::Puma.run @app, @opts
+          Rack::Handler::Puma.run @app, **@opts
           exit!
         end
       end

data/oxidized-web.gemspec

@@ -1,6 +1,10 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oxidized/web/version'
+
 Gem::Specification.new do |s|
   s.name              = 'oxidized-web'
-  s.version           = '0.13.0'
+  s.version           = Oxidized::API::WEB_VERSION
   s.licenses          = %w[Apache-2.0]
   s.platform          = Gem::Platform::RUBY
   s.authors           = ['Saku Ytti', 'Samer Abdel-Hafez']
@@ -8,26 +12,35 @@ Gem::Specification.new do |s|
   s.homepage          = 'http://github.com/ytti/oxidized-web'
   s.summary           = 'sinatra API + webUI for oxidized'
   s.description       = 'puma+sinatra+haml webUI + REST API for oxidized'
-  s.rubyforge_project = s.name
-  s.files             = %x(git ls-files).split("\n")
+  s.files             = %x(git ls-files -z).split("\x0")
   s.executables       = %w[]
   s.require_path      = 'lib'
 
-  s.required_ruby_version =                       '>= 2.3'
+  s.metadata['rubygems_mfa_required'] = 'true'
+
+  s.required_ruby_version =                       '>= 3.1'
+
   s.add_runtime_dependency 'charlock_holmes',     '~> 0.7.5'
   s.add_runtime_dependency 'emk-sinatra-url-for', '~> 0.2'
-  s.add_runtime_dependency 'haml',                '~> 5.0'
+  s.add_runtime_dependency 'haml',                '~> 6.0'
   s.add_runtime_dependency 'htmlentities',        '~> 4.3'
-  s.add_runtime_dependency 'oxidized',            '~> 0.26.0'
-  s.add_runtime_dependency 'puma',                '~> 3.11.4'
-  s.add_runtime_dependency 'sass',                '~> 3.3'
-  s.add_runtime_dependency 'sinatra',             '~> 1.4', '>= 1.4.6'
-  s.add_runtime_dependency 'sinatra-contrib',     '~> 1.4', '>= 1.4.6'
-  s.add_runtime_dependency 'json',                '>= 1.7.0'
-  s.add_runtime_dependency 'rack-test',           '~> 0.7.0'
+  s.add_runtime_dependency 'json',                '~> 2.3'
+  s.add_runtime_dependency 'oxidized',            '~> 0.26'
+  s.add_runtime_dependency 'puma',                '>= 3.11.4', '< 6.5.0'
+  s.add_runtime_dependency 'sinatra',             '>= 1.4.6', '< 5.0'
+  s.add_runtime_dependency 'sinatra-contrib',     '>= 1.4.6', '< 5.0'
 
-  s.add_development_dependency 'bundler',              '~> 2.0'
+  s.add_development_dependency 'bundler',              '~> 2.2'
+  s.add_development_dependency 'minitest',             '~> 5.18'
+  s.add_development_dependency 'mocha',                '~> 2.1'
+  s.add_development_dependency 'rack-test',            '~> 2.1'
   s.add_development_dependency 'rails_best_practices', '~> 1.19'
-  s.add_development_dependency 'rake',                 '~> 10.0'
-  s.add_development_dependency 'rubocop',              '~> 0.65.0'
+  s.add_development_dependency 'rake',                 '~> 13.0'
+  s.add_development_dependency 'rubocop',              '~> 1.64.1'
+  s.add_development_dependency 'rubocop-minitest',     '~> 0.35.0'
+  s.add_development_dependency 'rubocop-rails',        '~> 2.25.0'
+  s.add_development_dependency 'rubocop-rake',         '~> 0.6.0'
+  s.add_development_dependency 'simplecov',            '~> 0.22.0'
+  s.add_development_dependency 'simplecov-cobertura',  '~> 2.1.0'
+  s.add_development_dependency 'simplecov-html',       '~> 0.12.3'
 end

data/package-lock.json

@@ -0,0 +1,104 @@
+{
+  "name": "oxidized-web",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "oxidized-web",
+      "version": "1.0.0",
+      "license": "Apache 2.0",
+      "dependencies": {
+        "bootstrap": "^5.3.3",
+        "bootstrap-icons": "^1.11.3",
+        "datatables.net-bs5": "^2.0.7",
+        "datatables.net-buttons-bs5": "^3.0.2",
+        "jquery": "^3.7.1"
+      }
+    },
+    "node_modules/@popperjs/core": {
+      "version": "2.11.8",
+      "resolved": "https://registry.npmjs.org/@popperjs/core/-/core-2.11.8.tgz",
+      "integrity": "sha512-P1st0aksCrn9sGZhp8GMYwBnQsbvAWsZAX44oXNNvLHGqAOcoVxmjZiohstwQ7SqKnbR47akdNi+uleWD8+g6A==",
+      "peer": true,
+      "funding": {
+        "type": "opencollective",
+        "url": "https://opencollective.com/popperjs"
+      }
+    },
+    "node_modules/bootstrap": {
+      "version": "5.3.3",
+      "resolved": "https://registry.npmjs.org/bootstrap/-/bootstrap-5.3.3.tgz",
+      "integrity": "sha512-8HLCdWgyoMguSO9o+aH+iuZ+aht+mzW0u3HIMzVu7Srrpv7EBBxTnrFlSCskwdY1+EOFQSm7uMJhNQHkdPcmjg==",
+      "funding": [
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/twbs"
+        },
+        {
+          "type": "opencollective",
+          "url": "https://opencollective.com/bootstrap"
+        }
+      ],
+      "peerDependencies": {
+        "@popperjs/core": "^2.11.8"
+      }
+    },
+    "node_modules/bootstrap-icons": {
+      "version": "1.11.3",
+      "resolved": "https://registry.npmjs.org/bootstrap-icons/-/bootstrap-icons-1.11.3.tgz",
+      "integrity": "sha512-+3lpHrCw/it2/7lBL15VR0HEumaBss0+f/Lb6ZvHISn1mlK83jjFpooTLsMWbIjJMDjDjOExMsTxnXSIT4k4ww==",
+      "funding": [
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/twbs"
+        },
+        {
+          "type": "opencollective",
+          "url": "https://opencollective.com/bootstrap"
+        }
+      ]
+    },
+    "node_modules/datatables.net": {
+      "version": "2.0.8",
+      "resolved": "https://registry.npmjs.org/datatables.net/-/datatables.net-2.0.8.tgz",
+      "integrity": "sha512-4/2dYx4vl975zQqZbyoVEm0huPe61qffjBRby7K7V+y9E+ORq4R8KavkgrNMmIgO6cl85Pg4AvCbVjvPCIT1Yg==",
+      "dependencies": {
+        "jquery": ">=1.7"
+      }
+    },
+    "node_modules/datatables.net-bs5": {
+      "version": "2.0.8",
+      "resolved": "https://registry.npmjs.org/datatables.net-bs5/-/datatables.net-bs5-2.0.8.tgz",
+      "integrity": "sha512-rpz/yO2NZMP1Uso/sSsaFAKwdCjYPa1/KLxAVr0JNJJV9ygFLHcuKTcNmoc1cekcsjYcGyybWKaNu4NfpZ74vg==",
+      "dependencies": {
+        "datatables.net": "2.0.8",
+        "jquery": ">=1.7"
+      }
+    },
+    "node_modules/datatables.net-buttons": {
+      "version": "3.0.2",
+      "resolved": "https://registry.npmjs.org/datatables.net-buttons/-/datatables.net-buttons-3.0.2.tgz",
+      "integrity": "sha512-J+vk4hLtTivnl+RxzpKPE7CG4ggdgHPQcHnpqViy9w6ia18Uh69dQktX6NJ87QrqNPCTMUyHDzUzsRFURG4/Fw==",
+      "dependencies": {
+        "datatables.net": "^2",
+        "jquery": ">=1.7"
+      }
+    },
+    "node_modules/datatables.net-buttons-bs5": {
+      "version": "3.0.2",
+      "resolved": "https://registry.npmjs.org/datatables.net-buttons-bs5/-/datatables.net-buttons-bs5-3.0.2.tgz",
+      "integrity": "sha512-whufHsfKgzzdmTqM7JnFUph5hveHTCAvs9N0CP+5t7k7sIr7b94rIxv22/2Wt4veLcd3v73NdhPWl4j/GfzyhA==",
+      "dependencies": {
+        "datatables.net-bs5": "^2",
+        "datatables.net-buttons": "3.0.2",
+        "jquery": ">=1.7"
+      }
+    },
+    "node_modules/jquery": {
+      "version": "3.7.1",
+      "resolved": "https://registry.npmjs.org/jquery/-/jquery-3.7.1.tgz",
+      "integrity": "sha512-m4avr8yL8kmFN8psrbFFFmB/If14iN5o9nw/NgnnM+kybDJpRsAynV2BsfpTYrTRysYUdADVD7CkUUizgkpLfg=="
+    }
+  }
+}

data/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "oxidized-web",
+  "version": "1.0.0",
+  "description": "NPM Projekt to get dependent js and css libs",
+  "main": "index.js",
+  "directories": {
+    "lib": "lib"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "The oxidized project",
+  "license": "Apache 2.0",
+  "dependencies": {
+    "bootstrap": "^5.3.3",
+    "bootstrap-icons": "^1.11.3",
+    "datatables.net-bs5": "^2.0.7",
+    "datatables.net-buttons-bs5": "^3.0.2",
+    "jquery": "^3.7.1"
+  }
+}