smeagol 0.2.1 → 0.2.2

data/bin/smeagol

@@ -9,6 +9,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../lib/smeagol')
 options = OpenStruct.new
 options.port = 4567
 options.auto_update = false
+options.cache_enabled = true
 opts = OptionParser.new do |opts|
   opts.banner = 'usage: smeagol [OPTIONS] [PATH]\n\n'
 
@@ -24,6 +25,10 @@ opts = OptionParser.new do |opts|
     options.auto_update = flag
   end
 
+  opts.on('--[no-]cache', 'Enables page caching.') do |flag|
+    options.cache_enabled = flag
+  end
+
   opts.on('-v', '--version', 'Display current version.') do
     puts "Smeagol #{Smeagol::VERSION}"
     exit 0
@@ -68,8 +73,12 @@ if options.git && options.auto_update
   end
 end
 
+# Clear the cache
+Smeagol::Cache.new(Gollum::Wiki.new(gollum_path)).clear()
+
 # Run the web server
 Smeagol::App.set(:gollum_path, gollum_path)
 Smeagol::App.set(:git, options.git)
+Smeagol::App.set(:cache_enabled, options.cache_enabled)
 Smeagol::App.run!(:port => options.port)
 

data/lib/file.rb

@@ -0,0 +1,10 @@
+class File
+  # Removes all references to parent directories (../) in a path.
+  #
+  # path - The path to sanitize.
+  #
+  # Returns a clean, pristine path.
+  def self.sanitize_path(path)
+    path.gsub(/\.\.(?=$|\/)/, '') unless path.nil?
+  end
+end

data/lib/smeagol.rb

@@ -1,5 +1,8 @@
 $:.unshift(File.dirname(__FILE__))
+require 'file'
+
 require 'smeagol/app'
+require 'smeagol/cache'
 require 'smeagol/hash'
 require 'smeagol/updater'
 require 'smeagol/wiki'

data/lib/smeagol/app.rb

@@ -1,6 +1,7 @@
 require 'gollum'
 require 'sinatra'
 require 'mustache'
+require 'tmpdir'
 require 'smeagol/views/page'
 
 module Smeagol
@@ -33,13 +34,24 @@ module Smeagol
     get '/*' do
       name = params[:splat].first
       name = "Home" if name == ""
+      name = File.sanitize_path(name)
       
       # Load the wiki settings
       wiki = Smeagol::Wiki.new(settings.gollum_path)
-      if page = wiki.page(name)
-        Mustache.render(page_template, Smeagol::Views::Page.new(page))
+      cache = Smeagol::Cache.new(wiki)
+      
+      # First check the cache
+      if settings.cache_enabled && cache.cache_hit?(name)
+        cache.get_page(name)
+      # Then try to create the wiki page
+      elsif page = wiki.page(name)
+        content = Mustache.render(page_template, Smeagol::Views::Page.new(page))
+        cache.set_page(name, content) if settings.cache_enabled
+        content
+      # If it is not a wiki page then try to find the file
       elsif file = wiki.file(name)
         file.raw_data
+      # Otherwise return a 404 error
       else
         raise Sinatra::NotFound
       end

data/lib/smeagol/cache.rb

@@ -0,0 +1,84 @@
+require 'fileutils'
+
+module Smeagol
+  class Cache
+    # Creates a cache object for a Gollum wiki.
+    #
+    # wiki - The wiki to cache.
+    #
+    # Returns a Smeagol::Cache object.
+    def initialize(wiki)
+      @wiki = wiki
+      @path = "#{Dir.tmpdir}/smeagol/#{File.expand_path(@wiki.path)}"
+    end
+    
+    # The cached wiki.
+    attr_reader :wiki
+    
+    # The path to the smeagol cache for this wiki.
+    attr_accessor :path
+
+
+    # Clears the entire cache.
+    def clear
+      FileUtils.rm_rf(path)
+    end
+    
+    # Checks if a cache hit is found for a given gollum page.
+    #
+    # name - The name of the page to check.
+    #
+    # Returns true if the page has been cached, otherwise returns false.
+    def cache_hit?(name)
+      page = wiki.page(name)
+      File.exists?(page_path(name)) unless page.nil?
+    end
+    
+    # Retrieves the content of the cached page.
+    #
+    # name - The name of the wiki page.
+    #
+    # Returns the contents of the HTML page if cached. Otherwise returns nil.
+    def get_page(name)
+      IO.read(page_path(name)) if cache_hit?(name)
+    end
+
+    # Sets the cached content for a page.
+    #
+    # name    - The name of the wiki page.
+    # content - The content to cache.
+    #
+    # Returns nothing.
+    def set_page(name, content)
+      page = wiki.page(name)
+      if !page.nil?
+        FileUtils.mkdir_p(File.dirname(page_path(name)))
+        File.open(page_path(name), 'w') do |f|
+          f.write(content)
+        end
+      end
+    end
+
+    # Removes the cached content for a page.
+    #
+    # name    - The name of the wiki page.
+    #
+    # Returns nothing.
+    def remove_page(name)
+      page = wiki.page(name)
+      File.delete(page_path(name)) if !page.nil? && File.exists?(page_path(name))
+    end
+    
+    # Retrieves the path to the cache for a given page.
+    #
+    # name - The name of the wiki page.
+    #
+    # Returns a file path to the cached wiki page.
+    def page_path(name)
+      page = wiki.page(name)
+      if !page.nil?
+        "#{path}/#{page.path}/#{page.version}"
+      end
+    end
+  end
+end

