repobrowse 0.0.0

data/lib/repobrowse/limit_rd.rb

@@ -0,0 +1,86 @@
+# -*- encoding: binary -*-
+# Copyright (C) 2017-2018 all contributors <repobrowse-public@80x24.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+# frozen_string_literal: false
+
+class Repobrowse::LimitRd
+  def initialize(rd, size, buf, &blk)
+    @rd = rd # git cat-file --batch output
+    @left = size == 0 ? nil : size
+    @buf = buf
+    @on_close = blk
+    @peek = nil
+  end
+
+  # called by Rack server in ensure
+  def close
+    @on_close&.call(self) # allows our @rd to be reused
+    @buf&.clear
+    @peek&.clear
+    @on_close = nil
+  end
+
+  # used to determine if a file is binary or text
+  def peek(len = 8000) # 8000 bytes is the same size used by git
+    @peek = read(len, @buf)
+  end
+
+  # called by Rack server
+  def each
+    peek, @peek = @peek, nil
+    yield peek if peek
+    while read(16384, @buf)
+      yield @buf
+    end
+  end
+
+  # non-Rack response body interface
+  def read(len = nil, buf = nil)
+    raise RuntimeError, 'not #read is compatible with #peek' if @peek
+    if @left
+      len = @left if len.nil? || len > @left
+      ret = @rd.read(len, buf)
+      @left -= ret.bytesize if ret
+      @left = nil if @left == 0
+      ret
+    else
+      buf&.clear
+      len ? nil : ''
+    end
+  end
+
+  # non-Rack response body interface
+  def gets(sep = $/, limit = nil, chomp: false)
+    if Integer === sep && limit.nil?
+      limit = sep
+      sep = $/
+    end
+    raise RuntimeError, 'not #read is compatible with #peek' if @peek
+    return if @left.nil?
+    return '' if limit == 0
+    limit = @left if limit.nil? || limit > @left
+    if limit == 0
+      @left = nil
+      return nil
+    end
+    buf = @rd.gets(sep, limit)
+    if buf
+      @left -= buf.bytesize
+      @left = nil if @left == 0
+
+      # we must chomp ourselves for accounting @left
+      buf.chomp!(sep) if chomp
+    end
+    buf
+  end
+
+  # we must drain the buffer if the reader aborted prematurely
+  def drain
+    n = @left or return
+    max = 16384
+    while n > 0
+      len = n > max ? max : n
+      @rd.read(len, @buf) and n -= @buf.bytesize
+    end
+  end
+end

data/lib/repobrowse/pipe_body.rb

@@ -0,0 +1,25 @@
+# -*- encoding: binary -*-
+# Copyright (C) 2017-2018 all contributors <repobrowse-public@80x24.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+# frozen_string_literal: true
+class Repobrowse::PipeBody
+  attr_reader :to_io
+
+  def initialize(io, buf)
+    @to_io = io
+    @buf = buf
+  end
+
+  # called by Rack server
+  def each
+    begin
+      yield @buf
+    end while @to_io.read(0x4000, @buf)
+  end
+
+  # called by Rack server
+  def close
+    @buf.clear
+    @to_io.close
+  end
+end

data/lib/repobrowse/repo.rb

@@ -0,0 +1,21 @@
+# Copyright (C) 2017-2018 all contributors <repobrowse-public@80x24.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+# frozen_string_literal: true
+#
+# class for represpenting an inbox git repository.
+class Repobrowse::Repo
+  attr_reader :driver
+  attr_reader :name
+  attr_reader :path
+  attr_reader :lineno_prefix
+
+  def initialize(opts)
+    @lineno_prefix = 'n' # 'l' for gitweb conversions
+    opts.each { |k, v| instance_variable_set "@#{k}", v }
+    case @vcs
+    when 'git'
+      @driver = Repobrowse::Git.new(@path)
+    end
+  end
+
+end

data/lib/repobrowse/static.rb

