picolena 0.0.99

data/README.txt

@@ -0,0 +1,59 @@
+= Picolena
+
+* http://picolena.devjavu.com
+* http://svn.devjavu.com/picolena
+
+== DESCRIPTION:
+
+Picolena is a lightweight ferret-powered documents search engine written in Ruby on rails:
+
+   1. Just let Ferret index any directory you want.
+   2. Enter queries on your browser to get corresponding documents in a few milliseconds. 
+
+== FEATURES:
+
+Picolena has many advantages:
+
+   * it can index .pdf, .doc, .docx, .odt, .xls, .ods, .ppt, .pptx, .odp, .rtf, .html and plain text files will full text search, and offers a very easy way to add new filters to index other filetype.
+   * it is free as in free beer and as in free speech
+   * thanks to Ferret, it is very fast
+   * it keeps your data private. By default, only the computer on which it is installed can get access to the search engine. Other IP addresses can then be added to a white list.
+   * it does not phone home. This claim is somewhat easier to verify on your server, with just a few lines of codes added, than on a Don't be evil black-box server.
+   * it can be used to index any ftp, smb, ssh, webdav or local directory.
+   * its user interface is available in English, German, Spanish and French.
+
+== SYNOPSIS:
+
+  picolena first_directory_to_index second_directory_to_index
+
+== REQUIREMENTS:
+
+* packages : antiword poppler-utils odt2txt html2text catdoc unrtf
+* gems     : rails ferret paginator haml rubyzip
+
+== INSTALL:
+
+* sudo gem install picolena
+
+== LICENSE:
+
+Copyright (c) 2008 Eric Duminil
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/app_generators/picolena/USAGE

@@ -0,0 +1,15 @@
+Description:
+    The 'picolena' command creates a new documents search engine,
+    indexing directories specified as parameters.
+    A default structure will be created in 'picolena' directory.
+    Since picolena is Rails-based, you can launch the search-engine
+    web-server just like you would with any Rails application.
+
+Example:
+    picolena ~/shared_documents /media/literature
+    cd picolena
+    ruby script/server
+    
+    This would create the picolena file structure, index every file
+    inside ~/shared_documents and /media/literature, and launch a
+    web-server available at http://localhost:3000

data/app_generators/picolena/config/indexed_directories.yml

@@ -0,0 +1,10 @@
+development:
+  #"first directory that should be indexed": "alias path that will be used to display 'containing directory' link"
+  #"second directory that should be indexed": "alias path that will be used to display 'containing directory' link"
+  #....
+  #alias path could be any smb, http, ftp or local directory that is available to the end-user.
+  <%= directories_to_index %>
+test:
+  "spec/test_dirs/indexed": "http://picolena.devjavu.com/browser/trunk/spec/test_dirs/indexed"
+production:
+  <%= directories_to_index %>

data/app_generators/picolena/config/white_list_ip.yml

@@ -0,0 +1,12 @@
+# Only localhost is allowed by default, any request coming from another IP will get rejected.
+# You can either add an IP address to the list:
+# 	- 192.168.0.37
+# or an IP address range:
+# 	- 192.168.0.
+# that will match any IP address whose first octets are 192.168.0
+# If you want to allow everybody, just write:
+#	Allow:
+#	  - all
+Allow:
+  - 127.0.0.1
+  - 0.0.0.0

data/app_generators/picolena/picolena_generator.rb

