gollum-lib 4.0.3-java

data/docs/sanitization.md

@@ -0,0 +1,33 @@
+Sanitization Rules
+==================
+
+Gollum uses the [Sanitize](http://wonko.com/post/sanitize) gem for HTML
+sanitization.
+
+See `lib/gollum-lib/sanitization.rb` for actual settings.
+
+## ALLOWED TAGS
+
+a, abbr, acronym, address, area, b, big, blockquote, br, button, caption,
+center, cite, code, col, colgroup, dd, del, dfn, dir, div, dl, dt, em,
+fieldset, font, form, h1, h2, h3, h4, h5, h6, hr, i, img, input, ins, kbd,
+label, legend, li, map, menu, ol, optgroup, option, p, pre, q, s, samp,
+select, small, span, strike, strong, sub, sup, table, tbody, td, textarea,
+tfoot, th, thead, tr, tt, u, ul, var
+
+## ALLOWED ATTRIBUTES
+
+abbr, accept, accept-charset, accesskey, action, align, alt, axis, border,
+cellpadding, cellspacing, char, charoff, charset, checked, cite, class, clear,
+cols, colspan, color, compact, coords, datetime, dir, disabled, enctype, for,
+frame, headers, height, href, hreflang, hspace, id, ismap, label, lang,
+longdesc, maxlength, media, method, multiple, name, nohref, noshade, nowrap,
+prompt, readonly, rel, rev, rows, rowspan, rules, scope, selected, shape,
+size, span, src, start, summary, tabindex, target, title, type, usemap,
+valign, value, vspace, width
+
+## ALLOWED PROTOCOLS
+
+a href: http, https, mailto, ftp, irc, apt
+img src: http, https
+form action: http, https

data/gemspec.rb

@@ -0,0 +1,100 @@
+def specification(version, default_adapter, platform = nil)
+  Proc.new do |s|
+    s.specification_version = 2 if s.respond_to? :specification_version=
+    s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+    s.rubygems_version = '0.0.1'
+    s.required_ruby_version = '>= 1.9'
+
+    s.name              = 'gollum-lib'
+    s.version           = version
+    s.platform          = platform if platform
+    s.date              = '2015-04-10'
+    s.rubyforge_project = 'gollum-lib'
+    s.license           = 'MIT'
+
+    s.summary     = 'A simple, Git-powered wiki.'
+    s.description = 'A simple, Git-powered wiki with a sweet API and local frontend.'
+
+    s.authors  = ['Tom Preston-Werner', 'Rick Olson']
+    s.email    = 'tom@github.com'
+    s.homepage = 'http://github.com/gollum/gollum-lib'
+
+    s.require_paths = %w[lib]
+
+    s.rdoc_options = ['--charset=UTF-8']
+    s.extra_rdoc_files = %w[README.md LICENSE]
+
+    s.add_dependency *default_adapter
+    s.add_dependency 'rouge', '~> 1.7.4'
+    s.add_dependency 'nokogiri', '~> 1.6.4'
+    s.add_dependency 'stringex', '~> 2.5.1'
+    s.add_dependency 'sanitize', '~> 2.1.0'
+    s.add_dependency 'github-markup', '~> 1.3.3'
+
+    s.add_development_dependency 'org-ruby', '~> 0.9.9'
+    s.add_development_dependency 'kramdown', '~> 1.6.0'
+    s.add_development_dependency 'RedCloth', '~> 4.2.9'
+    s.add_development_dependency 'mocha', '~> 1.1.0'
+    s.add_development_dependency 'shoulda', '~> 3.5.0'
+    s.add_development_dependency 'wikicloth', '~> 0.8.3'
+    s.add_development_dependency 'rake', '~> 10.4.0'
+    s.add_development_dependency 'pry', '~> 0.10.1'
+    # required by pry
+    s.add_development_dependency 'rb-readline', '~> 0.5.1'
+    # updating minitest-reporters requires a new minitest which fails with gollum's tests.
+    s.add_development_dependency 'minitest-reporters', '~> 0.14.16'
+    s.add_development_dependency 'nokogiri-diff', '~> 0.2.0'
+    # required by guard
+    s.add_development_dependency 'guard', '~> 2.8.2'
+    s.add_development_dependency 'guard-minitest', '~> 2.3.2'
+    s.add_development_dependency 'rb-inotify', '~> 0.9.3'
+    s.add_development_dependency 'rb-fsevent', '~> 0.9.4'
+    s.add_development_dependency 'rb-fchange', '~> 0.0.6'
+    s.add_development_dependency 'twitter_cldr', '~> 3.1.0'
+    # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    HISTORY.md
+    LICENSE
+    README.md
+    Rakefile
+    docs/sanitization.md
+    gemspec.rb
+    gollum-lib.gemspec
+    gollum-lib_java.gemspec
+    lib/gollum-lib.rb
+    lib/gollum-lib/blob_entry.rb
+    lib/gollum-lib/committer.rb
+    lib/gollum-lib/file.rb
+    lib/gollum-lib/file_view.rb
+    lib/gollum-lib/filter.rb
+    lib/gollum-lib/filter/code.rb
+    lib/gollum-lib/filter/macro.rb
+    lib/gollum-lib/filter/metadata.rb
+    lib/gollum-lib/filter/plain_text.rb
+    lib/gollum-lib/filter/remote_code.rb
+    lib/gollum-lib/filter/render.rb
+    lib/gollum-lib/filter/sanitize.rb
+    lib/gollum-lib/filter/tags.rb
+    lib/gollum-lib/filter/toc.rb
+    lib/gollum-lib/filter/wsd.rb
+    lib/gollum-lib/git_access.rb
+    lib/gollum-lib/gitcode.rb
+    lib/gollum-lib/helpers.rb
+    lib/gollum-lib/hook.rb
+    lib/gollum-lib/macro.rb
+    lib/gollum-lib/macro/all_pages.rb
+    lib/gollum-lib/markup.rb
+    lib/gollum-lib/markups.rb
+    lib/gollum-lib/page.rb
+    lib/gollum-lib/pagination.rb
+    lib/gollum-lib/sanitization.rb
+    lib/gollum-lib/version.rb
+    lib/gollum-lib/wiki.rb
+    licenses/licenses.txt
+  ]
+  # = MANIFEST =
+
+    s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+  end
+end