@@ -0,0 +1,96 @@
+# Copyright (C) 2017-2018 all contributors <repobrowse-public@80x24.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+# frozen_string_literal: true
+require_relative 'limit_rd'
+
+module Repobrowse::Static
+
+  # Rack response body
+  class F < File
+    def each
+      while buf = read(8192, buf)
+        yield buf
+      end
+    ensure
+      buf&.clear
+    end
+  end
+
+  def fopen(r, pathname)
+    F.open(pathname)
+  rescue SystemCallError
+    r404(r)
+  end
+
+  def prepare_range(env, r, fp, h, beg_s, fin_s, size)
+    code = 200
+    len = size
+    beg = beg_s.to_i
+    fin = fin_s.to_i
+    if beg_s == ''
+      if fin_s != '' # "bytes=-end" => last N bytes
+        beg = size - fin
+        beg = 0 if beg < 0
+        fin = size - 1
+        code = 206
+      else
+        code = 416
+      end
+    else
+      if beg > size
+        code = 416
+      elsif fin_s == '' || fin >= size
+        fin = size - 1
+        code = 206
+      elsif fin < size
+        code = 206
+      else
+        code = 416
+      end
+    end
+    if code == 206
+      len = fin - beg + 1;
+      if len <= 0
+        code = 416
+      else
+        # most Rack servers do not handle range requests correctly
+        # if they use .to_path
+        fp.autoclose = false
+        fp.seek(beg, IO::SEEK_SET) or r.halt [ 500, [], [] ]
+        fp = Repobrowse::LimitRd.new(fp, fin - beg + 1, ''.b)
+        h['Accept-Ranges'] = -'bytes'
+        h['Content-Range'] = "bytes #{beg}-#{fin}/#{size}"
+      end
+    end
+    if code == 416
+      h['Content-Range'] = -"bytes */#{size}"
+      r.halt [ 416, h, [] ]
+    end
+    [ code, len, fp ]
+  end
+
+  # expires in 1 year
+  def static(r, pathname, type, exp = 31536000)
+    r.get do
+      fp = fopen(r, pathname)
+      h = { 'Content-Type' => type }
+      if exp
+        h['Expires'] = -((Time.now + exp).httpdate)
+        h['Cache-Control'] = -"public, max-age=#{exp}"
+      else
+        h['Expires'] = 'Fri, 01 Jan 1980 00:00:00 GMT'
+        h['Pragma'] = 'no-cache'
+        h['Cache-Control'] = 'no-cache, max-age=0, must-revalidate'
+      end
+      # TODO: If-Modified-Since and Last-Modified?
+      code = 200
+      st = fp.stat
+      size = st.size
+      if env['HTTP_RANGE'] =~ /\bbytes=(\d*)-(\d*)\z/
+        code, size, fp = prepare_range(env, r, fp, h, $1, $2, size)
+      end
+      h['Content-Length'] = -size.to_s
+      r.halt [ code, h, fp ]
+    end
+  end
+end

data/repobrowse.gemspec

@@ -0,0 +1,29 @@
+git_manifest = `git ls-files 2>/dev/null`.split("\n")
+manifest = File.exist?('MANIFEST') ?
+  File.readlines('MANIFEST').map!(&:chomp).delete_if(&:empty?) : git_manifest
+if git_manifest[0] && manifest != git_manifest
+  tmp = "MANIFEST.#$$.tmp"
+  File.open(tmp, 'w') { |fp| fp.puts(git_manifest.join("\n")) }
+  File.rename(tmp, 'MANIFEST')
+  system('git add MANIFEST')
+end
+
+Gem::Specification.new do |s|
+  s.name = %q{repobrowse}
+  s.version = (ENV['VERSION'] || '0.0.0').dup
+  s.homepage = 'https://80x24.org/repobrowse/'
+  s.authors = ['repobrowse hackers']
+  s.description = File.read('README').split("\n\n")[1]
+  s.email = %q{repobrowse-public@80x24.org}
+  s.files = manifest
+  s.summary = File.readlines('README')[0]
+  s.test_files = Dir['test/test_*.rb']
+  s.add_development_dependency('test-unit', '~> 3.0')
+
+  # hope this gets into
+  s.add_dependency('roda', '~> 3.3')
+  # TODO: make rugged optional when we start supporting other VCS
+  s.add_dependency('rugged', '~> 0.24') # whatever's in Debian stretch
+  s.required_ruby_version = '>= 2.3'
+  s.licenses = %w(AGPL-3.0+)
+end

data/test/covshow.rb