data/lib/smeagol/version.rb

@@ -1,3 +1,3 @@
 module Smeagol
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/smeagol/views/page.rb

@@ -45,7 +45,7 @@ module Smeagol
         page.title != "Home"
       end
       
-      # Public: The HTML menu generated from the settings.yaml file.
+      # Public: The HTML menu generated from the settings.yml file.
       def menu_html
         menu = @page.wiki.settings.menu
         if !menu.nil?

data/lib/smeagol/wiki.rb

@@ -17,7 +17,7 @@ module Smeagol
     def settings
       # Cache settings if already read
       if @settings.nil?
-        file = "#{path}/settings.yaml"
+        file = "#{path}/settings.yml"
         if File.readable?(file)
           @settings = YAML::load(IO.read(file)).to_ostruct
         else

data/test/test_cache.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/helper'
+require 'fileutils'
+
+class CacheTestCase < MiniTest::Unit::TestCase
+  def setup
+    @wiki = Smeagol::Wiki.new(ENV['SMEAGOL_TEST_WIKI_PATH'])
+    @cache = Smeagol::Cache.new(@wiki)
+    @cache.clear()
+  end
+
+  def test_should_show_cache_hit
+    @cache.set_page('Home', 'abc')
+    assert @cache.cache_hit?('Home')
+  end
+  
+  def test_should_show_cache_miss
+    assert !@cache.cache_hit?('Home')
+  end
+
+  def test_should_show_cache_miss_for_nonexistent_page
+    assert !@cache.cache_hit?('THIS_IS_NOT_A_PAGE!')
+  end
+
+  def test_should_cache_page
+    @cache.set_page('Home', 'abc')
+    assert_equal 'abc', @cache.get_page('Home')
+  end
+
+  def test_should_remove_cache
+    @cache.set_page('Home', 'abc')
+    @cache.remove_page('Home')
+    assert !@cache.cache_hit?('Home')
+  end
+end

data/test/test_file.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/helper'
+
+class FileTestCase < MiniTest::Unit::TestCase
+  def test_sanitize_should_remove_parent_refs
+    assert_equal '/', File.sanitize_path('../')
+    assert_equal '/', File.sanitize_path('/..')
+    assert_equal '//', File.sanitize_path('/../')
+    assert_equal '', File.sanitize_path('..')
+    assert_equal '..abc', File.sanitize_path('..abc')
+    assert_equal '/this/is//a/test', File.sanitize_path('/this/is/../a/test')
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: smeagol
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Ben Johnson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-23 00:00:00 -06:00
+date: 2010-09-24 00:00:00 -06:00
 default_executable: smeagol
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -247,7 +247,9 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/file.rb
 - lib/smeagol/app.rb
+- lib/smeagol/cache.rb
 - lib/smeagol/hash.rb
 - lib/smeagol/public/smeagol/main.css
 - lib/smeagol/public/smeagol/pygment.css
@@ -259,6 +261,8 @@ files:
 - lib/smeagol.rb
 - README.md
 - test/helper.rb
+- test/test_cache.rb
+- test/test_file.rb
 - test/test_hash.rb
 - test/test_wiki.rb
 - bin/smeagol
@@ -298,5 +302,7 @@ specification_version: 3
 summary: A read-only server for Gollum wikis
 test_files: 
 - test/helper.rb
+- test/test_cache.rb
+- test/test_file.rb
 - test/test_hash.rb
 - test/test_wiki.rb