gollum 5.0.1 → 5.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d4d24ffaa889dd2ccaea1b04803e084020f923f3efb3e1512609676f9fc8647
-  data.tar.gz: ade42ad7156ebde9985813a051b2f327bc5c597604dc3d1fa20141fc307a197a
+  metadata.gz: 210167f0c5540675d37210272db4fe0da3bc6d75647c26a46c7d16a07fd9e1e7
+  data.tar.gz: 63298c72adf095678e6cea9b085c3f891ba025b2342d7132cce578974149c5b6
 SHA512:
-  metadata.gz: 33521b0483e80acdb63acbceb27dda772684dda4e5bf619e4a1cbf6fa0eb9b60c49c70ff15d0def8f34dce5d8690625e173f35137e3ff51a58e3c18926398ecb
-  data.tar.gz: 6f9c3b0b3a97ce1789c2f91184d6aebebab966b883be753b30562f41bca42782f1d2c2abb5b1dfd0bf55977521d2f49e77969f1211073b658860222ed772786b
+  metadata.gz: 98e609a98e3e38b87f7c929c61d5d07a2c09057050137aeec5bfb5f1d98c589ee965651fdf379688b1fc20845458300a8f0e4ad4314fa8cb999ef998f111654c
+  data.tar.gz: 6766945d35d5218eb1dd8efc78755e4331e894b5ae0a85d2e7fdaa825d88aef774c3485accccdd7a94f8bdbe478f80aca0e043143022471934c0f48564f838e3

data/CONTRIBUTING.md

@@ -21,7 +21,7 @@ Before submitting an issue, **please carefully look through the following places
 
 Security vulnerabilities can be reported directly to the maintainers using these GPG keys:
 
