repobrowse 0.0.0

data/GNUmakefile

@@ -0,0 +1,38 @@
+# Copyright (C) 2013-2018 all contributors <repobrowse-public@80x24.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+all::
+rubybin := $(shell which ruby)
+RUBY = $(rubybin)
+lib := lib
+
+# support using eatmydata to speed up tests (apt-get install eatmydata):
+# https://www.flamingspork.com/projects/libeatmydata/
+EATMYDATA =
+-include config.mak
+
+ifeq ($(RUBY_TEST_OPTS),)
+  ifeq ($(V),1)
+    RUBY_TEST_OPTS := -v
+  endif
+endif
+
+all:: test
+test_units := $(wildcard test/test_*.rb)
+test: $(test_units)
+$(test_units):
+	$(EATMYDATA) $(RUBY) -w -I $(lib) $@ $(RUBY_TEST_OPTS)
+
+check-warnings:
+	@(for i in $$(git ls-files '*.rb'| grep -v '^setup\.rb$$'); \
+	  do $(RUBY) -d -W2 -c $$i; done) | grep -v '^Syntax OK$$' || :
+
+check: test
+
+coverage: export COVERAGE=1
+coverage:
+	>coverage.dump
+	$(MAKE) check
+	$(RUBY) ./test/covshow.rb
+
+.PHONY: all test $(test_units) NEWS
+.PHONY: check-warnings fix-perms

data/MANIFEST

@@ -0,0 +1,42 @@
+.gitattributes
+.gitignore
+COPYING
+GNUmakefile
+MANIFEST
+README
+TODO
+lib/repobrowse.rb
+lib/repobrowse/app.rb
+lib/repobrowse/config.rb
+lib/repobrowse/error.rb
+lib/repobrowse/escape.rb
+lib/repobrowse/git.rb
+lib/repobrowse/git_atom.rb
+lib/repobrowse/git_commit_html.rb
+lib/repobrowse/git_disambiguate.rb
+lib/repobrowse/git_http_backend.rb
+lib/repobrowse/git_log.rb
+lib/repobrowse/git_patch.rb
+lib/repobrowse/git_raw.rb
+lib/repobrowse/git_raw_tree_html.rb
+lib/repobrowse/git_show.rb
+lib/repobrowse/git_src.rb
+lib/repobrowse/git_src_blob_html.rb
+lib/repobrowse/git_src_tree_html.rb
+lib/repobrowse/html.rb
+lib/repobrowse/limit_rd.rb
+lib/repobrowse/pipe_body.rb
+lib/repobrowse/repo.rb
+lib/repobrowse/static.rb
+repobrowse.gemspec
+test/covshow.rb
+test/git.fast-import-data
+test/helper.rb
+test/test_config.rb
+test/test_git.rb
+test/test_git_atom.rb
+test/test_git_clone.rb
+test/test_git_patch.rb
+test/test_git_raw_tree_html.rb
+test/test_git_show.rb
+test/test_html.rb

data/README

@@ -0,0 +1,35 @@
+repobrowse - old-fashioned repository browser
+---------------------------------------------
+
+A repository browser with only basic HTML and text; free of
+images and JavaScript.  It is intended as a companion to
+public-inbox[1] but may be used on its own.  It only supports
+git for now, but support for other Free Software version control
+systems may happen.
+
+Features
+--------
+
+* low bandwidth usage
+* git smart HTTP clone/fetch support
+* optional public-inbox integration
+
+[1] public-inbox is an "archives first" approach to mailing lists
+    https://public-inbox.org/
+
+Contact
+-------
+
+All discussion is archived via public-inbox:
+
+	https://80x24.org/repobrowse-public/
+	nntp://80x24.org/inbox.comp.version-control.repobrowse
+
+No subscription will ever be required to mail us, but HTML mail
+will be rejected:
+
+		repobrowse-public@80x24.org
+
+
+repobrowse is Copyright (C) 2018 all contributors <repobrowse-public@80x24.org>
+License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>

data/lib/repobrowse.rb

