gollum 2.0.0 → 2.1.0

data/lib/gollum.rb

@@ -15,13 +15,14 @@ require File.expand_path('../gollum/blob_entry', __FILE__)
 require File.expand_path('../gollum/wiki', __FILE__)
 require File.expand_path('../gollum/page', __FILE__)
 require File.expand_path('../gollum/file', __FILE__)
+require File.expand_path('../gollum/file_view', __FILE__)
 require File.expand_path('../gollum/markup', __FILE__)
 require File.expand_path('../gollum/sanitization', __FILE__)
 require File.expand_path('../gollum/tex', __FILE__)
 require File.expand_path('../gollum/web_sequence_diagram', __FILE__)
 
 module Gollum
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 
   def self.assets_path
     ::File.expand_path('gollum/frontend/public', ::File.dirname(__FILE__))

data/lib/gollum/blob_entry.rb

@@ -48,6 +48,18 @@ module Gollum
       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
@@ -75,4 +87,4 @@ module Gollum
       dir
     end
   end
-end
+end

data/lib/gollum/committer.rb

@@ -91,7 +91,11 @@ module Gollum
       fullpath = ::File.join(*[@wiki.page_file_dir, dir, path].compact)
       fullpath = fullpath[1..-1] if fullpath =~ /^\//
 
-      if index.current_tree && tree = index.current_tree / dir
+      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|
@@ -104,6 +108,8 @@ module Gollum
         end
       end
 
+      fullpath = fullpath.force_encoding('ascii-8bit') if fullpath.respond_to?(:force_encoding)
+
       index.add(fullpath, @wiki.normalize(data))
     end
 
@@ -129,6 +135,8 @@ module Gollum
             ::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({'f' => true}, '--', path)
@@ -212,6 +220,7 @@ module Gollum
 
     # 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

data/lib/gollum/file.rb

@@ -19,6 +19,7 @@ module Gollum
     def name
       @blob && @blob.name
     end
+    alias filename name
 
     # Public: The raw contents of the page.
     #
@@ -28,7 +29,7 @@ module Gollum
     end
 
     # Public: The Grit::Commit version of the file.
-    attr_reader :version
+    attr_accessor :version
 
     # Public: The String path of the file.
     attr_reader :path
@@ -38,6 +39,18 @@ module Gollum
       @blob.mime_type
     end
 
+    # Populate the File with information from the Blob.
+    #
+    # blob - The Grit::Blob that contains the info.
+    # path - The String directory path of the file.
+    #
+    # Returns the populated Gollum::File.
+    def populate(blob, path=nil)
+      @blob = blob
+      @path = "#{path}/#{blob.name}"[1..-1]
+      self
+    end
+
     #########################################################################
     #
     # Internal Methods
@@ -61,4 +74,4 @@ module Gollum
       end
     end
   end
-end
+end

data/lib/gollum/file_view.rb