@@ -0,0 +1,311 @@
+require 'tempfile'
+require 'fileutils'
+require 'pathname'
+
+class PicolenaGenerator < RubiGen::Base
+  
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+  
+  default_options :destination => 'picolena'
+  
+  attr_reader :name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty? and !options[:spec_only]
+    @destination_root = options[:destination]
+
+    @directories_to_index=ARGV.collect{|relative_path|
+      abs_dir=Pathname.new(relative_path).realpath.to_s
+      "\"#{abs_dir}\" : \"#{abs_dir}\""
+    }.join("\n  ")
+    
+    extract_options
+  end
+
+  def manifest
+    script_options     = { :chmod => 0755, :shebang => options[:shebang] == DEFAULT_SHEBANG ? nil : options[:shebang] }
+    
+    record do |m|
+      #Create base dir
+      m.directory ''
+      BASEDIRS.each { |path|
+        # Ensure appropriate folder(s) exists
+        m.directory path
+        # Copy every file included in BASEDIRS
+        m.folder path, path
+      }
+
+      # Copy every Rails script with exec persmissions.
+      m.directory 'script'
+      m.directory 'script/performance'
+      m.directory 'script/process'
+      %w( about breakpointer console destroy generate performance/benchmarker performance/profiler performance/request process/reaper process/spawner process/inspector runner server plugin spec spec_server).each do |file|
+        m.file "script/#{file}", "script/#{file}", script_options
+      end
+      
+      # Picolena configuration files
+      m.file '../config/white_list_ip.yml', 'config/white_list_ip.yml'
+      m.template '../config/indexed_directories.yml', 'config/indexed_directories.yml', :assigns => {:directories_to_index => @directories_to_index}
+
+      # README, License & Rakefile
+      m.file 'MIT-LICENSE', 'LICENSE'
+      m.file '../../../README.txt', 'README'
+      m.file 'Rakefile', 'Rakefile'
+     
+      unless options[:spec_only] or options[:no_index]
+        # Indexing documents for development environment
+        m.rake 'index:create' 
+        # Mirroring Ferret development index instead of indexing documents again for production.
+        m.mirror 'tmp/ferret_indexes/development', 'tmp/ferret_indexes/production' unless options[:spec_only]
+     end
+
+      # Launching specs
+      m.rake 'spec' unless options[:no_spec]
+
+      # Cleaning up temp folder if --spec-only
+      m.clean if options[:spec_only]
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a documents search engine
+
+USAGE: #{spec.name} directory_to_be_indexed and_other_dirs_if_you_want
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+      opts.on("-d", "--destination=path", "Specify destination path (default: 'picolena')"){|options[:destination]|}
+      opts.on(nil, "--no-spec", "Install picolena without launching specs."){options[:no_spec]=true}
+      opts.on(nil, "--no-index", "Install picolena without indexing documents."){options[:no_index]=true}
+      opts.on(nil, "--spec-only", "Test picolena framework without installing it."){
+        options[:spec_only]=true
+        options[:destination]=File.join(Dir::tmpdir,"picolena_test_#{Time.now.to_i}") 
+      }
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+
+    # Installation skeleton.  Intermediate directories are automatically
+    # created so don't sweat their absence here.
+    BASEDIRS = %w(
+    app
+    app/controllers
+    app/helpers
+    app/models
+    app/views
+    app/views/documents
+    app/views/layouts
+    config
+    config/environments
+    config/initializers
+    doc
+    lang
+    lang/ui
+    lib
+    lib/filters
+    lib/tasks
+    log
+    public
+    public/help
+    public/images
+    public/images/icons
+    public/javascripts
+    public/stylesheets
+    spec
+    spec/controllers
+    spec/fixtures
+    spec/helpers
+    spec/models
+    spec/test_dirs
+    spec/test_dirs/empty_folder
+    spec/test_dirs/indexed
+    spec/test_dirs/indexed/basic
+    spec/test_dirs/indexed/different_encodings
+    spec/test_dirs/indexed/just_one_doc
+    spec/test_dirs/indexed/literature
+    spec/test_dirs/indexed/others
+    spec/test_dirs/indexed/others/nested
+    spec/test_dirs/indexed/yet_another_dir
+    spec/test_dirs/not_indexed
+    spec/views
+    spec/views/application
+    tmp
+    tmp/cache
+    tmp/ferret_indexes
+    tmp/pids
+    tmp/sessions
+    tmp/sockets
+    vendor
+    vendor/plugins
+    vendor/plugins/globalite
+    vendor/plugins/globalite/data
+    vendor/plugins/globalite/lang
+    vendor/plugins/globalite/lang/rails
+    vendor/plugins/globalite/lib
+    vendor/plugins/globalite/lib/globalite
+    vendor/plugins/globalite/lib/rails
+    vendor/plugins/globalite/rdoc
+    vendor/plugins/globalite/rdoc/classes
+    vendor/plugins/globalite/rdoc/classes/ActionView
+    vendor/plugins/globalite/rdoc/classes/ActionView/Helpers
+    vendor/plugins/globalite/rdoc/classes/ActiveRecord
+    vendor/plugins/globalite/rdoc/classes/Globalite
+    vendor/plugins/globalite/rdoc/files
+    vendor/plugins/globalite/rdoc/files/lib
+    vendor/plugins/globalite/rdoc/files/lib/globalite
+    vendor/plugins/globalite/rdoc/files/lib/rails
+    vendor/plugins/globalite/spec
+    vendor/plugins/globalite/spec/helpers
+    vendor/plugins/globalite/spec/lang
+    vendor/plugins/globalite/spec/lang/rails
+    vendor/plugins/globalite/spec/lang/ui
+    vendor/plugins/globalite/tasks
+    vendor/plugins/haml
+    vendor/plugins/rspec
+    vendor/plugins/rspec/autotest
+    vendor/plugins/rspec/bin
+    vendor/plugins/rspec/examples
+    vendor/plugins/rspec/examples/pure
+    vendor/plugins/rspec/examples/stories
+    vendor/plugins/rspec/examples/stories/game-of-life
+    vendor/plugins/rspec/examples/stories/game-of-life/behaviour
+    vendor/plugins/rspec/examples/stories/game-of-life/behaviour/examples
+    vendor/plugins/rspec/examples/stories/game-of-life/behaviour/stories
+    vendor/plugins/rspec/examples/stories/game-of-life/life
+    vendor/plugins/rspec/examples/stories/steps
+    vendor/plugins/rspec/failing_examples
+    vendor/plugins/rspec/lib
+    vendor/plugins/rspec/lib/autotest
+    vendor/plugins/rspec/lib/spec
+    vendor/plugins/rspec/lib/spec/example
+    vendor/plugins/rspec/lib/spec/expectations
+    vendor/plugins/rspec/lib/spec/expectations/differs
+    vendor/plugins/rspec/lib/spec/expectations/extensions
+    vendor/plugins/rspec/lib/spec/extensions
+    vendor/plugins/rspec/lib/spec/interop
+    vendor/plugins/rspec/lib/spec/interop/test
+    vendor/plugins/rspec/lib/spec/interop/test/unit
+    vendor/plugins/rspec/lib/spec/interop/test/unit/ui
+    vendor/plugins/rspec/lib/spec/interop/test/unit/ui/console
+    vendor/plugins/rspec/lib/spec/matchers
+    vendor/plugins/rspec/lib/spec/mocks
+    vendor/plugins/rspec/lib/spec/mocks/extensions
+    vendor/plugins/rspec/lib/spec/rake
+    vendor/plugins/rspec/lib/spec/runner
+    vendor/plugins/rspec/lib/spec/runner/formatter
+    vendor/plugins/rspec/lib/spec/runner/formatter/story
+    vendor/plugins/rspec/lib/spec/story
+    vendor/plugins/rspec/lib/spec/story/extensions
+    vendor/plugins/rspec/lib/spec/story/runner
+    vendor/plugins/rspec/plugins
+    vendor/plugins/rspec/plugins/mock_frameworks
+    vendor/plugins/rspec/pre_commit
+    vendor/plugins/rspec/pre_commit/lib
+    vendor/plugins/rspec/pre_commit/lib/pre_commit
+    vendor/plugins/rspec/pre_commit/spec
+    vendor/plugins/rspec/pre_commit/spec/pre_commit
+    vendor/plugins/rspec/rake_tasks
+    vendor/plugins/rspec/spec
+    vendor/plugins/rspec/spec/autotest
+    vendor/plugins/rspec/spec/spec
+    vendor/plugins/rspec/spec/spec/example
+    vendor/plugins/rspec/spec/spec/expectations
+    vendor/plugins/rspec/spec/spec/expectations/differs
+    vendor/plugins/rspec/spec/spec/expectations/extensions
+    vendor/plugins/rspec/spec/spec/extensions
+    vendor/plugins/rspec/spec/spec/interop
+    vendor/plugins/rspec/spec/spec/interop/test
+    vendor/plugins/rspec/spec/spec/interop/test/unit
+    vendor/plugins/rspec/spec/spec/interop/test/unit/resources
+    vendor/plugins/rspec/spec/spec/matchers
+    vendor/plugins/rspec/spec/spec/mocks
+    vendor/plugins/rspec/spec/spec/package
+    vendor/plugins/rspec/spec/spec/runner
+    vendor/plugins/rspec/spec/spec/runner/formatter
+    vendor/plugins/rspec/spec/spec/runner/formatter/story
+    vendor/plugins/rspec/spec/spec/runner/resources
+    vendor/plugins/rspec/spec/spec/runner/spec_parser
+    vendor/plugins/rspec/spec/spec/story
+    vendor/plugins/rspec/spec/spec/story/extensions
+    vendor/plugins/rspec/spec/spec/story/runner
+    vendor/plugins/rspec/stories
+    vendor/plugins/rspec/stories/example_groups
+    vendor/plugins/rspec/stories/interop
+    vendor/plugins/rspec/stories/pending_stories
+    vendor/plugins/rspec/stories/resources
+    vendor/plugins/rspec/stories/resources/helpers
+    vendor/plugins/rspec/stories/resources/matchers
+    vendor/plugins/rspec/stories/resources/spec
+    vendor/plugins/rspec/stories/resources/steps
+    vendor/plugins/rspec/stories/resources/stories
+    vendor/plugins/rspec/stories/resources/test
+    vendor/plugins/rspec/story_server
+    vendor/plugins/rspec/story_server/prototype
+    vendor/plugins/rspec/story_server/prototype/javascripts
+    vendor/plugins/rspec/story_server/prototype/lib
+    vendor/plugins/rspec/story_server/prototype/stylesheets
+    vendor/plugins/rspec_on_rails
+    vendor/plugins/rspec_on_rails/generators
+    vendor/plugins/rspec_on_rails/generators/helpers
+    vendor/plugins/rspec_on_rails/generators/rspec
+    vendor/plugins/rspec_on_rails/generators/rspec/templates
+    vendor/plugins/rspec_on_rails/generators/rspec/templates/script
+    vendor/plugins/rspec_on_rails/generators/rspec_controller
+    vendor/plugins/rspec_on_rails/generators/rspec_controller/templates
+    vendor/plugins/rspec_on_rails/generators/rspec_model
+    vendor/plugins/rspec_on_rails/generators/rspec_model/templates
+    vendor/plugins/rspec_on_rails/generators/rspec_scaffold
+    vendor/plugins/rspec_on_rails/generators/rspec_scaffold/templates
+    vendor/plugins/rspec_on_rails/lib
+    vendor/plugins/rspec_on_rails/lib/autotest
+    vendor/plugins/rspec_on_rails/lib/spec
+    vendor/plugins/rspec_on_rails/lib/spec/rails
+    vendor/plugins/rspec_on_rails/lib/spec/rails/example
+    vendor/plugins/rspec_on_rails/lib/spec/rails/extensions
+    vendor/plugins/rspec_on_rails/lib/spec/rails/extensions/action_controller
+    vendor/plugins/rspec_on_rails/lib/spec/rails/extensions/action_view
+    vendor/plugins/rspec_on_rails/lib/spec/rails/extensions/active_record
+    vendor/plugins/rspec_on_rails/lib/spec/rails/extensions/spec
+    vendor/plugins/rspec_on_rails/lib/spec/rails/extensions/spec/example
+    vendor/plugins/rspec_on_rails/lib/spec/rails/extensions/spec/matchers
+    vendor/plugins/rspec_on_rails/lib/spec/rails/matchers
+    vendor/plugins/rspec_on_rails/spec
+    vendor/plugins/rspec_on_rails/spec/rails
+    vendor/plugins/rspec_on_rails/spec/rails/autotest
+    vendor/plugins/rspec_on_rails/spec/rails/example
+    vendor/plugins/rspec_on_rails/spec/rails/extensions
+    vendor/plugins/rspec_on_rails/spec/rails/matchers
+    vendor/plugins/rspec_on_rails/spec/rails/mocks
+    vendor/plugins/rspec_on_rails/spec_resources
+    vendor/plugins/rspec_on_rails/spec_resources/controllers
+    vendor/plugins/rspec_on_rails/spec_resources/helpers
+    vendor/plugins/rspec_on_rails/spec_resources/views
+    vendor/plugins/rspec_on_rails/spec_resources/views/controller_spec
+    vendor/plugins/rspec_on_rails/spec_resources/views/render_spec
+    vendor/plugins/rspec_on_rails/spec_resources/views/rjs_spec
+    vendor/plugins/rspec_on_rails/spec_resources/views/tag_spec
+    vendor/plugins/rspec_on_rails/spec_resources/views/view_spec
+    vendor/plugins/rspec_on_rails/spec_resources/views/view_spec/foo
+    vendor/plugins/rspec_on_rails/stories
+    vendor/plugins/rspec_on_rails/stories/steps
+    vendor/plugins/rspec_on_rails/tasks
+)
+end

