gollum 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: ae63e46f52e80b39d9876f199ecf4adc35cb4ed3
-  data.tar.gz: 2e899d40a26492fb28fa9719fd07fb28cfe114be
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTM5MzlkY2I5YjA4NjhkZWVkYmExYmVjZjQ0ZDk3OGJmYjFkY2JiNA==
+  data.tar.gz: !binary |-
+    ZDc2NTE5NTcwZmMzMWYwOWI4YTIwNjUxMTJiZTFhN2U5NDVhYzIxNw==
 SHA512:
-  metadata.gz: 5a239050238237bc42b2a3b0dd7a74c1b5a2f618945eb4dede46794cd20f150ecbbc1475743bfc765a5007e137fe57b5adac727fb776caafc2a7570b3fb9d2f1
-  data.tar.gz: 8a033dc8543467eba6a508c6a01e035d05d02aa5a804a668787437f923d6eb1c055a990e7b0282554f673fff51079a8b6dde20b913993b5c959a112a2b4a64fe
+  metadata.gz: !binary |-
+    ZmYwZDMwNmM2NjJmMmUzZmJlNzFkYzkzYjc3NTk4NzIxZGUyNzU0NmVjZjc2
+    MzczNjQ3NmY5NmMxODY1OWQ1ZjFmN2IyYzQ5Nzg1YTQyZTAwNzRjMjU1NmMy
+    NjQ5YjY1YTQyNTQ2Yjk0NjQxYTY4NzdmNDU4NTI2ZWNiZGM4NDM=
+  data.tar.gz: !binary |-
+    YjFmNzAwOGM0OTExMDUzOTkzYzJjMGYyMTQzZmQxNzQ1NDY4NjA0ZTQ4MTkz
+    Njg2N2Y0OGIzN2NiZGFjZjA1NThlZmIxMDgwYzdiMjI0OTYwYTJlMmEzNGY2
+    ZDAxNGZmMmY5OWRhZmRhYWMyY2YxNDFiZmNiOGZmNDczYmJiZTQ=

data/HISTORY.md