@@ -0,0 +1,30 @@
+# Copyright (C) 2017-2018 all contributors <repobrowse-public@80x24.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+# frozen_string_literal: true
+#
+# this works with the __covmerge method in test/helper.rb
+# run this file after all tests are run
+
+# load the merged dump data
+res = Marshal.load(IO.binread("coverage.dump"))
+
+# Dirty little text formatter.  I tried simplecov but the default
+# HTML+JS is unusable without a GUI (I hate GUIs :P) and it would've
+# taken me longer to search the Internets to find a plain-text
+# formatter I like...
+res.keys.sort.each do |filename|
+  cov = res[filename]
+  puts "==> #{filename} <=="
+  File.readlines(filename).each_with_index do |line, i|
+    n = cov[i]
+    if n == 0 # BAD
+      print("  *** 0 #{line}")
+    elsif n
+      printf("% 7u %s", n, line)
+    elsif line =~ /\S/ # probably a line with just "end" in it
+      print("        #{line}")
+    else # blank line
+      print "\n" # don't output trailing whitespace on blank lines
+    end
+  end
+end

data/test/git.fast-import-data

@@ -0,0 +1,101 @@
+blob
+mark :1
+data 6
+hello
+
+reset refs/heads/header
+commit refs/heads/header
+mark :2
+author AU Thor <e@example.com> 0 +0000
+committer AU Thor <e@example.com> 0 +0000
+data 8
+initial
+M 100644 :1 foo.txt
+
+blob
+mark :3
+data 12
+hello
+world
+
+commit refs/heads/master
+mark :4
+author AU Thor <e@example.com> 0 +0000
+committer AU Thor <e@example.com> 0 +0000
+data 7
+second
+from :2
+M 100644 :3 foo.txt
+
+blob
+mark :5
+data 12
+-----
+hello
+
+commit refs/heads/header
+mark :6
+author AU Thor <e@example.com> 0 +0000
+committer AU Thor <e@example.com> 0 +0000
+data 11
+add header
+from :2
+M 100644 :5 foo.txt
+
+blob
+mark :7
+data 18
+-----
+hello
+world
+
+commit refs/heads/master
+mark :8
+author AU Thor <e@example.com> 0 +0000
+committer AU Thor <e@example.com> 0 +0000
+data 46
+Merge branch 'header'
+
+* header:
+  add header
+from :4
+merge :6
+M 100644 :7 foo.txt
+
+blob
+mark :9
+data 0
+
+blob
+mark :10
+data 16
+dir/dur/der/derp
+commit refs/heads/master
+mark :11
+author AU Thor <e@example.com> 0 +0000
+committer AU Thor <e@example.com> 0 +0000
+data 26
+add symlink and deep file
+from :8
+M 100644 :9 dir/dur/der/derp
+M 120000 :10 link
+
+blob
+mark :12
+data 78
+[submodule "git"]
+	path = git
+	url = git://git.kernel.org/pub/scm/git/git.git
+
+commit refs/heads/master
+mark :13
+author AU Thor <e@example.com> 0 +0000
+committer AU Thor <e@example.com> 0 +0000
+data 18
+add git submodule
+from :11
+M 100644 :12 .gitmodules
+M 160000 f3adf457e046f92f039353762a78dcb3afb2cb13 git
+
+reset refs/heads/master
+from :13

data/test/helper.rb