@@ -0,0 +1,7 @@
+# -*- 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
+
+Repobrowse = Module.new # :nodoc:
+require_relative 'repobrowse/app'

data/lib/repobrowse/app.rb

@@ -0,0 +1,60 @@
+# -*- 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
+require_relative 'error'
+require_relative 'static'
+require_relative 'git_http_backend'
+require_relative 'config'
+require 'roda'
+
+module Repobrowse::App
+
+  # main entry point for rackup config.ru files
+  def self.new(config)
+    case config
+    when Hash, String, nil
+      config = Repobrowse::Config.new(config)
+    end
+
+    # allow multiple instances of our app:
+    c = Class.new(Roda)
+    c.class_eval do
+      include Repobrowse::Error
+      include Repobrowse::Static
+      include Repobrowse::GitHTTPBackend
+      plugin :symbol_matchers
+      plugin :streaming
+      plugin :head
+
+      symbol_matcher :git_pack, %r{(pack-[a-f0-9]{40,}\.pack)}
+      symbol_matcher :git_pack_idx, %r{(pack-[a-f0-9]{40,}\.idx)}
+      symbol_matcher :git_x2, %r{([a-f0-9]{2})}
+      symbol_matcher :git_x38, %r{([a-f0-9]{38,})}
+      symbol_matcher :patch, %r{([a-f0-9]{7,})\.patch}
+      symbol_matcher :show, %r{([a-f0-9]{7,})}
+      symbol_matcher :tree_path, %r{([^:]+)(?::(.+))?}
+
+      route do |r|
+        config.repos.each_value do |repo|
+          r.on(repo.name) do
+            git_http_backend_routes(r, repo)
+            r.is { r.get { repo.driver.summary(r, repo) } }
+            r.is('src', :tree_path) { |ref, path|
+              r.get { repo.driver.src(r, repo, ref, path) }
+            }
+            r.is('raw', :tree_path) { |ref, path|
+              r.get { repo.driver.raw(r, repo, ref, path) }
+            }
+            r.is(:show) { |x| r.get { repo.driver.show(r, repo, x) } }
+            r.is(:patch) { |x| r.get { repo.driver.patch(r, repo, x) } }
+            r.is('atom', :tree_path) { |ref, path|
+              r.get { repo.driver.atom(r, repo, ref, path) }
+            }
+          end # r.on
+        end # projects.each
+      end # ret.route
+    end
+    c.freeze.app
+  end # self.new
+end

data/lib/repobrowse/config.rb