data/gollum-lib.gemspec

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__), 'gemspec.rb')
+require File.join(File.dirname(__FILE__), 'lib', 'gollum-lib', 'version.rb')
+default_adapter = ['gollum-grit_adapter', '~> 1.0']
+Gem::Specification.new &specification(Gollum::Lib::VERSION, default_adapter)

data/gollum-lib_java.gemspec

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__), 'gemspec.rb')
+require File.join(File.dirname(__FILE__), 'lib', 'gollum-lib', 'version.rb')
+default_adapter = ['gollum-rjgit_adapter', '~> 0.1']
+Gem::Specification.new &specification(Gollum::Lib::VERSION, default_adapter, "java")

data/lib/gollum-lib.rb

@@ -0,0 +1,64 @@
+# ~*~ encoding: utf-8 ~*~
+# stdlib
+require 'digest/md5'
+require 'digest/sha1'
+require 'ostruct'
+
+DEFAULT_ADAPTER = RUBY_PLATFORM == 'java' ? 'rjgit_adapter' : 'grit_adapter'
+
+if defined?(Gollum::GIT_ADAPTER)
+  require "#{Gollum::GIT_ADAPTER.downcase}_adapter"
+else
+  require DEFAULT_ADAPTER
+end
+
+# external
+require 'github/markup'
+require 'sanitize'
+
+# internal
+require File.expand_path('../gollum-lib/git_access', __FILE__)
+require File.expand_path('../gollum-lib/hook', __FILE__)
+require File.expand_path('../gollum-lib/committer', __FILE__)
+require File.expand_path('../gollum-lib/pagination', __FILE__)
+require File.expand_path('../gollum-lib/blob_entry', __FILE__)
+require File.expand_path('../gollum-lib/wiki', __FILE__)
+require File.expand_path('../gollum-lib/page', __FILE__)
+require File.expand_path('../gollum-lib/macro', __FILE__)
+require File.expand_path('../gollum-lib/file', __FILE__)
+require File.expand_path('../gollum-lib/file_view', __FILE__)
+require File.expand_path('../gollum-lib/markup', __FILE__)
+require File.expand_path('../gollum-lib/markups', __FILE__)
+require File.expand_path('../gollum-lib/sanitization', __FILE__)
+require File.expand_path('../gollum-lib/filter', __FILE__)
+
+# Set ruby to UTF-8 mode
+# This is required for Ruby 1.8.7 which gollum still supports.
+$KCODE = 'U' if RUBY_VERSION[0, 3] == '1.8'
+
+module Gollum
+
+  def self.assets_path
+    ::File.expand_path('gollum/frontend/public', ::File.dirname(__FILE__))
+  end
+
+  class Error < StandardError; end
+
+  class DuplicatePageError < Error
+    attr_accessor :dir
+    attr_accessor :existing_path
+    attr_accessor :attempted_path
+
+    def initialize(dir, existing, attempted, message = nil)
+      @dir            = dir
+      @existing_path  = existing
+      @attempted_path = attempted
+      super(message || "Cannot write #{@dir}/#{@attempted_path}, found #{@dir}/#{@existing_path}.")
+    end
+  end
+
+  class InvalidGitRepositoryError < StandardError; end
+  class NoSuchPathError < StandardError; end
+
+end
+

