wiki branch merged into trunk

git-svn-id: http://redmine.rubyforge.org/svn/trunk@323 e93f8b46-1217-0410-a6f0-8f06a7374b81

app/controllers/application.rb

@@ -32,6 +32,10 @@ def logged_in_user
     end
   end
 
+  def logged_in_user_membership
+    @user_membership ||= Member.find(:first, :conditions => ["user_id=? and project_id=?", self.logged_in_user.id, @project.id])
+  end
+
   # check if login is globally required to access the application
   def check_if_login_required
     require_login if Setting.login_required?
@@ -89,6 +93,16 @@ def authorize(ctrl = params[:controller], action = params[:action])
     render :nothing => true, :status => 403
     false
   end
+
+  # make sure that the user is a member of the project (or admin) if project is private
+  # used as a before_filter for actions that do not require any particular permission on the project
+  def check_project_privacy
+    return true if @project.is_public?
+    return false unless logged_in_user
+    return true if logged_in_user.admin? || logged_in_user_membership
+    render :nothing => true, :status => 403
+    false
+  end
 
   # store current uri in session.
   # return to this location by calling redirect_back_or_default

app/controllers/projects_controller.rb

@@ -68,6 +68,10 @@ def add
         @project.repository = Repository.new
         @project.repository.attributes = params[:repository]
       end
+      if "1" == params[:wiki_enabled]
+        @project.wiki = Wiki.new
+        @project.wiki.attributes = params[:wiki]
+      end
       if @project.save
         flash[:notice] = l(:notice_successful_create)
         redirect_to :controller => 'admin', :action => 'projects'
@@ -113,6 +117,15 @@ def edit
           @project.repository.update_attributes params[:repository]
         end
       end
+      if params[:wiki_enabled]
+        case params[:wiki_enabled]
+        when "0"
+          @project.wiki.destroy
+        when "1"
+          @project.wiki ||= Wiki.new
+          @project.wiki.update_attributes params[:wiki]
+        end
+      end      
       @project.attributes = params[:project]
       if @project.save
         flash[:notice] = l(:notice_successful_update)

app/controllers/wiki_controller.rb

@@ -0,0 +1,111 @@
+# redMine - project management software
+# Copyright (C) 2006-2007  Jean-Philippe Lang
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+class WikiController < ApplicationController
+  layout 'base'
+  before_filter :find_wiki, :check_project_privacy, :except => [:preview]
+
+  # display a page (in editing mode if it doesn't exist)
+  def index
+    page_title = params[:page]
+    @page = @wiki.find_or_new_page(page_title)
+    if @page.new_record?
+      edit
+      render :action => 'edit' and return
+    end
+    @content = (params[:version] ? @page.content.versions.find_by_version(params[:version]) : @page.content)
+    if params[:export] == 'html'
+      export = render_to_string :action => 'export', :layout => false
+      send_data(export, :type => 'text/html', :filename => "#{@page.title}.html")
+      return
+    elsif params[:export] == 'txt'
+      send_data(@content.text, :type => 'text/plain', :filename => "#{@page.title}.txt")
+      return
+    end
+    render :action => 'show'
+  end
+
+  # edit an existing page or a new one
+  def edit
+    @page = @wiki.find_or_new_page(params[:page])    
+    @page.content = WikiContent.new(:page => @page) if @page.new_record?
+    @content = @page.content
+    @content.text = "h1. #{@page.pretty_title}" if @content.text.empty?
+    # don't keep previous comment
+    @content.comment = nil
+    if request.post?      
+      if @content.text == params[:content][:text]
+        # don't save if text wasn't changed
+        redirect_to :action => 'index', :id => @project, :page => @page.title
+        return
+      end
+      @content.text = params[:content][:text]
+      @content.comment = params[:content][:comment]
+      @content.author = logged_in_user
+      # if page is new @page.save will also save content, but not if page isn't a new record
+      if (@page.new_record? ? @page.save : @content.save)
+        redirect_to :action => 'index', :id => @project, :page => @page.title
+      end
+    end
+  end
+
+  # show page history
+  def history
+    @page = @wiki.find_page(params[:page])
+    # don't load text
+    @versions = @page.content.versions.find :all, 
+                                            :select => "id, author_id, comment, updated_on, version",
+                                            :order => 'version DESC'
+  end
+
+  # display special pages
+  def special
+    page_title = params[:page].downcase
+    case page_title
+    # show pages index, sorted by title
+    when 'page_index'
+      # eager load information about last updates, without loading text
+      @pages = @wiki.pages.find :all, :select => "wiki_pages.*, wiki_contents.updated_on",
+                                      :joins => "LEFT JOIN wiki_contents ON wiki_contents.page_id = wiki_pages.id",
+                                      :order => 'title'
+    # export wiki to a single html file
+    when 'export'
+      @pages = @wiki.pages.find :all, :order => 'title'
+      export = render_to_string :action => 'export_multiple', :layout => false
+      send_data(export, :type => 'text/html', :filename => "wiki.html")
+      return      
+    else
+      # requested special page doesn't exist, redirect to default page
+      redirect_to :action => 'index', :id => @project, :page => nil and return
+    end
+    render :action => "special_#{page_title}"
+  end
+
+  def preview
+    @text = params[:content][:text]
+    render :partial => 'preview'
+  end
+
+private
+
+  def find_wiki
+    @project = Project.find(params[:id])
+    @wiki = @project.wiki
+  rescue ActiveRecord::RecordNotFound
+    render_404
+  end
+end