@@ -0,0 +1,182 @@
+# Copyright (C) 2017-2018 all contributors <repobrowse-public@80x24.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+# frozen_string_literal: true
+$-w = $stdout.sync = $stderr.sync = Thread.abort_on_exception = true
+
+# fork-aware coverage data gatherer, see also test/covshow.rb
+if ENV["COVERAGE"]
+  require "coverage"
+  COVMATCH = %r{\brepobrowse\b}
+  COVDUMPFILE = File.expand_path("coverage.dump")
+
+  def __covmerge
+    res = Coverage.result
+
+    # do not create the file, Makefile does this before any tests run
+    File.open(COVDUMPFILE, IO::RDWR) do |covtmp|
+      covtmp.binmode
+      covtmp.sync = true
+
+      # we own this file (at least until somebody tries to use NFS :x)
+      covtmp.flock(File::LOCK_EX)
+
+      prev = covtmp.read
+      prev = prev.empty? ? {} : Marshal.load(prev)
+      res.each do |filename, counts|
+        # filter out stuff that's not in our project
+        COVMATCH =~ filename or next
+
+        # For compatibility with https://bugs.ruby-lang.org/issues/9508
+        # TODO: support those features if that gets merged into mainline
+        unless Array === counts
+          counts = counts[:lines]
+        end
+
+        merge = prev[filename] || []
+        merge = merge
+        counts.each_with_index do |count, i|
+          count or next
+          merge[i] = (merge[i] || 0) + count
+        end
+        prev[filename] = merge
+      end
+      covtmp.rewind
+      covtmp.truncate(0)
+      covtmp.write(Marshal.dump(prev))
+      covtmp.flock(File::LOCK_UN)
+    end
+  end
+
+  Coverage.start
+  require 'test/unit'
+  Test::Unit.at_exit { __covmerge }
+else
+  require 'test/unit'
+end
+require 'thread'
+require 'fileutils'
+require 'tempfile'
+require 'tmpdir'
+require 'webrick'
+require 'repobrowse'
+
+def git_tmp_repo
+  Dir.mktmpdir do |tmp_dir|
+    git_dir = "#{tmp_dir}/tmp.git"
+    assert(system(*%W(git init -q --bare #{git_dir})), 'initialize git dir')
+    assert(system(*%W(git --git-dir=#{git_dir} fast-import --quiet),
+           in: "#{File.dirname(__FILE__)}/git.fast-import-data"),
+           'fast-import test repo')
+    projects = { 'repo.tmp.path' => git_dir }
+    @app = Rack::Builder.new { run Repobrowse::App.new(projects) }.to_app
+    @req = Rack::MockRequest.new(@app)
+    yield tmp_dir, git_dir
+  end
+end
+
+def rack_server(app)
+  readyq = Queue.new
+  logq = Queue.new
+  host = '127.0.0.1'
+  config = {
+    Logger: WEBrick::Log.new(logq),
+    app: app,
+    Host: host,
+    Port: 0, # WEBrick will choose a random port
+    server: 'webrick',
+  }
+  config[:AccessLog] = [] unless test_verbose?
+
+  th = Thread.new do
+    srv = Rack::Server.new(config)
+    srv.start { |s| readyq.push(s) }
+  end
+  s = readyq.pop
+  assert_instance_of WEBrick::HTTPServer, s
+
+  # grab the random port chosen by WEBrick
+  case l = logq.pop
+  when / port=(\d+)\n/
+    port = $1.to_i
+    break
+  end while true
+
+  Thread.new do
+    while l = logq.pop
+      warn "W: #{l.inspect}"
+    end
+  end if test_verbose?
+
+  yield logq, host, port
+ensure
+  s&.shutdown
+  th&.join
+end
+
+def test_verbose?
+  ENV['TEST_VERBOSE'].to_i != 0
+end
+
+# Rack::MockRequest doesn't always work since it converts the
+# response into an array without dup-ing Strings, so response
+# bodies which reuse a buffer (when they assume they're writing
+# to a socket) fail
+def req(method, uri, opts = {})
+  o = { method: method }.merge!(opts)
+  env = @req.class.env_for(uri, o)
+  @app.call(env)
+end
+
+def body_string(body)
+  rv = ''.b
+  body.each { |chunk| rv << chunk }
+  rv
+ensure
+  body.close if body.respond_to?(:close)
+end
+
+$tidy = nil
+def tidy_check(input)
+  if $tidy.nil?
+    case v = `tidy --version 2>/dev/null`
+    when /version (\d+)\.\d+\.\d+/ # HTML Tidy for Linux/x86 version 5.2.0
+      major = $1.to_i
+      $tidy = major
+    when ''
+      $tidy = false
+    else # "HTML Tidy for Linux released on 25 March 2009"
+      $tidy = 4
+    end
+  end
+  if $tidy == false
+    begin
+      body.each { |buf| assert_instance_of(String, buf) }
+    ensure
+      body.close
+    end
+  else
+    rd, wr = IO.pipe
+    th = Thread.new(input) do |body|
+      begin
+        first = true
+        body.each do |chunk|
+          if first && $tidy < 5 # HTML5 allows optional type
+            first = false
+            chunk = chunk.sub(/<style>/, '<style type="application/css">')
+          end
+          wr.write(chunk)
+        end
+      ensure
+        wr.close
+        body.close
+      end
+    end
+    pid = spawn("tidy -q", in: rd, out: IO::NULL)
+    _, status = Process.waitpid2(pid)
+    assert_predicate status, :success?, status.inspect
+  end
+ensure
+  th&.join
+  rd&.close
+  wr&.close
+end