data/app_generators/picolena/templates/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Eric Duminil
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/app_generators/picolena/templates/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/app_generators/picolena/templates/app/controllers/application.rb

@@ -0,0 +1,24 @@
+class ApplicationController < ActionController::Base  
+  session :disabled => true
+  before_filter :should_only_be_available_for_white_list_IPs, :except=> :access_denied
+  
+  # In case of an unknown IP address
+  def access_denied
+    render :text=>'Access denied', :status => 403
+  end
+  
+  # In case route hasn't been recognised
+  def unknown_request
+    flash[:warning]="Unknown URL"
+    redirect_to documents_url
+  end
+  
+  private
+  
+  def should_only_be_available_for_white_list_IPs
+    unless request.remote_ip =~ WhiteListIPs
+      redirect_to :controller => 'application', :action=>'access_denied'
+      return false
+    end
+  end
+end

data/app_generators/picolena/templates/app/controllers/documents_controller.rb

@@ -0,0 +1,49 @@
+class DocumentsController < ApplicationController  
+  before_filter :check_if_valid_link, :only=> [:download, :show_content]
+  
+  # Actually doesn't check anything at all. Just a redirect to show_document(query)
+  #
+  # FIXME: remove this useless action, and go directly from submit button to GET :action => show
+  def check_query
+    redirect_to :action=>'show', :id=>params[:query]
+  end
+  
+  
+  # Show the matching documents for a given query
+  def show
+    start=Time.now
+      @query=[params[:id],params.delete(:format)].compact.join('.')
+      page=params[:page]||1
+      finder=Finder.new(@query,page)
+      finder.execute!
+      pager=::Paginator.new(finder.total_hits, ResultsPerPage) do |offset, per_page|
+        finder.matching_documents
+      end
+      @matching_documents=pager.page(page)
+      @total_hits=finder.total_hits
+    @time_needed=Time.now-start
+  end
+  
+  
+  # Download the file whose md5 path's checksum is given.
+  # If the checksum is incorrect, redirect to documents_url via no_valid_link
+  def download
+    send_file @document.complete_path  
+  end
+  
+  def show_content
+  end
+  
+  private
+  
+  def check_if_valid_link
+    @md5_hash=params[:id]
+    @document=Finder.new("md5:"<<@md5_hash).matching_document rescue no_valid_link
+  end
+  
+  def no_valid_link
+    flash[:warning]="no valid link"
+    redirect_to documents_url
+    return false
+  end
+end