@@ -0,0 +1,145 @@
+module Gollum
+=begin
+  FileView requires that:
+    - All files in root dir are processed first
+    - Then all the folders are sorted and processed
+=end
+  class FileView
+    def initialize pages
+      @pages = pages
+    end
+
+    def enclose_tree string
+      %Q(<ol class="tree">\n) + string + %Q(</ol>)
+    end
+
+    def new_page page
+      name = page.name
+      url  = url_for_page page
+      %Q(  <li class="file"><a href="#{url}">#{name}</a></li>\n)
+    end
+
+    def new_folder folder_path
+      new_sub_folder folder_path
+    end
+
+    def new_sub_folder path
+      <<-HTML
+      <li>
+        <label>#{path}</label> <input type="checkbox" checked />
+        <ol>
+      HTML
+    end
+
+    def end_folder
+      <<-HTML
+        </ol>
+      </li>
+      HTML
+    end
+
+    def url_for_page page
+      url = ::File.join(::File.dirname(page.path), page.filename_stripped)
+      url = url[2..-1] if url[0,2] == './'
+      url
+    end
+
+    def render_files
+      html = ''
+      count = @pages.size
+      folder_start = -1
+
+      # Process all pages until folders start
+      count.times do | index |
+        page = @pages[ index ]
+        path = page.path
+
+        unless path.include? '/'
+          # Page processed (not contained in a folder)
+          html += new_page page
+        else
+          # Folders start at the next index
+          folder_start = index
+          break # Pages finished, move on to folders
+        end
+      end
+
+      # If there are no folders, then we're done.
+      return enclose_tree(html) if folder_start <= -1
+
+      # Handle special case of only one folder.
+      if (count - folder_start == 1)
+        page = @pages[ folder_start ]
+        name = page.name
+        url  = url_for_page page
+        html += <<-HTML
+        <li>
+          <label>#{::File.dirname(page.path)}</label> <input type="checkbox" checked />
+          <ol>
+            <li class="file"><a href="#{url}">#{name}</a></li>
+         </ol>
+        </li>
+        HTML
+
+        return enclose_tree html
+      end
+
+      sorted_folders = []
+      (folder_start).upto count - 1 do | index |
+        sorted_folders += [[ @pages[ index ].path, index ]]
+      end
+
+      # http://stackoverflow.com/questions/3482814/sorting-list-of-string-paths-in-vb-net
+      sorted_folders.sort! do |first,second| 
+        a = first[0]
+        b = second[0]
+
+        # use :: operator because gollum defines its own conflicting File class
+        dir_compare = ::File.dirname(a) <=> ::File.dirname(b)
+
+        # Sort based on directory name unless they're equal (0) in
+        # which case sort based on file name.
+        if dir_compare == 0
+          ::File.basename(a) <=> ::File.basename(b)
+        else
+          dir_compare
+        end
+      end
+
+      # keep track of folder depth, 0 = at root.
+      cwd_array = []
+      changed = false
+
+      # process rest of folders
+      (0...sorted_folders.size).each do | index |
+          page =  @pages[ sorted_folders[ index ][ 1 ] ]
+          path = page.path
+          folder = ::File.dirname path
+
+          tmp_array = folder.split '/'
+
+          (0...tmp_array.size).each do | index |
+            if cwd_array[ index ].nil? || changed
+              html += new_sub_folder tmp_array[ index ]
+              next
+            end
+
+            if cwd_array[ index ] != tmp_array[ index ]
+              changed = true
+              (cwd_array.size - index).times do
+                html += end_folder
+              end
+              html += new_sub_folder tmp_array[ index ]
+            end
+          end
+
+          html += new_page page
+          cwd_array = tmp_array
+          changed = false
+      end
+
+      # return the completed html
+      enclose_tree html
+    end # end render_files
+  end # end FileView class
+end # end Gollum module

data/lib/gollum/frontend/app.rb

@@ -2,16 +2,59 @@ require 'cgi'
 require 'sinatra'
 require 'gollum'
 require 'mustache/sinatra'
+require 'useragent'
+require 'stringex'
 
 require 'gollum/frontend/views/layout'
 require 'gollum/frontend/views/editable'
+require 'gollum/frontend/views/has_page'
+
+require File.expand_path '../uri_encode_component', __FILE__
+require File.expand_path '../helpers', __FILE__
+
+# Fix to_url
+class String
+  alias :upstream_to_url :to_url
+  # _Header => header which causes errors
+  def to_url
+    return nil if self.nil?
+    return self if ['_Header', '_Footer', '_Sidebar'].include? self
+    upstream_to_url
+  end
+end
 
+# Run the frontend, based on Sinatra
+#
+# There are a number of wiki options that can be set for the frontend
+#
+# Example
+# require 'gollum/frontend/app'
+# Precious::App.set(:wiki_options, {
+#     :universal_toc => false,
+# }
+#
+# See the wiki.rb file for more details on wiki options
 module Precious
   class App < Sinatra::Base
     register Mustache::Sinatra
+    include Precious::Helpers
 
     dir = File.dirname(File.expand_path(__FILE__))
 
+    # Detect unsupported browsers.
+    Browser = Struct.new(:browser, :version)
+
+    @@min_ua = [
+        Browser.new('Internet Explorer', '10.0'),
+        Browser.new('Chrome', '7.0'),
+        Browser.new('Firefox', '4.0'),
+    ]
+
+    def supported_useragent?(user_agent)
+      ua = UserAgent.parse(user_agent)
+      @@min_ua.detect {|min| ua >= min }
+    end
+
     # We want to serve public assets for now
     set :public_folder, "#{dir}/public/gollum"
     set :static,         true
@@ -38,48 +81,119 @@ module Precious
       enable :logging, :raise_errors, :dump_errors
     end
 
+    before do
+      @base_url = settings.wiki_options.has_key?(:base_url) ? settings.wiki_options[:base_url] : url('/')
+      settings.wiki_options.merge!({ :base_path => @base_url }) unless settings.wiki_options.has_key? :base_path
+    end
+
     get '/' do
       show_page_or_file('Home')
     end
 
+    # name, path, version
+    def wiki_page( name, path = nil, version = nil)
+      path = name if path.nil?
+
+      name = extract_name(name)
+      path = extract_path(path)
+      wiki = wiki_new
+
+      OpenStruct.new(:wiki => wiki, :page => wiki.paged(name, path, version),
+                     :name => name, :path => path)
+    end
+
+    def wiki_new
+      Gollum::Wiki.new(settings.gollum_path, settings.wiki_options)
+    end
+
+    get '/data/*' do
+      if page = wiki_page(params[:splat].first).page
+        page.raw_data
+      end
+    end
+
     get '/edit/*' do
-      @name = params[:splat].first
-      wiki = Gollum::Wiki.new(settings.gollum_path, settings.wiki_options)
-      if page = wiki.page(@name)
-        @page = page
-        @page.version = wiki.repo.log(wiki.ref, @page.path).first
-        @content = page.raw_data
-        mustache :edit
+      wikip = wiki_page(params[:splat].first)
+      @name = wikip.name
+      @path = wikip.path
+      wiki = wikip.wiki
+      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)
+          if @path
+            live_preview_url << '&path=' + encodeURIComponent(@path)
+          end
+          redirect to(live_preview_url)
+        else
+          @page = page
+          @page.version = wiki.repo.log(wiki.ref, @page.path).first
+          raw_data = page.raw_data
+          @content = raw_data.respond_to?(:force_encoding) ? raw_data.force_encoding('UTF-8') : raw_data
+          mustache :edit
+        end
       else