-* [@dometto](https://pgp.mit.edu/pks/lookup?op=vindex&search=0xD637E455CD3E27BF)
+* [@dometto](https://keys.openpgp.org/vks/v1/by-fingerprint/02354CC9F820B52CC2791979BB8CCC95FD83B795)
 
 Lastly, please **consider helping out** by opening a Pull Request!
 
@@ -70,7 +70,7 @@ An example of how to add a test file to the bare repository lotr.git.
 ```
 mkdir tmp
 cd tmp
-git clone ../lotr.git/
+git clone ../test/examples/lotr.git/
 git log
 echo "test" > test.md
 git add .

data/Gemfile

@@ -6,5 +6,5 @@ end
 
 gemspec
 
-gem "rake", '~> 12.3', '>= 12.3.3'
+gem "rake", '~> 13.0'
 

data/HISTORY.md

@@ -1,3 +1,24 @@
+# 5.2.1 2021-02-25
+
+* Fix include call to a missing asset (@benjaminwil). This caused slow first page loads on JRuby.
+
+# 5.2 2021-02-24
+
+* Improved styling and Primer upgrade (@benjaminwil)
+* Add redirect to rename commit (@ViChyavIn)
+* Updated dependencies
+* Bugfixes
+
+# 5.1.2
+
+* Guard against malicious filenames in breadcrumbs
+
+# 5.1
+
+* Bugfixes
+* Add autosave feature (#1576)
+* Add Add quick access to diff of each commit in the history
+
 # 5.0 / 2020-03-17
 
 This is a major new release that introduces many new features, bugfixes, and removes major limitations. See [here](https://github.com/gollum/gollum/wiki/5.0-release-notes) for a list of changes.

data/README.md

@@ -4,6 +4,7 @@ gollum -- A git-based Wiki
 [![Gem Version](https://badge.fury.io/rb/gollum.svg)](http://badge.fury.io/rb/gollum)
 [![Build Status](https://travis-ci.org/gollum/gollum.svg?branch=master)](https://travis-ci.org/gollum/gollum)
 [![Open Source Helpers](https://www.codetriage.com/gollum/gollum/badges/users.svg)](https://www.codetriage.com/gollum/gollum)
+[![Cutting Edge Dependency Status](https://dometto-cuttingedge.herokuapp.com/github/gollum/gollum/svg 'Cutting Edge Dependency Status')](https://dometto-cuttingedge.herokuapp.com/github/gollum/gollum/info)
 
 **Gollum version 5.0 is out!** See [here](https://github.com/gollum/gollum/wiki/5.0-release-notes) for a list of changes and new features compared to Gollum version 4.x, and see some [Screenshots](https://github.com/gollum/gollum/wiki/Screenshots) of Gollum's features.
 

data/Rakefile

@@ -181,11 +181,8 @@ end
 
 desc 'Precompile assets'
 task :precompile do
-  require './lib/gollum/views/helpers.rb'
-  require './lib/gollum/assets.rb'
-  require 'sprockets'
-  require 'sprockets-helpers'
-  require 'sass'
+  require './lib/gollum/app.rb'
+  Precious::App.set(:environment, :production)
   env = Precious::Assets.sprockets
   path = ENV.fetch('GOLLUM_ASSETS_PATH', ::File.join(File.dirname(__FILE__), 'lib/gollum/public/assets'))
   manifest = Sprockets::Manifest.new(env, path)

data/bin/gollum

@@ -152,7 +152,7 @@ MSG
   opts.on('--template-dir [PATH]', 'Specify custom mustache template directory.') do |path|
     wiki_options[:template_dir] = path
   end
-  opts.on('--template-page', 'Use _Template in root as a template for new pages.') do
+  opts.on('--template-page', 'Use _Template.{ext} as a template for new pages.') do
     wiki_options[:template_page] = true
   end
   opts.on('--lenient-tag-lookup', 'Internal links resolve case-insensitively, will treat spaces as hyphens, and will match the first page found with a certain filename, anywhere in the repository. Provides compatibility with Gollum 4.x.') do

data/contrib/automation/gollum-post

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+#
+# Distributed under the terms of the MIT License.
+#
+# Author: Sam Baskinger <basking2@yahoo.com>
+#
+# Description: gollum-post is an example script that shows how 
+#              to post a file to Gollum. This may be used
+#              to build scripts around CI/CD pipelines that 
+#              publish their documentation to Gollum.
+#
+
+require 'uri'
+require 'mechanize'
+require 'digest'
+
+GOLLUM=URI('https://mygollum.server')
+
+m = Mechanize.new()
+
+page="TestPage"
+path="/automated/docs"
+format="asciidoc"
+content="""
+= This is #{page}
+
+This page is automatically generated.
+"""
+message='Posting current documentation.'
+
+# Check if the page exists.
+p = m.get("#{GOLLUM}#{path}/#{page}")
+
+# If we were redirected to the creat page...
+if p.uri.to_s =~ /\/gollum\/create/
+
+  # ... then create the page.
+  p = m.post("#{GOLLUM}/gollum/create",
+             'keybinding' => 'default',
+             'page' => page,
+             'path' => path,
+             'format' => 'asciidoc',
+             'message' => 'Publish bot.',
+             'content' => content)
+else
+  # ... else, get the previous content and update it.
+  p = m.get("#{GOLLUM}/gollum/edit#{path}/#{page}")
+
+  # Get the previous content. You _could_ check if this is unchanged at this 
+  # step and post nothing.
+  previous_content = p.xpath('//textarea[@id="gollum-editor-body"]')[0].text
+
+  # The previous ETag is the Git SHA-1. We need this to replace the previous contents.
+  prev_etag = Digest::SHA1.hexdigest("blob #{previous_content.length}\0#{previous_content}")
+
+  # Post the updated document using the ETag of the previous document to avoid collisions.
+  p = m.post("#{GOLLUM}/gollum/edit#{path}/#{page}",
+             'keybinding' => 'default',
+             'page' => page,
+             'path' => path,
+             'format' => 'asciidoc',
+             'message' => message,
+             'etag' => prev_etag,
+             'content' => content)
+end
+

data/gollum.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9'
 
   s.name              = 'gollum'
-  s.version           = '5.0.1'
-  s.date              = '2020-04-04'
+  s.version           = '5.2.1'
+  s.date              = '2021-02-25'
   s.license           = 'MIT'
 
   s.summary     = 'A simple, Git-powered wiki.'
@@ -23,18 +23,18 @@ Gem::Specification.new do |s|
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = %w[README.md LICENSE]
 
-  s.add_dependency 'gollum-lib', '~> 5.0'
-  s.add_dependency 'kramdown', '~> 2.1.0'
-  s.add_dependency 'kramdown-parser-gfm', '~> 1.0.0'
+  s.add_dependency 'gollum-lib', '~> 5.1'
+  s.add_dependency 'kramdown', '~> 2.3'
+  s.add_dependency 'kramdown-parser-gfm', '~> 1.1.0'
   s.add_dependency 'sinatra', '~> 2.0'
   s.add_dependency 'sinatra-contrib', '~> 2.0'
-  s.add_dependency 'mustache', ['>= 0.99.5', '< 1.0.0']
+  s.add_dependency 'mustache-sinatra', '~> 1.0'
   s.add_dependency 'useragent', '~> 0.16.2'
   s.add_dependency 'gemojione', '~> 4.1'
-  s.add_dependency 'octicons', '~> 8.5'
+  s.add_dependency 'octicons', '~> 12.0'
   s.add_dependency 'sprockets', '~> 3.7'
   s.add_dependency 'sass', '~> 3.5'
-  s.add_dependency 'uglifier', '~> 3.2'
+  s.add_dependency 'uglifier', '~> 4.2'
   s.add_dependency 'sprockets-helpers', '~> 1.2'
   s.add_dependency 'rss', '~> 0.2.9'
   s.add_dependency 'therubyrhino', '~> 2.1.0'
@@ -59,6 +59,7 @@ Gem::Specification.new do |s|
     bin/gollum-migrate-tags
     config.rb
     config.ru
+    contrib/automation/gollum-post
     contrib/openrc/conf.d/gollum
     contrib/openrc/init.d/gollum
     contrib/systemd/gollum@.service
@@ -68,15 +69,15 @@ Gem::Specification.new do |s|
     lib/gollum/app.rb
     lib/gollum/assets.rb
     lib/gollum/helpers.rb
-    lib/gollum/public/assets/.sprockets-manifest-3edc7e21737459b21fbf150f5dccd15c.json
-    lib/gollum/public/assets/app-982c7fca1832732a24e92474ca2729aeb56f2d0c05bb7a8ff913e9f58a6500d5.js
-    lib/gollum/public/assets/app-982c7fca1832732a24e92474ca2729aeb56f2d0c05bb7a8ff913e9f58a6500d5.js.gz
-    lib/gollum/public/assets/app-b205e593a30f1cc0054e2e9ed9fc8af3658d8ef4a62b9708c20f204560deefb7.css
-    lib/gollum/public/assets/app-b205e593a30f1cc0054e2e9ed9fc8af3658d8ef4a62b9708c20f204560deefb7.css.gz
+    lib/gollum/public/assets/.sprockets-manifest-15b663a27211dc9de9a452b4b74462d7.json
+    lib/gollum/public/assets/app-7a0bbff2e8bad3033e7c17e0e0f886f336a9d23d3b912dcd2ae389c48b4b63e6.css
+    lib/gollum/public/assets/app-7a0bbff2e8bad3033e7c17e0e0f886f336a9d23d3b912dcd2ae389c48b4b63e6.css.gz
+    lib/gollum/public/assets/app-7a4bd115f4bc7ece39bc8073ca0ffad7c5e55cc5837b1464a12dead4905cefb2.js
+    lib/gollum/public/assets/app-7a4bd115f4bc7ece39bc8073ca0ffad7c5e55cc5837b1464a12dead4905cefb2.js.gz
     lib/gollum/public/assets/criticmarkup-31ae5d3282bbb8e7b7c3c9917e9fb68e3315a6b4a75da6cec48d21b8846905c4.css
     lib/gollum/public/assets/criticmarkup-31ae5d3282bbb8e7b7c3c9917e9fb68e3315a6b4a75da6cec48d21b8846905c4.css.gz
-    lib/gollum/public/assets/editor-0dbae28c53db5a73d666d30504946671eb09948ffdaf1fdd9d1c8d856d4c0ba1.js
-    lib/gollum/public/assets/editor-0dbae28c53db5a73d666d30504946671eb09948ffdaf1fdd9d1c8d856d4c0ba1.js.gz
+    lib/gollum/public/assets/editor-db10c8351306e92f1926ba225d0cd9c8e886482b3b9820a85825ec3abab5f1cf.js
+    lib/gollum/public/assets/editor-db10c8351306e92f1926ba225d0cd9c8e886482b3b9820a85825ec3abab5f1cf.js.gz
     lib/gollum/public/assets/print-512498c368be0d3fb1ba105dfa84289ae48380ec9fcbef948bd4e23b0b095bfb.css
     lib/gollum/public/assets/print-512498c368be0d3fb1ba105dfa84289ae48380ec9fcbef948bd4e23b0b095bfb.css.gz
     lib/gollum/public/gollum/javascript/HOWTO_UPDATE_ACE.md
@@ -1174,22 +1175,23 @@ Gem::Specification.new do |s|
     lib/gollum/public/gollum/javascript/jquery-1.7.2.min.js
     lib/gollum/public/gollum/javascript/jquery.resize.js
     lib/gollum/public/gollum/javascript/mousetrap.min.js
+    lib/gollum/public/gollum/javascript/polyfills.js
     lib/gollum/public/gollum/stylesheets/_base.scss
     lib/gollum/public/gollum/stylesheets/_breakpoint.scss
     lib/gollum/public/gollum/stylesheets/_component.scss
     lib/gollum/public/gollum/stylesheets/_features.scss
-    lib/gollum/public/gollum/stylesheets/_layout.scss
     lib/gollum/public/gollum/stylesheets/_spinners.scss
     lib/gollum/public/gollum/stylesheets/app.scss
     lib/gollum/public/gollum/stylesheets/criticmarkup.scss
     lib/gollum/public/gollum/stylesheets/dialog.scss
     lib/gollum/public/gollum/stylesheets/editor.scss
     lib/gollum/public/gollum/stylesheets/emoji.scss
-    lib/gollum/public/gollum/stylesheets/primer.scss
+    lib/gollum/public/gollum/stylesheets/primer.css
     lib/gollum/public/gollum/stylesheets/print.scss
     lib/gollum/public/gollum/stylesheets/spinner.scss
     lib/gollum/public/gollum/stylesheets/tables.scss
     lib/gollum/public/gollum/stylesheets/template.scss.erb
+    lib/gollum/templates/commit.mustache
     lib/gollum/templates/compare.mustache
     lib/gollum/templates/create.mustache
     lib/gollum/templates/edit.mustache
@@ -1201,6 +1203,7 @@ Gem::Specification.new do |s|
     lib/gollum/templates/history_authors/none.mustache
     lib/gollum/templates/latest_changes.mustache
     lib/gollum/templates/layout.mustache
+    lib/gollum/templates/mobilenav.mustache
     lib/gollum/templates/navbar.mustache
     lib/gollum/templates/overview.mustache
     lib/gollum/templates/page.mustache
@@ -1209,6 +1212,7 @@ Gem::Specification.new do |s|
     lib/gollum/templates/searchbar.mustache
     lib/gollum/templates/wiki_content.mustache
     lib/gollum/uri_encode_component.rb
+    lib/gollum/views/commit.rb
     lib/gollum/views/compare.rb
     lib/gollum/views/create.rb
     lib/gollum/views/edit.rb

data/lib/gollum.rb

@@ -12,7 +12,7 @@ require 'rhino' if RUBY_PLATFORM == 'java'
 require File.expand_path('../gollum/uri_encode_component', __FILE__)
 
 module Gollum
-  VERSION = '5.0.1'
+  VERSION = '5.2.1'
 
   def self.assets_path
     ::File.expand_path('gollum/public', ::File.dirname(__FILE__))
@@ -33,4 +33,20 @@ module Gollum
       super(message || "Cannot write #{@dir}/#{@attempted_path}, found #{@dir}/#{@existing_path}.")
     end
   end
+  
+  class TemplateFilter
+    @@filters = {}
+
+    def self.add_filter(pattern, &replacement)
+      @@filters[pattern] = replacement
+    end
+
+    def self.apply_filters(data)
+      @@filters.each do |pattern, replacement|
+        data.gsub!(pattern, replacement.call)
+      end
+      data
+    end
+  end
+
 end

data/lib/gollum/app.rb

@@ -230,14 +230,15 @@ module Precious
         halt 500 unless tempfile.is_a? Tempfile
 
         if wiki.per_page_uploads
-          # remove base_url and gollum/* subpath if necessary
-          dir = request.referer.
-                  sub(request.base_url, '').
-                  sub(/.*gollum\/[-\w]+\//, '')
+          dir = request.referer.sub(request.base_url, '')
           # remove base path if it is set
-          dir = dir.sub(wiki.base_path, '') if wiki.base_path
+          dir.sub!(/^#{wiki.base_path}/, '') if wiki.base_path
+          # remove base_url and gollum/* subpath if necessary
+          dir.sub!(/^\/gollum\/[-\w]+\//, '')
           # remove file extension 
-          dir = dir.sub(::File.extname(dir), '')
+          dir.sub!(/#{::File.extname(dir)}$/, '')
+          # revert escaped whitespaces
+          dir.gsub!(/%20/, ' ')
           dir = ::File.join('uploads', dir)
         else
           # store all uploads together
@@ -302,12 +303,13 @@ module Precious
           redirect to("/#{page.escaped_url_path}")
           return
         end
-        committer.commit
-        
+
         # Renaming preserves format, so add the page's format to the renamed path to retrieve the renamed page
         new_path = "#{rename}.#{Gollum::Page.format_to_ext(page.format)}"
         # Add a redirect from the old page to the new
-        wiki.add_redirect(page.url_path, clean_url(new_path)) if @redirects_enabled
+        wiki.add_redirect(page.url_path, clean_url(new_path), commit) if @redirects_enabled
+
+        committer.commit
 
         page = wiki_page(new_path).page
         return if page.nil?
@@ -317,9 +319,8 @@ module Precious
       post '/edit/*' do
         etag      = params[:etag]        
         path      = "/#{clean_url(sanitize_empty_params(params[:path]))}"
-        page_name = CGI.unescape(params[:page])
         wiki      = wiki_new
-        page      = wiki.page(::File.join(path, page_name))
+        page      = wiki.page(::File.join(path, params[:page]))
 
         return if page.nil?
         if etag != page.sha
@@ -351,14 +352,11 @@ module Precious
 
       get '/create/*' do
         forbid unless @allow_editing
-        if settings.wiki_options[:template_page] then
-          temppage = wiki_page('/_Template')
-          @template_page = (temppage.page != nil) ? temppage.page.raw_data : 'Template page option is set, but no /_Template page is present or committed.'
-        end
         wikip = wiki_page(params[:splat].first)
         @name = wikip.name
         @ext  = wikip.ext
         @path = wikip.path
+        @template_page = load_template(@path) if settings.wiki_options[:template_page]
         @allow_uploads = wikip.wiki.allow_uploads
         @upload_dest   = find_upload_dest(wikip.fullpath)
 
@@ -416,7 +414,7 @@ module Precious
 
       post '/preview' do
         wiki           = wiki_new
-        @name          = params[:page] ? strip_page_name(CGI.unescape(params[:page])) : 'Preview'
+        @name          = params[:page] ? strip_page_name(params[:page]) : 'Preview'
         @page          = wiki.preview_page(@name, params[:content], params[:format])
         ['sidebar', 'header', 'footer'].each do |subpage|
           @page.send("set_#{subpage}".to_sym, params[subpage]) if params[subpage]
@@ -459,20 +457,6 @@ module Precious
         mustache :latest_changes
       end
 
-      post '/compare/*' do
-        @file     = clean_url(encodeURIComponent(params[:splat].first))
-        @versions = params[:versions] || []
-        if @versions.size < 2
-          redirect to("gollum/history/#{@file}")
-        else
-          redirect to("gollum/compare/%s/%s...%s" % [
-              @file,
-              @versions.last,
-              @versions.first]
-                   )
-        end
-      end
-
       get %r{
         /compare/ # match any URL beginning with /compare/
         (.+)      # extract the full path (including any directories)
@@ -496,8 +480,51 @@ module Precious
         end
       end
 
+      get '/compare/*' do
+        @file     = clean_url(encodeURIComponent(params[:splat].first))
+        @versions = params[:versions] || []
+        if @versions.size == 1
+          wikip  = wiki_page(params[:splat].first)
+          commit = wikip.wiki.repo.commit(@versions.first)
+          parent = commit.parent
+          if parent.nil?
+            redirect to("#{@file}/#{@commit.id}")
+          else
+            @versions.push(parent.id)
+          end
+        end
+        if @versions.empty?
+          redirect to("gollum/history/#{@file}")
+        else
+          redirect to("gollum/compare/%s/%s...%s" % [
+              @file,
+              @versions.last,
+              @versions.first]
+                   )
+        end
+      end
+
+
+      get %r{
+        /commit/  # match any URL beginning with /show/
+        (\w+)     # match the SHA1
+      }x do |version|
+        @version = version
+        wiki = wiki_new
+        begin
+          @commit = wiki.repo.commit(version)
+          parent = @commit.parent
+          parent_id = parent.nil? ? nil : parent.id
+          @diff = wiki.repo.diff(parent_id, version)
+          mustache :commit
+        rescue Gollum::Git::NoSuchShaFound
+          @message = "Invalid commit: #{@version}"
+          mustache :error
+        end
+      end
+
       get '/search' do
-        @query     = params[:q]
+        @query     = params[:q] || ''
         @name      = @query
         if @query.empty?
           @results = []
@@ -609,6 +636,11 @@ module Precious
       end
     end
 
+    def load_template(path)
+      template_page = wiki_page(::File.join(path, '_Template')).page || wiki_page('/_Template').page
+      template_page ? Gollum::TemplateFilter.apply_filters(template_page.raw_data) : nil
+    end
+
     def update_wiki_page(wiki, page, content, commit, name = nil, format = nil)
       return if !page ||
           ((!content || page.raw_data == content) && page.format == format)