data/lib/gollum-lib/blob_entry.rb

@@ -0,0 +1,95 @@
+# ~*~ encoding: utf-8 ~*~
+module Gollum
+  class BlobEntry
+    # Gets the String SHA for this blob.
+    attr_reader :sha
+
+    # Gets the full path String for this blob.
+    attr_reader :path
+
+    # Gets the Fixnum size of this blob.
+    attr_reader :size
+
+    # Gets the Fixnum mode of this blob.
+    attr_reader :mode
+
+    def initialize(sha, path, size = nil, mode = nil)
+      @sha  = sha
+      @path = path
+      @size = size
+      @mode = mode
+      @dir  = @name = @blob = nil
+    end
+
+    # Gets the normalized directory path String for this blob.
+    def dir
+      @dir ||= self.class.normalize_dir(::File.dirname(@path))
+    end
+
+    # Gets the file base name String for this blob.
+    def name
+      @name ||= ::File.basename(@path)
+    end
+
+    # Gets a Gollum::Git::Blob instance for this blob.
+    #
+    # repo - Gollum::Git::Repo instance for the Gollum::Git::Blob.
+    #
+    # Returns an unbaked Gollum::Git::Blob instance.
+    def blob(repo)
+      @blob ||= Gollum::Git::Blob.create(repo,
+                                  :id => @sha, :name => name, :size => @size, :mode => @mode)
+    end
+
+    # Gets a Page instance for this blob.
+    #
+    # wiki - Gollum::Wiki instance for the Gollum::Page
+    #
+    # Returns a Gollum::Page instance.
+    def page(wiki, commit)
+      blob         = self.blob(wiki.repo)
+      page         = wiki.page_class.new(wiki).populate(blob, self.dir)
+      page.version = commit
+      page
+    end
+
+    # Gets a File instance for this blob.
+    #
+    # wiki - Gollum::Wiki instance for the Gollum::File
+    #
+    # Returns a Gollum::File instance.
+    def file(wiki, commit)
+      blob         = self.blob(wiki.repo)
+      file         = wiki.file_class.new(wiki).populate(blob, self.dir)
+      file.version = commit
+      file
+    end
+
+    def inspect
+      %(#<Gollum::BlobEntry #{@sha} #{@path}>)
+    end
+
+    # Normalizes a given directory name for searching through tree paths.
+    # Ensures that a directory begins with a slash, or
+    #
+    #   normalize_dir("")      # => ""
+    #   normalize_dir(".")     # => ""
+    #   normalize_dir("foo")   # => "/foo"
+    #   normalize_dir("/foo/") # => "/foo"
+    #   normalize_dir("/")     # => ""
+    #   normalize_dir("c:/")   # => ""
+    #
+    # dir - String directory name.
+    #
+    # Returns a normalized String directory name, or nil if no directory
+    # is given.
+    def self.normalize_dir(dir)
+      return '' if dir =~ /^.:\/$/
+      if dir
+        dir = ::File.expand_path(dir, '/')
+        dir = '' if dir == '/'
+      end
+      dir
+    end
+  end
+end

data/lib/gollum-lib/committer.rb

@@ -0,0 +1,243 @@
+# ~*~ encoding: utf-8 ~*~
+module Gollum
+  # Responsible for handling the commit process for a Wiki.  It sets up the
+  # Git index, provides methods for modifying the tree, and stores callbacks
+  # to be fired after the commit has been made.  This is specifically
+  # designed to handle multiple updated pages in a single commit.
+  class Committer
+    # Gets the instance of the Gollum::Wiki that is being updated.
+    attr_reader :wiki
+
+    # Gets a Hash of commit options.
+    attr_reader :options
+
+    # Initializes the Committer.
+    #
+    # wiki    - The Gollum::Wiki instance that is being updated.
+    # options - The commit Hash details:
+    #           :message   - The String commit message.
+    #           :name      - The String author full name.
+    #           :email     - The String email address.
+    #           :parent    - Optional Gollum::Git::Commit parent to this update.
+    #           :tree      - Optional String SHA of the tree to create the
+    #                        index from.
+    #           :committer - Optional Gollum::Committer instance.  If provided,
+    #                        assume that this operation is part of batch of
+    #                        updates and the commit happens later.
+    #
+    # Returns the Committer instance.
+    def initialize(wiki, options = {})
+      @wiki      = wiki
+      @options   = options
+      @callbacks = []
+      after_commit { |*args| Hook.execute(:post_commit, *args) }
+    end
+
+    # Public: References the Git index for this commit.
+    #
+    # Returns a Gollum::Git::Index.
+    def index
+      @index ||= begin
+        idx = @wiki.repo.index
+        if tree = options[:tree]
+          idx.read_tree(tree)
+        elsif parent = parents.first
+          idx.read_tree(parent.tree.id)
+        end
+        idx
+      end
+    end
+
+    # Public: The committer for this commit.
+    #
+    # Returns a Gollum::Git::Actor.
+    def actor
+      @actor ||= begin
+        @options[:name]  = @wiki.default_committer_name if @options[:name].nil?
+        @options[:email] = @wiki.default_committer_email if @options[:email].nil?
+        Gollum::Git::Actor.new(@options[:name], @options[:email])
+      end
+    end
+
+    # Public: The parent commits to this pending commit.
+    #
+    # Returns an array of Gollum::Git::Commit instances.
+    def parents
+      @parents ||= begin
+        arr = [@options[:parent] || @wiki.repo.commit(@wiki.ref)]
+        arr.flatten!
+        arr.compact!
+        arr
+      end
+    end
+
+    # Adds a page to the given Index.
+    #
+    # dir    - The String subdirectory of the Gollum::Page without any
+    #          prefix or suffix slashes (e.g. "foo/bar").
+    # name   - The String Gollum::Page filename_stripped.
+    # format - The Symbol Gollum::Page format.
+    # data   - The String wiki data to store in the tree map.
+    # allow_same_ext - A Boolean determining if the tree map allows the same
+    #                  filename with the same extension.
+    #
+    # Raises Gollum::DuplicatePageError if a matching filename already exists.
+    # This way, pages are not inadvertently overwritten.
+    #
+    # Returns nothing (modifies the Index in place).
+    def add_to_index(dir, name, format, data, allow_same_ext = false)
+      # spaces must be dashes
+      dir.gsub!(' ', '-')
+      name.gsub!(' ', '-')
+
+      path = @wiki.page_file_name(name, format)
+
+      dir  = '/' if dir.strip.empty?
+
+      fullpath = ::File.join(*[@wiki.page_file_dir, dir, path].compact)
+      fullpath = fullpath[1..-1] if fullpath =~ /^\//
+
+      if index.current_tree && tree = index.current_tree / (@wiki.page_file_dir || '/')
+        tree = tree / dir unless tree.nil?
+      end
+
+      if tree
+        downpath = path.downcase.sub(/\.\w+$/, '')
+
+        tree.blobs.each do |blob|
+          next if page_path_scheduled_for_deletion?(index.tree, fullpath)
+
+          existing_file     = blob.name.downcase.sub(/\.\w+$/, '')
+          existing_file_ext = ::File.extname(blob.name).sub(/^\./, '')
+
+          new_file_ext = ::File.extname(path).sub(/^\./, '')
+
+          if downpath == existing_file && !(allow_same_ext && new_file_ext == existing_file_ext)
+            raise DuplicatePageError.new(dir, blob.name, path)
+          end
+        end
+      end
+
+      fullpath = fullpath.force_encoding('ascii-8bit') if fullpath.respond_to?(:force_encoding)
+
+      begin
+        data = @wiki.normalize(data)
+      rescue ArgumentError => err
+        # Swallow errors that arise from data being binary
+        raise err unless err.message.include?('invalid byte sequence')
+      end
+      index.add(fullpath, data)
+    end
+
+    # Update the given file in the repository's working directory if there
+    # is a working directory present.
+    #
+    # dir    - The String directory in which the file lives.
+    # name   - The String name of the page or the stripped filename
+    #          (should be pre-canonicalized if required).
+    # format - The Symbol format of the page.
+    #
+    # Returns nothing.
+    def update_working_dir(dir, name, format)
+      unless @wiki.repo.bare
+        if @wiki.page_file_dir && dir !~ /^#{@wiki.page_file_dir}/
+          dir = dir.size.zero? ? @wiki.page_file_dir : ::File.join(@wiki.page_file_dir, dir)
+        end
+
+        path =
+            if dir == ''
+              @wiki.page_file_name(name, format)
+            else
+              ::File.join(dir, @wiki.page_file_name(name, format))
+            end
+
+        path = path.force_encoding('ascii-8bit') if path.respond_to?(:force_encoding)
+
+        Dir.chdir(::File.join(@wiki.repo.path, '..')) do
+          if file_path_scheduled_for_deletion?(index.tree, path)
+            @wiki.repo.git.rm(path, :force => true)
+          else
+            @wiki.repo.git.checkout(path, 'HEAD')
+          end
+        end
+      end
+    end
+
+    # Writes the commit to Git and runs the after_commit callbacks.
+    #
+    # Returns the String SHA1 of the new commit.
+    def commit
+      sha1 = index.commit(@options[:message], parents, actor, nil, @wiki.ref)
+      @callbacks.each do |cb|
+        cb.call(self, sha1)
+      end
+      sha1
+    end
+
+    # Adds a callback to be fired after a commit.
+    #
+    # block - A block that expects this Committer instance and the created
+    #         commit's SHA1 as the arguments.
+    #
+    # Returns nothing.
+    def after_commit(&block)
+      @callbacks << block
+    end
+
+    # Determine if a given page (regardless of format) is scheduled to be
+    # deleted in the next commit for the given Index.
+    #
+    # map   - The Hash map:
+    #         key - The String directory or filename.
+    #         val - The Hash submap or the String contents of the file.
+    # path - The String path of the page file. This may include the format
+    #         extension in which case it will be ignored.
+    #
+    # Returns the Boolean response.
+    def page_path_scheduled_for_deletion?(map, path)
+      parts = path.split('/')
+      if parts.size == 1
+        deletions = map.keys.select { |k| !map[k] }
+        downfile  = parts.first.downcase.sub(/\.\w+$/, '')
+        deletions.any? { |d| d.downcase.sub(/\.\w+$/, '') == downfile }
+      else
+        part = parts.shift
+        if rest = map[part]
+          page_path_scheduled_for_deletion?(rest, parts.join('/'))
+        else
+          false
+        end
+      end
+    end
+
+    # Determine if a given file is scheduled to be deleted in the next commit
+    # for the given Index.
+    #
+    # map   - The Hash map:
+    #         key - The String directory or filename.
+    #         val - The Hash submap or the String contents of the file.
+    # path - The String path of the file including extension.
+    #
+    # Returns the Boolean response.
+    def file_path_scheduled_for_deletion?(map, path)
+      parts = path.split('/')
+      if parts.size == 1
+        deletions = map.keys.select { |k| !map[k] }
+        deletions.any? { |d| d == parts.first }
+      else
+        part = parts.shift
+        if rest = map[part]
+          file_path_scheduled_for_deletion?(rest, parts.join('/'))
+        else
+          false
+        end
+      end
+    end
+
+    # Proxies methods t
+    def method_missing(name, *args)
+      args.map! { |item| item.respond_to?(:force_encoding) ? item.force_encoding('ascii-8bit') : item }
+      index.send(name, *args)
+    end
+  end
+end