@@ -1,3 +1,17 @@
+# 3.1 / 2014-11-28
+
+* New features
+  * Drag-and-drop uploading in the editor [@lucas-clemente](https://github.com/lucas-clemente)
+  * Latest changes view [@etienneCharignon](https://github.com/etienneCharignon) (#707)
+  * Option `--no-edit` to disable editing from the web interface [@bambycha](https://github.com/bambycha) (#879)
+  * Option `--mathjax-config` to specify custom mathjax configuration [@hardywu](https://github.com/hardywu) (#842)
+* Major enhancements
+  * Made the Gollum theme responsive [@rtrvrtg](https://github.com/rtrvrtg) (#831)
+  * Depends on new [gollum-lib](https://github.com/gollum/gollum-lib) `4.0.0`
+    * Allows specifiying [git adapter](https://github.com/gollum/gollum/wiki/Git-adapters) with `--adapter` [@bartkamphorst](https://github.com/bartkamphorst), [@dometto](https://github.com/dometto)
+* Numerous bugfixes
+  * **NB**: please pass `--h1-title` if you do not want page titles to default to the page's filepath. See [here](https://github.com/gollum/gollum/wiki/Page-titles).
+
 # 2.4.11 / 2013-01-08
 
 * Numerous security issues have been fixed. Please update to `2.4.11`

data/README.md

@@ -29,7 +29,7 @@ Gollum follows the rules of [Semantic Versioning](http://semver.org/) and uses
 
 ## SECURITY
 
-Don't enable `--custom-css` or `--custom-js` unless you trust every user who has the ability to edit the wiki.
+Don't enable `--custom-css`, `--custom-js` or `--mathjax-config` unless you trust every user who has the ability to edit the wiki.
 A better solution with more security is being tracked in [#665](https://github.com/gollum/gollum/issues/665).
 
 ## INSTALLATION
@@ -39,6 +39,7 @@ The best way to install Gollum is with RubyGems:
 ```bash
 $ [sudo] gem install gollum
 ```
+You may first need to install some additional [development packages](https://github.com/gollum/gollum/wiki/Installation) for your OS.
 
 If you're installing from source, you can use [Bundler][bundler] to pick up all the
 gems:
@@ -51,7 +52,7 @@ In order to use the various formats that Gollum supports, you will need to
 separately install the necessary dependencies for each format. You only need
 to install the dependencies for the formats that you plan to use.
 
-* [ASCIIDoc](http://www.methods.co.nz/asciidoc/) -- `brew install asciidoc` on mac or `apt-get install -y asciidoc` on Ubuntu
+* [AsciiDoc](http://asciidoctor.org) -- `gem install asciidoctor`
 * [Creole](http://wikicreole.org/) -- `gem install creole`
 * [Markdown](http://daringfireball.net/projects/markdown/) -- `gem install redcarpet`
 * [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown) -- `gem install github-markdown`
@@ -98,23 +99,26 @@ Options:
         --port [PORT]                Bind port (default 4567).
         --host [HOST]                Hostname or IP address to listen on (default 0.0.0.0).
         --version                    Display current version.
-        --config [CONFIG]            Path to additional configuration file
+        --config [CONFIG]            Path to additional configuration file.
+        --adapter [ADAPTER]          Git adapter to use in the backend. Defaults to grit.
         --irb                        Start an irb process with gollum loaded for the current wiki.
-        --css                        Inject custom css. Uses custom.css from root repository
-        --js                         Inject custom js. Uses custom.js from root repository
-        --template-dir [PATH]        Specify custom template directory
+        --css                        Inject custom css. Uses custom.css from root repository.
+        --js                         Inject custom js. Uses custom.js from root repository.
+        --template-dir [PATH]        Specify custom template directory.
         --page-file-dir [PATH]       Specify the sub directory for all page files (default: repository root).
-        --base-path [PATH]           Specify the base path.
-        --gollum-path [PATH]         Specify the gollum path.
+        --base-path [PATH]           Specify the base path for the served pages (default: /) Example: --base-path wiki yields the home page accessible at http://localhost:4567/wiki/.
+        --gollum-path [PATH]         Specify the path to the git repository to be served.
         --ref [REF]                  Specify the repository ref to use (default: master).
+        --no-edit                    Restricts editing capability through frontend.
         --no-live-preview            Disables livepreview.
         --live-preview               Enables livepreview.
-        --allow-uploads              Allows file uploads.
-        --mathjax                    Enables mathjax.
+        --allow-uploads [MODE]       Allows file uploads. Modes: dir (default, store all uploads in the same directory), page (store each upload at the same location as the page).
+        --mathjax                    Enables mathjax for rendering mathematical equations. Uses the TeX-AMS-MML_HTMLorMML config with the autoload-all extension by default.
+        --mathjax-config [SOURCE]    Inject custom mathjax config file. Uses mathjax.config.js from root repository by default.
         --user-icons [SOURCE]        Set the history user icons. Valid values: gravatar, identicon, none. Default: none.
         --show-all                   Shows all files in file view. By default only valid pages are shown.
         --collapse-tree              Collapse file view tree. By default, expanded tree is shown.
-        --h1-title                   Sets page title to value of first h1
+        --h1-title                   Sets page title to value of first h1.
 ```
 
 Note that the gollum server will not run on Windows because of [an issue](https://github.com/rtomayko/posix-spawn/issues/9) with posix-spawn (which is used by Grit).

data/bin/gollum

@@ -22,6 +22,7 @@ options      = { 'port' => 4567, 'bind' => '0.0.0.0' }
 wiki_options = {
     :live_preview  => false,
     :allow_uploads => false,
+    :allow_editing => true,
 }
 
 opts = OptionParser.new do |opts|
@@ -44,6 +45,10 @@ opts = OptionParser.new do |opts|
     options['config'] = config
   end
 
+  opts.on("--adapter [ADAPTER]", "Git adapter to use in the backend. Defaults to grit.") do |adapter|
+    Gollum::GIT_ADAPTER = adapter
+  end
+
   opts.on("--irb", "Start an irb process with gollum loaded for the current wiki.") do
     options['irb'] = true
   end
@@ -64,11 +69,11 @@ opts = OptionParser.new do |opts|
     wiki_options[:page_file_dir] = path
   end
 
-  opts.on("--base-path [PATH]", "Specify the base path.") do |path|
+  opts.on("--base-path [PATH]", "Specify the base path for the served pages (default: /) Example: --base-path wiki yields the home page accessible at http://localhost:4567/wiki/.") do |path|
     wiki_options[:base_path] = path
   end
 
-  opts.on("--gollum-path [PATH]", "Specify the gollum path.") do |path|
+  opts.on("--gollum-path [PATH]", "Specify the path to the git repository to be served.") do |path|
     wiki_options[:gollum_path] = path
   end
 
@@ -76,6 +81,10 @@ opts = OptionParser.new do |opts|
     wiki_options[:ref] = ref
   end
 
+  opts.on("--no-edit", "Restricts editing capability through frontend.")  do
+    wiki_options[:allow_editing] = false
+  end
+
   opts.on("--no-live-preview", "Disables livepreview.") do
     wiki_options[:live_preview] = false
   end
@@ -89,10 +98,14 @@ opts = OptionParser.new do |opts|
     wiki_options[:per_page_uploads] = true if mode == :page
   end
 
-  opts.on("--mathjax", "Enables mathjax.") do
+  opts.on("--mathjax", "Enables mathjax for rendering mathematical equations. Uses the TeX-AMS-MML_HTMLorMML config with the autoload-all extension by default.") do
     wiki_options[:mathjax] = true
   end
 
+  opts.on("--mathjax-config [SOURCE]", "Inject custom mathjax config file. Uses mathjax.config.js from root repository by default") do |source|
+    wiki_options[:mathjax_config] = source || 'mathjax.config.js'
+  end
+
   opts.on("--user-icons [SOURCE]", "Set the history user icons. Valid values: gravatar, identicon, none. Default: none.") do |source|
     wiki_options[:user_icons] = source
   end
@@ -211,4 +224,4 @@ else
     # Rack::Handler does not work with Ctrl + C. Use Rack::Server instead.
     Rack::Server.new(:app => MapGollum.new(base_path), :Port => options['port'], :Host => options['bind']).start
   end
-end
+end

data/contrib/systemd/gollum@.service

@@ -0,0 +1,12 @@
+[Unit]
+Description=Gollum wiki server
+After=network.target
+
+[Service]
+Type=simple
+User=%i
+ExecStart=/usr/bin/gollum
+Restart=on-abort
+
+[Install]
+WantedBy=multi-user.target

data/gollum.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9'
 
   s.name              = 'gollum'
-  s.version           = '3.0.0'
-  s.date              = '2014-04-05'
+  s.version           = '3.1.0'
+  s.date              = '2014-11-28'
   s.rubyforge_project = 'gollum'
   s.license           = 'MIT'
 
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = %w[README.md LICENSE]
 
-  s.add_dependency 'gollum-lib', '~> 3.0'
+  s.add_dependency 'gollum-lib', '~> 4.0'
   s.add_dependency 'github-markdown', '~> 0.6.5'
   s.add_dependency 'sinatra', '~> 1.4', '>= 1.4.4'
   s.add_dependency 'mustache', ['>= 0.99.5', '< 1.0.0']
@@ -45,10 +45,14 @@ Gem::Specification.new do |s|
     Rakefile
     bin/gollum
     config.rb
+    contrib/openrc/conf.d/gollum
+    contrib/openrc/init.d/gollum
+    contrib/systemd/gollum@.service
     docs/sanitization.md
     gollum.gemspec
     lib/gollum.rb
     lib/gollum/app.rb
+    lib/gollum/editing_auth.rb
     lib/gollum/helpers.rb
     lib/gollum/public/gollum/css/_styles.css
     lib/gollum/public/gollum/css/dialog.css
@@ -517,6 +521,7 @@ Gem::Specification.new do |s|
     lib/gollum/templates/history_authors/gravatar.mustache
     lib/gollum/templates/history_authors/identicon.mustache
     lib/gollum/templates/history_authors/none.mustache
+    lib/gollum/templates/latest_changes.mustache
     lib/gollum/templates/layout.mustache
     lib/gollum/templates/page.mustache
     lib/gollum/templates/pages.mustache
@@ -531,6 +536,7 @@ Gem::Specification.new do |s|
     lib/gollum/views/file_view.rb
     lib/gollum/views/has_page.rb
     lib/gollum/views/history.rb
+    lib/gollum/views/latest_changes.rb
     lib/gollum/views/layout.rb
     lib/gollum/views/page.rb
     lib/gollum/views/pages.rb
@@ -538,8 +544,6 @@ Gem::Specification.new do |s|
     licenses/css_tree_menu_thecssninja/license.txt
     licenses/licenses.txt
     licenses/unity_asset_pool/COPYRIGHT
-    openrc/conf.d/gollum
-    openrc/init.d/gollum
   ]
   # = MANIFEST =
 

data/lib/gollum.rb

@@ -16,7 +16,7 @@ require File.expand_path('../gollum/uri_encode_component', __FILE__)
 $KCODE = 'U' if RUBY_VERSION[0, 3] == '1.8'
 
 module Gollum
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 
   def self.assets_path
     ::File.expand_path('gollum/public', ::File.dirname(__FILE__))

data/lib/gollum/app.rb

@@ -13,6 +13,8 @@ require 'gollum/views/has_page'
 
 require File.expand_path '../helpers', __FILE__
 
+require 'gollum/editing_auth'
+
 #required to upload bigger binary files
 Gollum::set_git_timeout(120)
 Gollum::set_git_max_filesize(190 * 10**6)
@@ -42,6 +44,7 @@ module Precious
   class App < Sinatra::Base
     register Mustache::Sinatra
     include Precious::Helpers
+    use Precious::EditingAuth
 
     dir     = File.dirname(File.expand_path(__FILE__))
 
@@ -91,6 +94,8 @@ module Precious
       settings.wiki_options.merge!({ :base_path => @base_url })
       @css = settings.wiki_options[:css]
       @js  = settings.wiki_options[:js]
+      @mathjax_config = settings.wiki_options[:mathjax_config]
+      @allow_editing = settings.wiki_options[:allow_editing]
     end
 
     get '/' do
@@ -105,7 +110,6 @@ module Precious
     # name, path, version
     def wiki_page(name, path = nil, version = nil, exact = true)
       wiki = wiki_new
-
       path = name if path.nil?
       name = extract_name(name) || wiki.index_page
       path = extract_path(path)
@@ -126,11 +130,14 @@ module Precious
     end
 
     get '/edit/*' do
+      forbid unless @allow_editing
       wikip = wiki_page(params[:splat].first)
       @name = wikip.name
       @path = wikip.path
+      @upload_dest   = find_upload_dest(@path)
 
       wiki = wikip.wiki
+      @allow_uploads = wiki.allow_uploads
       if page = wikip.page
         if wiki.live_preview && page.format.to_s.include?('markdown') && supported_useragent?(request.user_agent)
           live_preview_url = '/livepreview/index.html?page=' + encodeURIComponent(@name)
@@ -251,21 +258,27 @@ module Precious
     end
 
     get '/delete/*' do
+      forbid unless @allow_editing
       wikip = wiki_page(params[:splat].first)
       name  = wikip.name
       wiki  = wikip.wiki
       page  = wikip.page
       unless page.nil?
-        wiki.delete_page(page, { :message => "Destroyed #{name} (#{page.format})" })
+        commit           = commit_message
+        commit[:message] = "Destroyed #{name} (#{page.format})"
+        wiki.delete_page(page, commit)
       end
 
       redirect to('/')
     end
 
     get '/create/*' do
+      forbid unless @allow_editing
       wikip = wiki_page(params[:splat].first.gsub('+', '-'))
       @name = wikip.name.to_url
       @path = wikip.path
+      @allow_uploads = wikip.wiki.allow_uploads
+      @upload_dest   = find_upload_dest(@path)
 
       page_dir = settings.wiki_options[:page_file_dir].to_s
       unless page_dir.empty?
@@ -351,6 +364,13 @@ module Precious
       end
     end
 
+    get '/latest_changes' do
+      @wiki = wiki_new
+      max_count = settings.wiki_options.fetch(:latest_changes_count, 10)
+      @versions = @wiki.latest_changes({:max_count => max_count})
+      mustache :latest_changes
+    end
+    
     post '/compare/*' do
       @file     = params[:splat].first
       @versions = params[:versions] || []
@@ -396,6 +416,8 @@ module Precious
         @content = page.formatted_data
         @version = version
         mustache :page
+      elsif file = wikip.wiki.file("#{file_path}", version, true)
+        show_file(file)
       else
         halt 404
       end
@@ -453,10 +475,7 @@ module Precious
         @page          = page
         @name          = name
         @content       = page.formatted_data
-        @upload_dest   = settings.wiki_options[:allow_uploads] ?
-            (settings.wiki_options[:per_page_uploads] ?
-                "#{path}/#{@name}".sub(/^\/\//, '') : 'uploads'
-            ) : ''
+        @upload_dest   = find_upload_dest(path)
 
         # Extensions and layout data
         @editable      = true
@@ -469,18 +488,24 @@ module Precious
 
         mustache :page
       elsif file = wiki.file(fullpath, wiki.ref, true)
-        if file.on_disk?
-          send_file file.on_disk_path, :disposition => 'inline'
-        else
-          content_type file.mime_type
-          file.raw_data
-        end
+        show_file(file)
       else
+        not_found unless @allow_editing
         page_path = [path, name].compact.join('/')
         redirect to("/create/#{clean_url(encodeURIComponent(page_path))}")
       end
     end
 
+    def show_file(file)
+      return unless file
+      if file.on_disk?
+        send_file file.on_disk_path, :disposition => 'inline'
+      else
+        content_type file.mime_type
+        file.raw_data
+      end
+    end
+
     def update_wiki_page(wiki, page, content, commit, name = nil, format = nil)
       return if !page ||
           ((!content || page.raw_data == content) && page.format == format)
@@ -505,5 +530,12 @@ module Precious
       commit_message.merge! author_parameters unless author_parameters.nil?
       commit_message
     end
+
+    def find_upload_dest(path)
+      settings.wiki_options[:allow_uploads] ?
+          (settings.wiki_options[:per_page_uploads] ?
+              "#{path}/#{@name}".sub(/^\/\//, '') : 'uploads'
+          ) : ''
+    end
   end
 end

data/lib/gollum/editing_auth.rb

@@ -0,0 +1,34 @@
+module Precious
+  class EditingAuth  < Sinatra::Base
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @env = env
+      # Blocks all potentially editable pages. Use EditingAuth::whitelist_pages to unblock pages.
+      unless (env["REQUEST_METHOD"] == "GET") || App::settings.wiki_options[:allow_editing]
+        return block unless excluded_page?
+      end
+      @app.call(env)
+    end
+
+    def block
+      [403, {'Content-Type' => 'text/html', 'Content-Length' => '9'}, ['Forbidden']]
+    end
+
+    def excluded_page?
+      return false if env["REQUEST_PATH"].nil?
+      whitelist_pages.any? do |whitelisted_page|
+        env["REQUEST_PATH"].include? whitelisted_page
+      end
+    end
+
+  private
+    # List pages paths as str that you want to whitelist.
+    # Pages will be compared with env["REQUEST_PATH"] using String::include? method.
+    def whitelist_pages
+      return ["/compare/"]
+    end
+  end
+end

data/lib/gollum/helpers.rb

@@ -39,5 +39,17 @@ module Precious
       url.gsub('%2F', '/').gsub(/^\/+/, '').gsub('//', '/')
     end
 
+    def forbid(msg = "Forbidden.")
+      @message = msg
+      status 403
+      halt mustache :error
+    end
+
+    def not_found(msg = nil)
+      @message = msg || "The requested page does not exist."
+      status 404
+      return mustache :error
+    end
+
   end
 end