-        mustache :create
+        redirect to("/create/#{CGI.escape(@name)}")
       end
     end
 
     post '/edit/*' do
-      wiki = Gollum::Wiki.new(settings.gollum_path, settings.wiki_options)
-      page = wiki.page(params[:splat].first)
-      name = params[:rename] || page.name
-      committer = Gollum::Committer.new(wiki, commit_message)
-      commit    = {:committer => committer}
-
-      update_wiki_page(wiki, page, params[:content], commit, name,
-        params[:format])
+      wikip = wiki_page(CGI.unescape(params[:page]), sanitize_empty_params(params[:path]))
+      path         = wikip.path
+      wiki         = wikip.wiki
+      page         = wikip.page
+      rename       = params[:rename].to_url if params[:rename]
+      name         = rename || page.name
+      committer    = Gollum::Committer.new(wiki, commit_message)
+      commit       = {:committer => committer}
+
+      update_wiki_page(wiki, page, params[:content], commit, name, params[:format])
+      update_wiki_page(wiki, page.header,  params[:header],  commit) if params[:header]
       update_wiki_page(wiki, page.footer,  params[:footer],  commit) if params[:footer]
       update_wiki_page(wiki, page.sidebar, params[:sidebar], commit) if params[:sidebar]
       committer.commit
 
-      redirect "/#{CGI.escape(Gollum::Page.cname(name))}"
+      page = wiki.page(rename) if rename
+
+      redirect to("/#{page.escaped_url_path}") unless page.nil?
+    end
+
+    get '/delete/*' do
+      wikip = wiki_page(params[:splat].first)
+      name = wikip.name
+      wiki = wikip.wiki
+      page = wikip.page
+      wiki.delete_page(page, { :message => "Destroyed #{name} (#{page.format})" })
+
+      redirect to('/')
+    end
+
+    get '/create/*' do
+      splat = params[:splat].first
+      wikip = wiki_page(extract_name(splat).to_url, splat)
+      @name = wikip.name
+      @path = wikip.path
+
+      page = wikip.page
+      if page
+        redirect to("/#{page.escaped_url_path}")
+      else
+        mustache :create
+      end
     end
 
     post '/create' do