@@ -0,0 +1,66 @@
+# -*- 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
+require_relative 'repo'
+require_relative 'git'
+
+class Repobrowse::Config
+  attr_reader :repos
+
+  def initialize(file = ENV['REPOBROWSE_CONFIG'] ||
+                        File.expand_path('~/.repobrowse/config'))
+    @groups = Hash.new { |h,k| h[k] = [] }
+    if Hash === file
+      raw = file
+    else
+      raw = {}
+      if File.exist?(file)
+        cfg = Rugged::Config.new(file)
+        cfg.each_key { |k| raw[-k] = cfg.get_all(k) }
+      end
+    end
+    raw[:snapshots] ||= '-tar.bz2 -tar.xz'
+    raw[:groups] = { hidden: [], none: [] }
+    @raw = raw
+    @repos = {}
+    raw.each do |k, v|
+      v = Array(v)
+      case k
+      when %r{\Arepo\.(.+)\.path\z}
+        repo_name = -$1
+        warn "multiple values defined for #{k.inspect}\n" if v.size > 1
+        path = v[-1]
+        add_repo(repo_name, path)
+      end
+    end
+  end
+
+  def add_repo(repo_name, path) # repo_name "git.git"
+    rv = { path: path, name: repo_name }
+    rv[:snapshot_pfx] = -path.split(%r{/+})[-1].chomp('.git')
+    %i[ vcs readme group snapshots ].each do |key|
+      rv[key] = @raw["repo.#{repo_name}.#{key}"]
+    end
+    rv[:snapshots] ||= @raw[:snapshots]
+    rv[:snapshots_disabled] = disabled = {}
+    rv[:snapshots].split(/\s+/n).each do |type|
+      # "-tar.bz2", "-" prefix denotes disabled
+      type.sub!(/\A-/, '') and
+        disabled[type] = true
+    end
+    group = rv[:group] ||= :none
+    case group
+    when Array
+      Array(group).each { |g| @groups[g] << repo_name }
+    else
+      @groups[group] << repo_name
+    end
+    snap = repo_name.split('/')[-1]
+    if (rv[:vcs] ||= 'git') == 'git'
+      snap.chomp!('.git') # seems common for git URLs to end in ".git"
+    end
+    rv[:snapshot_re] = %r{\A\Q#{Regexp.escape(snap)}[-_]}
+    @repos[repo_name] = Repobrowse::Repo.new(rv)
+  end
+end

data/lib/repobrowse/error.rb

@@ -0,0 +1,21 @@
+# -*- 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
+
+module Repobrowse::Error
+  def r_err(r, msg)
+    r.env['rack.logger']&.error(msg)
+    b = "Internal server error\n"
+    r.halt [ 500, { 'Content-Type' => 'text/plain; charset=UTF-8' }, [ b ] ]
+  end
+
+  def r404(r)
+    b = "Not Found\n"
+    h = {
+      'Content-Type' => -'text/plain; charset=UTF-8',
+      'Content-Length' => -(b.size.to_s),
+    }
+    r.halt [ 404, h, [ b ] ]
+  end
+end

data/lib/repobrowse/escape.rb

@@ -0,0 +1,28 @@
+# -*- 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
+require 'cgi'
+
+module Repobrowse::Escape
+  # like format_sanitized_subject in git.git pretty.c with '%f' format string
+  def to_filename(str)
+    str = str.sub(/\n.*\z/s, '')
+    str.gsub!(/[^A-Za-z0-9_\.]+/, '-')
+    str.squeeze!('.')
+    str.sub!(/[\.\-]+\z/, '')
+    str.sub!(/\A[\.\-]+/, '')
+    str
+  end
+
+  def xt(str)
+    str.encode!(xml: :text)
+  end
+
+  def xa(str)
+    str.encode!(xml: :attr)
+  end
+
+  alias ha xa
+  alias ht xt
+end

data/lib/repobrowse/git.rb

@@ -0,0 +1,71 @@
+# -*- 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
+#
+require_relative 'git_show'
+require_relative 'git_patch'
+require_relative 'git_raw'
+require_relative 'git_src'
+require_relative 'git_atom'
+require 'rugged'
+
+class Repobrowse::Git
+  GIT_ESC = {
+    '\\a' => "\a",
+    '\\b' => "\b",
+    '\\f' => "\f",
+    '\\n' => "\n",
+    '\\r' => "\r",
+    '\\t' => "\t",
+    '\\v' => "\013",
+  }.freeze
+
+  def initialize(git_dir)
+    @git_dir = -git_dir
+  end
+
+  def rugged
+    Thread.current["rgd.#@git_dir".to_sym] ||= Rugged::Repository.new(@git_dir)
+  end
+
+  def description
+    s = File.open("#@git_dir/description", &:read)
+    s.strip!
+    -s
+  rescue
+    '[error reading $GIT_DIR/description]'
+  end
+
+  def cloneurl
+    File.open("#@git_dir/cloneurl", &:readlines).map! { |s| s.strip!; -s }
+  rescue
+    '[error reading $GIT_DIR/cloneurl]'
+  end
+
+  def popen(argv, encoding: Encoding::ASCII_8BIT)
+    cmd = %w(git).concat(argv)
+    IO.popen(cmd, chdir: @git_dir, encoding: encoding)
+  end
+
+  def tip
+    rugged.head.name
+  rescue
+    '[error running git symbolic-ref --short HEAD]'
+  end
+
+  def git_unquote(s)
+    return s unless s =~ /\A"(.*)"\z/n
+    s = $1
+    s.gsub!(/\\[abfnrtv]/n, GIT_ESC)
+    s.gsub!(/\\([0-7]{1,3})/n) { $1.oct.chr }
+    s
+  end
+
+  include Repobrowse::Error
+  include Repobrowse::GitShow
+  include Repobrowse::GitPatch
+  include Repobrowse::GitRaw
+  include Repobrowse::GitAtom
+  include Repobrowse::GitSrc
+end

data/lib/repobrowse/git_atom.rb

@@ -0,0 +1,109 @@
+# -*- 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
+
+module Repobrowse::GitAtom
+  DATEFMT = '%Y-%m-%dT%H:%M:%SZ'
+
+  # running git-log(1) here for now, path-limiting with libgit2|rugged
+  # seems like a pain to implement
+  ATOM_ARGV = %W(log --no-notes --no-color --no-abbrev --encoding=UTF-8
+                 --pretty=tformat:%#{%w(H s ct an ae at b).join('%n%')}%x00)
+
+  class Body
+    include Repobrowse::Error
+    include Repobrowse::Escape
+
+    def initialize(rd, r, repo, ref, path)
+      @rd = rd
+      title = xt(+"#{repo.name} #{ref} #{path || '/'}")
+      subtitle = xt(repo.driver.description.dup)
+      @url = "#{r.base_url}#{r.script_name}/#{repo.name}"
+      # read the first entry to ensure we have something
+      updated = +''
+      tmp = entry_begin(updated) or r404(r)
+
+      @buf = +<<~EOF
+        <?xml version="1.0"?><feed
+        xmlns="http://www.w3.org/2005/Atom"><title>#{
+        title}</title><subtitle>#{
+        subtitle}</subtitle><link
+        rel="alternate"
+        type="text/html"
+        href=#{xa(@url.dup)}
+        /><id>#{
+          xt("#@url/log/" + ref)
+        }</id><updated>#{updated}</updated>
+      EOF
+
+      @buf << tmp
+    end
+
+    def entry_begin(updated = +'')
+      x40 = @rd.gets(chomp: true) or return
+      +<<~EOF
+        <entry><title>#{ # %s
+          xt(@rd.gets(chomp: true))
+        }</title><updated>#{ # %ct
+          updated.replace(Time.at(@rd.gets.to_i).strftime(DATEFMT))
+        }</updated><author><name>#{ # %an
+          xt(@rd.gets(chomp: true))
+        }</name><email>#{ # %ae
+          xt(@rd.gets(chomp: true))
+        }</email></author><published>#{ # %at
+          Time.at(@rd.gets.to_i).strftime(DATEFMT)
+        }</published><link
+        rel="alternate"
+        type="text/html"
+        href=#{xa("#@url/" + x40)
+        }/><id>#{x40}</id><content
+        type="xhtml"><div
+        xmlns="http://www.w3.org/1999/xhtml"><pre
+        style="white-space:pre-wrap">
+      EOF
+    end
+
+    def entry_body
+      tmp = @rd.gets("\0\n", chomp: true)
+      tmp.strip!
+      xt(tmp)
+    end
+
+    def each
+      entry_end = '</pre></div></content></entry>'
+      tmp = @buf
+      @buf = nil
+      yield tmp
+      tmp.clear
+      tmp = entry_body
+      yield tmp
+      tmp.clear
+      yield entry_end
+      while tmp = entry_begin
+        yield tmp
+        tmp.clear
+        tmp = entry_body
+        yield tmp
+        tmp.clear
+        yield entry_end
+      end
+      yield '</feed>'
+    end
+
+    def close
+      @rd.close
+    end
+  end
+
+  # /$REPO_NAME/atom/$REF:PATH
+  def atom(r, repo, ref, path)
+    git_disambiguate(r, repo, 'atom', ref, path)
+    max = 50
+    argv = [ *ATOM_ARGV, *%W(-#{max} #{ref} --) ]
+    argv << path if path
+    rd = repo.driver.popen(argv)
+    body = Body.new(rd, r, repo, ref, path)
+    r.halt([ 200, { 'Content-Type' => 'application/atom+xml' }, body ])
+  end
+end