app/helpers/application_helper.rb

@@ -63,7 +63,7 @@ def format_date(date)
   end
 
   def format_time(time)
-    l_datetime(time) if time
+    l_datetime((time.is_a? String) ? time.to_time : time) if time
   end
 
   def day_name(day)
@@ -92,10 +92,42 @@ def pagination_links_full(paginator, options={}, html_options={})
     html  
   end
 
-  def textilizable(text)
-    text = (Setting.text_formatting == 'textile') && (ActionView::Helpers::TextHelper.method_defined? "textilize") ? RedCloth.new(h(text)).to_html : simple_format(auto_link(h(text)))
-    # turn "#id" patterns into links to issues
-    text = text.gsub(/#(\d+)([^;\d])/, "<a href='/issues/show/\\1'>#\\1</a>\\2")
+  # textilize text according to system settings and RedCloth availability
+  def textilizable(text, options = {})
+    # different methods for formatting wiki links
+    case options[:wiki_links]
+    when :local
+      # used for local links to html files
+      format_wiki_link = Proc.new {|title| "#{title}.html" }
+    when :anchor
+      # used for single-file wiki export
+      format_wiki_link = Proc.new {|title| "##{title}" }
+    else
+      if @project
+        format_wiki_link = Proc.new {|title| url_for :controller => 'wiki', :action => 'index', :id => @project, :page => title }
+      else
+        format_wiki_link = Proc.new {|title| title }
+      end
+    end
+
+    # turn wiki links into textile links: 
+    # example:
+    #   [[link]] -> "link":link
+    #   [[link|title]] -> "title":link
+    text = text.gsub(/\[\[([^\]\|]+)(\|([^\]\|]+))?\]\]/) {|m| "\"#{$3 || $1}\":" + format_wiki_link.call(Wiki.titleize($1)) }
+
+    # turn issue ids to textile links
+    # example:
+    #   #52 -> "#52":/issues/show/52
+    text = text.gsub(/#(\d+)([\s\.\(\)\-,:;])/) {|m| "\"##{$1}\":" + url_for(:controller => 'issues', :action => 'show', :id => $1) + $2 }
+
+    # turn revision ids to textile links (@project needed)
+    # example:
+    #   r52 -> "r52":/repositories/revision/6?rev=52 (@project.id is 6)
+    text = text.gsub(/r(\d+)([\s\.\(\)\-,:;])/) {|m| "\"r#{$1}\":" + url_for(:controller => 'repositories', :action => 'revision', :id => @project.id, :rev => $1) + $2 } if @project
+
+    # finally textilize text
+    text = (Setting.text_formatting == 'textile') && (ActionView::Helpers::TextHelper.method_defined? "textilize") ? auto_link(RedCloth.new(text, [:filter_html]).to_html) : simple_format(auto_link(h(text)))
   end
 
   def error_messages_for(object_name, options = {})

app/helpers/wiki_helper.rb

@@ -0,0 +1,19 @@
+# redMine - project management software
+# Copyright (C) 2006-2007  Jean-Philippe Lang
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+module WikiHelper
+end

app/models/project.rb

@@ -26,13 +26,14 @@ class Project < ActiveRecord::Base
   has_many :news, :dependent => :delete_all, :include => :author
   has_many :issue_categories, :dependent => :delete_all, :order => "issue_categories.name"
   has_one :repository, :dependent => :destroy
+  has_one :wiki, :dependent => :destroy
   has_and_belongs_to_many :custom_fields, :class_name => 'IssueCustomField', :join_table => 'custom_fields_projects', :association_foreign_key => 'custom_field_id'
   acts_as_tree :order => "name", :counter_cache => true
 
   validates_presence_of :name, :description
   validates_uniqueness_of :name
   validates_associated :custom_values, :on => :update
-  validates_associated :repository
+  validates_associated :repository, :wiki
   validates_format_of :name, :with => /^[\w\s\'\-]*$/i
 
   # returns latest created projects

app/models/wiki.rb

@@ -0,0 +1,44 @@
+# redMine - project management software
+# Copyright (C) 2006-2007  Jean-Philippe Lang
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+class Wiki < ActiveRecord::Base
+  belongs_to :project
+  has_many :pages, :class_name => 'WikiPage', :dependent => :destroy
+
+  validates_presence_of :project_id, :start_page
+
+  # find the page with the given title
+  # if page doesn't exist, return a new page
+  def find_or_new_page(title)
+    title = Wiki.titleize(title || start_page)
+    find_page(title) || WikiPage.new(:wiki => self, :title => title)  
+  end
+
+  # find the page with the given title
+  def find_page(title)
+    pages.find_by_title(Wiki.titleize(title || start_page))
+  end
+
+  # turn a string into a valid page title
+  def self.titleize(title)
+    # replace spaces with _ and remove unwanted caracters
+    title = title.gsub(/\s+/, '_').delete(',;|') if title
+    # upcase the first letter
+    title = title[0..0].upcase + title[1..-1] if title
+    title
+  end  
+end

app/models/wiki_content.rb

@@ -0,0 +1,58 @@
+# redMine - project management software
+# Copyright (C) 2006-2007  Jean-Philippe Lang
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+require 'zlib'
+
+class WikiContent < ActiveRecord::Base
+  belongs_to :page, :class_name => 'WikiPage', :foreign_key => 'page_id'
+  belongs_to :author, :class_name => 'User', :foreign_key => 'author_id'
+  validates_presence_of :text
+
+  acts_as_versioned
+  class Version
+    belongs_to :author, :class_name => 'User', :foreign_key => 'author_id'
+    attr_protected :data
+
+    def text=(plain)
+      case Setting.wiki_compression
+      when 'gzip'
+      begin
+        self.data = Zlib::Deflate.deflate(plain, Zlib::BEST_COMPRESSION)
+        self.compression = 'gzip'
+      rescue
+        self.data = plain
+        self.compression = ''
+      end
+      else
+        self.data = plain
+        self.compression = ''
+      end
+      plain
+    end
+
+    def text
+      @text ||= case compression
+      when 'gzip'
+         Zlib::Inflate.inflate(data)
+      else
+        # uncompressed data
+        data
+      end      
+    end
+  end
+
+end

app/models/wiki_page.rb

@@ -0,0 +1,34 @@
+# redMine - project management software
+# Copyright (C) 2006-2007  Jean-Philippe Lang
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+class WikiPage < ActiveRecord::Base
+  belongs_to :wiki
+  has_one :content, :class_name => 'WikiContent', :foreign_key => 'page_id', :dependent => :destroy
+
+  validates_presence_of :title
+  validates_format_of :title, :with => /^[^,\s]*$/
+  validates_uniqueness_of :title, :scope => :wiki_id, :case_sensitive => false
+  validates_associated :content
+
+  def before_save
+    self.title = Wiki.titleize(title)
+  end
+
+  def pretty_title
+    title.tr '_', ' '
+  end
+end