-      name = params[:page]
-      wiki = Gollum::Wiki.new(settings.gollum_path, settings.wiki_options)
+      name         = params[:page].to_url
+      path         = sanitize_empty_params(params[:path])
+      format       = params[:format].intern
 
-      format = params[:format].intern
+      # write_page is not directory aware so use wiki_options to emulate dir support.
+      wiki_options = settings.wiki_options.merge({ :page_file_dir => path })
+      wiki         = Gollum::Wiki.new(settings.gollum_path, wiki_options)
 
       begin
         wiki.write_page(name, format, params[:content], commit_message)
-        redirect "/#{CGI.escape(Gollum::Page.cname(name))}"
+        page = wiki.page(name)
+        redirect to("/#{page.escaped_url_path}")
       rescue Gollum::DuplicatePageError => e
         @message = "Duplicate page: #{e.message}"
         mustache :error
@@ -87,62 +201,75 @@ module Precious
     end
 
     post '/revert/:page/*' do
-      wiki  = Gollum::Wiki.new(settings.gollum_path, settings.wiki_options)
-      @name = params[:page]
-      @page = wiki.page(@name)
-      shas  = params[:splat].first.split("/")
-      sha1  = shas.shift
-      sha2  = shas.shift
+      wikip        = wiki_page(params[:page])
+      @path        = wikip.path
+      @name        = wikip.name
+      wiki         = wikip.wiki
+      @page        = wiki.paged(@name,@path)
+      shas         = params[:splat].first.split("/")
+      sha1         = shas.shift
+      sha2         = shas.shift
 
       if wiki.revert_page(@page, sha1, sha2, commit_message)
-        redirect "/#{CGI.escape(@name)}"
+        redirect to("/#{@page.escaped_url_path}")
       else
         sha2, sha1 = sha1, "#{sha1}^" if !sha2
-        @versions = [sha1, sha2]
-        diffs     = wiki.repo.diff(@versions.first, @versions.last, @page.path)
-        @diff     = diffs.first
-        @message  = "The patch does not apply."
+        @versions  = [sha1, sha2]
+        diffs      = wiki.repo.diff(@versions.first, @versions.last, @page.path)
+        @diff      = diffs.first
+        @message   = "The patch does not apply."
         mustache :compare
       end
     end
 
     post '/preview' do
-      wiki      = Gollum::Wiki.new(settings.gollum_path, settings.wiki_options)
-      @name     = "Preview"
-      @page     = wiki.preview_page(@name, params[:content], params[:format])
-      @content  = @page.formatted_data
+      wiki     = wiki_new
+      @name    = params[:page] || "Preview"
+      @page    = wiki.preview_page(@name, params[:content], params[:format])
+      @content = @page.formatted_data
+      @toc_content = wiki.universal_toc ? @page.toc_data : nil
+      @mathjax = wiki.mathjax
       @editable = false
       mustache :page
     end
 
-    get '/history/:name' do
-      @name     = params[:name]
-      wiki      = Gollum::Wiki.new(settings.gollum_path, settings.wiki_options)
-      @page     = wiki.page(@name)
-      @page_num = [params[:page].to_i, 1].max
-      @versions = @page.versions :page => @page_num
+    get '/history/*' do
+      @page        = wiki_page(params[:splat].first).page
+      @page_num    = [params[:page].to_i, 1].max
+      @versions    = @page.versions :page => @page_num
       mustache :history
     end
 
-    post '/compare/:name' do
+    post '/compare/*' do
+      @file     = params[:splat].first
       @versions = params[:versions] || []
       if @versions.size < 2
-        redirect "/history/#{CGI.escape(params[:name])}"
+        redirect to("/history/#{@file}")
       else