data/app_generators/picolena/templates/app/helpers/application_helper.rb

@@ -0,0 +1,6 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+  def nothing_found?
+    @matching_documents.nil? or @matching_documents.entries.empty?
+  end
+end

data/app_generators/picolena/templates/app/helpers/documents_helper.rb

@@ -0,0 +1,70 @@
+module DocumentsHelper
+  def should_paginate(page,query)
+      [(link_to("←←", :action => :show, :id => query, :page => 1) if page.number>2),
+      (link_to("←", :action => :show, :id => query, :page => page.prev.number) if page.prev?),
+      (link_to("→", :action => :show, :id => query, :page => page.next.number) if page.next?)].compact.join(" | ")
+  end
+  
+  def describe_results(page, total_hits, dt, query)
+    [:results.l,
+    content_tag(:strong,"#{page.first_item_number}-#{page.last_item_number}"),
+    :of.l,
+    content_tag(:strong,total_hits),
+    :for.l,
+    content_tag(:strong,query),
+    show_time_needed(dt)
+    ].join(' ')
+  end
+  
+  def show_time_needed(dt)
+    content_tag(:small,'('<<number_with_precision(dt,3)<<'s)')
+  end
+
+  def highlight_matching_content(document)
+    content_tag(:ul,document.matching_content.collect{|sentence|
+      content_tag(:li,h(sentence).gsub(/&lt;&lt;(.*?)&gt;&gt;/,'<strong>\1</strong>').gsub(/\v|\f/,''))
+    }) if document.matching_content
+  end
+  
+  def icon_and_filename_for(result)
+    [icon_for(result.extname),result.filename].join("&nbsp;")
+  end
+  
+  def icon_for(filetype)    
+    pic_for_exts={
+      :xls=>%w{xls xlsx ods},
+      :doc=>%w{doc odt rtf dot docx dotx},
+      :pdf=>%w{pdf},
+      :txt=>%w{txt text tex bib log ini no_extension},
+      :ogg=>%w{mp3 ogg wma wav wmv tee},
+      :html=>%w{html htm},
+      :ppt=>%w{ppt pps pptx odp},
+      :package=>%w{gz rar zip bak},
+      :picture=>%w{psd jpg png gif eps bmp ico},
+      :cad=>%w{dwg dxf},
+      :exe=>%w{exe dll},
+      :video=>%w{avi wmv mpg mpeg},
+      :code=>%w{for cpp c rb java},
+      :insel=>%w{ins vee}
+    }
+    pic=pic_for_exts.find{|pic, extensions|
+      extensions.any? { |ext| filetype.sub(/\./,'').downcase==ext}
+    }
+    image_tag("icons/#{pic.first}.png") if pic
+  end
+  
+  def google?(query)
+    link_to "Google?", "http://www.google.de/search?q=#{query}"
+  end
+  
+  def link_to_containing_directory(document)
+    link_name=image_tag('icons/remote_folder.png')<<'&nbsp;'<<content_tag(:small,document.alias_path)
+    link_to link_name, document.alias_path, :target=>'_blank'
+  end
+  
+  def link_to_plain_text_content(document)
+    return unless document.supported?
+    link_name=image_tag('icons/plain_text_small.png')<<'&nbsp;'<<content_tag(:small,:text_content.l)
+    link_to link_name, show_content_document_path(document.md5)
+  end
+end