-        redirect "/compare/%s/%s...%s" % [
-          CGI.escape(params[:name]),
+        redirect to("/compare/%s/%s...%s" % [
+          @file,
           @versions.last,
           @versions.first]
+        )
       end
     end
 
-    get '/compare/:name/:version_list' do
-      @name     = params[:name]
-      @versions = params[:version_list].split(/\.{2,3}/)
-      wiki      = Gollum::Wiki.new(settings.gollum_path, settings.wiki_options)
-      @page     = wiki.page(@name)
-      diffs     = wiki.repo.diff(@versions.first, @versions.last, @page.path)
-      @diff     = diffs.first
+    get %r{
+      /compare/ # match any URL beginning with /compare/
+      (.+)      # extract the full path (including any directories)
+      /         # match the final slash
+      ([^.]+)   # match the first SHA1
+      \.{2,3}   # match .. or ...
+      (.+)      # match the second SHA1
+    }x do |path, start_version, end_version|
+      wikip        = wiki_page(path)
+      @path        = wikip.path
+      @name        = wikip.name
+      @versions    = [start_version, end_version]
+      wiki         = wikip.wiki
+      @page        = wikip.page
+      diffs        = wiki.repo.diff(@versions.first, @versions.last, @page.path)
+      @diff        = diffs.first
       mustache :compare
     end
 
@@ -157,9 +284,11 @@ module Precious
     end
 
     get %r{/(.+?)/([0-9a-f]{40})} do
-      name = params[:captures][0]
-      wiki = Gollum::Wiki.new(settings.gollum_path, settings.wiki_options)
-      if page = wiki.page(name, params[:captures][1])
+      file_path = params[:captures][0]
+      name      = extract_name(file_path)
+      path      = extract_path(file_path)
+      version   = params[:captures][1]
+      if page = wiki_page(name, path, version).page
         @page = page
         @name = name
         @content = page.formatted_data
@@ -172,47 +301,66 @@ module Precious
 
     get '/search' do
       @query = params[:q]
-      wiki = Gollum::Wiki.new(settings.gollum_path, settings.wiki_options)
+      wiki = wiki_new
       @results = wiki.search @query
       @name = @query
       mustache :search
     end
 
-    get '/pages' do
+    get %r{
+      /pages  # match any URL beginning with /pages
+      (?:     # begin an optional non-capturing group
+        /(.+) # capture any path after the "/pages" excluding the leading slash
+      )?      # end the optional non-capturing group
+    }x do |path|
+      @path        = extract_path(path) if path
+      wiki_options = settings.wiki_options.merge({ :page_file_dir => @path })
+      wiki         = Gollum::Wiki.new(settings.gollum_path, wiki_options)
+      @results     = wiki.pages
+      @ref         = wiki.ref
+      mustache :pages
+    end
+
+    get '/fileview' do
       wiki = Gollum::Wiki.new(settings.gollum_path, settings.wiki_options)
-      @results = wiki.pages
+      @results = Gollum::FileView.new(wiki.pages).render_files
       @ref = wiki.ref
-      mustache :pages
+      mustache :file_view, { :layout => false }
     end
 
     get '/*' do
       show_page_or_file(params[:splat].first)
     end
 
-    def show_page_or_file(name)
-      wiki = Gollum::Wiki.new(settings.gollum_path, settings.wiki_options)
-      if page = wiki.page(name)
+    def show_page_or_file(fullpath)
+      name         = extract_name(fullpath)
+      path         = extract_path(fullpath)
+      wiki         = wiki_new
+
+      if page = wiki.paged(name, path)
         @page = page
         @name = name
-        @content = page.formatted_data
         @editable = true
+        @content = page.formatted_data
+        @toc_content = wiki.universal_toc ? @page.toc_data : nil
+        @mathjax = wiki.mathjax
         mustache :page
-      elsif file = wiki.file(name)
+      elsif file = wiki.file(fullpath)
         content_type file.mime_type
         file.raw_data
       else
-        @name = name
-        mustache :create
+        page_path = [path, name].compact.join('/')
+        redirect to("/create/#{CGI.escape(page_path).gsub('%2F','/')}")
       end
     end
 
-    def update_wiki_page(wiki, page, content, commit_message, name = nil, format = nil)
+    def update_wiki_page(wiki, page, content, commit, name = nil, format = nil)
       return if !page ||
         ((!content || page.raw_data == content) && page.format == format)
       name    ||= page.name
       format    = (format || page.format).to_sym
       content ||= page.raw_data
-      wiki.update_page(page, name, format, content.to_s, commit_message)
+      wiki.update_page(page, name, format, content.to_s, commit)
     end
 
     def commit_message