data/app_generators/picolena/templates/app/models/document.rb

@@ -0,0 +1,72 @@
+class Document
+  attr_reader :complete_path
+  attr_accessor :user, :score, :matching_content
+  
+  def initialize(complete_path)
+    @complete_path=complete_path
+    validate_existence_of_file
+    validate_in_indexed_directory
+  end
+  
+  def to_param
+    id
+  end
+  
+  def to_s
+    filename
+  end
+  
+  #Delegating properties to File::method_name(complete_path)
+  [:dirname, :basename, :extname, :size?, :file?, :read, :ext_as_sym].each{|method_name|
+    define_method(method_name){File.send(method_name,complete_path)}
+  }
+  alias_method :size, :size?
+  alias_method :content, :read
+  alias_method :filename, :basename
+  
+  def basename
+    filename.chomp(extname)
+  end
+    
+  def absolute_dirname
+    Pathname.new(dirname).realpath.to_s
+  end
+  
+  def alias_path
+    original_dir=indexed_directory
+    alias_dir=IndexedDirectories[original_dir]
+    absolute_dirname.sub(original_dir,alias_dir)
+  end
+  
+  def md5
+    @md5=Digest::MD5.hexdigest(complete_path)
+  end
+  
+  def supported?
+    PlainText.supported_extensions.include?(self.ext_as_sym)
+  end
+  
+  def content
+    PlainText.extract_content_from(complete_path)
+  end
+  
+  private
+  
+  def in_indexed_directory?
+    !indexed_directory.nil?
+  end
+  
+  def indexed_directory
+    IndexedDirectories.keys.find{|indexed_dir|
+      absolute_dirname.starts_with?(indexed_dir)
+    }    
+  end
+  
+  def validate_existence_of_file
+    raise Errno::ENOENT, @complete_path unless file?
+  end
+  
+  def validate_in_indexed_directory
+    raise ArgumentError, "required document is not in indexed directory" unless in_indexed_directory?
+  end
+end