Chris@441
|
1 # Redmine - project management software
|
Chris@441
|
2 # Copyright (C) 2006-2011 Jean-Philippe Lang
|
Chris@0
|
3 #
|
Chris@0
|
4 # This program is free software; you can redistribute it and/or
|
Chris@0
|
5 # modify it under the terms of the GNU General Public License
|
Chris@0
|
6 # as published by the Free Software Foundation; either version 2
|
Chris@0
|
7 # of the License, or (at your option) any later version.
|
Chris@441
|
8 #
|
Chris@0
|
9 # This program is distributed in the hope that it will be useful,
|
Chris@0
|
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
|
Chris@0
|
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
Chris@0
|
12 # GNU General Public License for more details.
|
Chris@441
|
13 #
|
Chris@0
|
14 # You should have received a copy of the GNU General Public License
|
Chris@0
|
15 # along with this program; if not, write to the Free Software
|
Chris@0
|
16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
Chris@0
|
17
|
Chris@0
|
18 require 'diff'
|
Chris@0
|
19
|
chris@37
|
20 # The WikiController follows the Rails REST controller pattern but with
|
chris@37
|
21 # a few differences
|
chris@37
|
22 #
|
chris@37
|
23 # * index - shows a list of WikiPages grouped by page or date
|
chris@37
|
24 # * new - not used
|
chris@37
|
25 # * create - not used
|
chris@37
|
26 # * show - will also show the form for creating a new wiki page
|
chris@37
|
27 # * edit - used to edit an existing or new page
|
chris@37
|
28 # * update - used to save a wiki page update to the database, including new pages
|
chris@37
|
29 # * destroy - normal
|
chris@37
|
30 #
|
chris@37
|
31 # Other member and collection methods are also used
|
chris@37
|
32 #
|
chris@37
|
33 # TODO: still being worked on
|
Chris@0
|
34 class WikiController < ApplicationController
|
Chris@0
|
35 default_search_scope :wiki_pages
|
Chris@0
|
36 before_filter :find_wiki, :authorize
|
Chris@441
|
37 before_filter :find_existing_or_new_page, :only => [:show, :edit, :update]
|
Chris@0
|
38 before_filter :find_existing_page, :only => [:rename, :protect, :history, :diff, :annotate, :add_attachment, :destroy]
|
Chris@0
|
39
|
Chris@0
|
40 helper :attachments
|
Chris@441
|
41 include AttachmentsHelper
|
Chris@0
|
42 helper :watchers
|
chris@37
|
43
|
chris@37
|
44 # List of pages, sorted alphabetically and by parent (hierarchy)
|
chris@37
|
45 def index
|
Chris@441
|
46 load_pages_for_index
|
Chris@441
|
47 @pages_by_parent_id = @pages.group_by(&:parent_id)
|
Chris@441
|
48 end
|
Chris@441
|
49
|
Chris@441
|
50 # List of page, by last update
|
Chris@441
|
51 def date_index
|
Chris@441
|
52 load_pages_for_index
|
Chris@441
|
53 @pages_by_date = @pages.group_by {|p| p.updated_on.to_date}
|
chris@37
|
54 end
|
chris@37
|
55
|
Chris@0
|
56 # display a page (in editing mode if it doesn't exist)
|
chris@37
|
57 def show
|
Chris@0
|
58 if @page.new_record?
|
Chris@0
|
59 if User.current.allowed_to?(:edit_wiki_pages, @project) && editable?
|
Chris@0
|
60 edit
|
Chris@0
|
61 render :action => 'edit'
|
Chris@0
|
62 else
|
Chris@0
|
63 render_404
|
Chris@0
|
64 end
|
Chris@0
|
65 return
|
Chris@0
|
66 end
|
Chris@0
|
67 if params[:version] && !User.current.allowed_to?(:view_wiki_edits, @project)
|
Chris@0
|
68 # Redirects user to the current version if he's not allowed to view previous versions
|
Chris@0
|
69 redirect_to :version => nil
|
Chris@0
|
70 return
|
Chris@0
|
71 end
|
Chris@0
|
72 @content = @page.content_for_version(params[:version])
|
Chris@0
|
73 if User.current.allowed_to?(:export_wiki_pages, @project)
|
Chris@0
|
74 if params[:format] == 'html'
|
Chris@0
|
75 export = render_to_string :action => 'export', :layout => false
|
Chris@0
|
76 send_data(export, :type => 'text/html', :filename => "#{@page.title}.html")
|
Chris@0
|
77 return
|
Chris@0
|
78 elsif params[:format] == 'txt'
|
Chris@0
|
79 send_data(@content.text, :type => 'text/plain', :filename => "#{@page.title}.txt")
|
Chris@0
|
80 return
|
Chris@0
|
81 end
|
Chris@0
|
82 end
|
Chris@0
|
83 @editable = editable?
|
Chris@0
|
84 render :action => 'show'
|
Chris@0
|
85 end
|
Chris@441
|
86
|
Chris@0
|
87 # edit an existing page or a new one
|
Chris@0
|
88 def edit
|
Chris@0
|
89 return render_403 unless editable?
|
Chris@0
|
90 @page.content = WikiContent.new(:page => @page) if @page.new_record?
|
Chris@441
|
91
|
Chris@0
|
92 @content = @page.content_for_version(params[:version])
|
Chris@0
|
93 @content.text = initial_page_content(@page) if @content.text.blank?
|
Chris@0
|
94 # don't keep previous comment
|
Chris@0
|
95 @content.comments = nil
|
chris@37
|
96
|
chris@37
|
97 # To prevent StaleObjectError exception when reverting to a previous version
|
chris@37
|
98 @content.version = @page.content.version
|
Chris@0
|
99 end
|
chris@37
|
100
|
chris@37
|
101 verify :method => :put, :only => :update, :render => {:nothing => true, :status => :method_not_allowed }
|
chris@37
|
102 # Creates a new page or updates an existing one
|
chris@37
|
103 def update
|
chris@37
|
104 return render_403 unless editable?
|
chris@37
|
105 @page.content = WikiContent.new(:page => @page) if @page.new_record?
|
Chris@441
|
106
|
chris@37
|
107 @content = @page.content_for_version(params[:version])
|
chris@37
|
108 @content.text = initial_page_content(@page) if @content.text.blank?
|
chris@37
|
109 # don't keep previous comment
|
chris@37
|
110 @content.comments = nil
|
chris@37
|
111
|
chris@37
|
112 if !@page.new_record? && params[:content].present? && @content.text == params[:content][:text]
|
chris@37
|
113 attachments = Attachment.attach_files(@page, params[:attachments])
|
chris@37
|
114 render_attachment_warning_if_needed(@page)
|
chris@37
|
115 # don't save if text wasn't changed
|
chris@37
|
116 redirect_to :action => 'show', :project_id => @project, :id => @page.title
|
chris@37
|
117 return
|
chris@37
|
118 end
|
chris@37
|
119 @content.attributes = params[:content]
|
chris@37
|
120 @content.author = User.current
|
chris@37
|
121 # if page is new @page.save will also save content, but not if page isn't a new record
|
chris@37
|
122 if (@page.new_record? ? @page.save : @content.save)
|
chris@37
|
123 attachments = Attachment.attach_files(@page, params[:attachments])
|
chris@37
|
124 render_attachment_warning_if_needed(@page)
|
chris@37
|
125 call_hook(:controller_wiki_edit_after_save, { :params => params, :page => @page})
|
chris@37
|
126 redirect_to :action => 'show', :project_id => @project, :id => @page.title
|
Chris@119
|
127 else
|
Chris@119
|
128 render :action => 'edit'
|
chris@37
|
129 end
|
chris@37
|
130
|
chris@37
|
131 rescue ActiveRecord::StaleObjectError
|
chris@37
|
132 # Optimistic locking exception
|
Chris@441
|
133 flash.now[:error] = l(:notice_locking_conflict)
|
Chris@441
|
134 render :action => 'edit'
|
chris@37
|
135 end
|
chris@37
|
136
|
Chris@0
|
137 # rename a page
|
Chris@0
|
138 def rename
|
Chris@0
|
139 return render_403 unless editable?
|
Chris@0
|
140 @page.redirect_existing_links = true
|
Chris@0
|
141 # used to display the *original* title if some AR validation errors occur
|
Chris@0
|
142 @original_title = @page.pretty_title
|
Chris@0
|
143 if request.post? && @page.update_attributes(params[:wiki_page])
|
Chris@0
|
144 flash[:notice] = l(:notice_successful_update)
|
chris@37
|
145 redirect_to :action => 'show', :project_id => @project, :id => @page.title
|
Chris@0
|
146 end
|
Chris@0
|
147 end
|
Chris@441
|
148
|
Chris@441
|
149 verify :method => :post, :only => :protect, :redirect_to => { :action => :show }
|
Chris@0
|
150 def protect
|
Chris@0
|
151 @page.update_attribute :protected, params[:protected]
|
chris@37
|
152 redirect_to :action => 'show', :project_id => @project, :id => @page.title
|
Chris@0
|
153 end
|
Chris@0
|
154
|
Chris@0
|
155 # show page history
|
Chris@0
|
156 def history
|
Chris@0
|
157 @version_count = @page.content.versions.count
|
Chris@0
|
158 @version_pages = Paginator.new self, @version_count, per_page_option, params['p']
|
Chris@441
|
159 # don't load text
|
Chris@441
|
160 @versions = @page.content.versions.find :all,
|
Chris@0
|
161 :select => "id, author_id, comments, updated_on, version",
|
Chris@0
|
162 :order => 'version DESC',
|
Chris@0
|
163 :limit => @version_pages.items_per_page + 1,
|
Chris@0
|
164 :offset => @version_pages.current.offset
|
Chris@0
|
165
|
Chris@0
|
166 render :layout => false if request.xhr?
|
Chris@0
|
167 end
|
Chris@441
|
168
|
Chris@0
|
169 def diff
|
Chris@0
|
170 @diff = @page.diff(params[:version], params[:version_from])
|
Chris@0
|
171 render_404 unless @diff
|
Chris@0
|
172 end
|
Chris@441
|
173
|
Chris@0
|
174 def annotate
|
Chris@0
|
175 @annotate = @page.annotate(params[:version])
|
Chris@0
|
176 render_404 unless @annotate
|
Chris@0
|
177 end
|
chris@37
|
178
|
chris@37
|
179 verify :method => :delete, :only => [:destroy], :redirect_to => { :action => :show }
|
Chris@0
|
180 # Removes a wiki page and its history
|
Chris@0
|
181 # Children can be either set as root pages, removed or reassigned to another parent page
|
Chris@0
|
182 def destroy
|
Chris@0
|
183 return render_403 unless editable?
|
Chris@441
|
184
|
Chris@0
|
185 @descendants_count = @page.descendants.size
|
Chris@0
|
186 if @descendants_count > 0
|
Chris@0
|
187 case params[:todo]
|
Chris@0
|
188 when 'nullify'
|
Chris@0
|
189 # Nothing to do
|
Chris@0
|
190 when 'destroy'
|
Chris@0
|
191 # Removes all its descendants
|
Chris@0
|
192 @page.descendants.each(&:destroy)
|
Chris@0
|
193 when 'reassign'
|
Chris@0
|
194 # Reassign children to another parent page
|
Chris@0
|
195 reassign_to = @wiki.pages.find_by_id(params[:reassign_to_id].to_i)
|
Chris@0
|
196 return unless reassign_to
|
Chris@0
|
197 @page.children.each do |child|
|
Chris@0
|
198 child.update_attribute(:parent, reassign_to)
|
Chris@0
|
199 end
|
Chris@0
|
200 else
|
Chris@0
|
201 @reassignable_to = @wiki.pages - @page.self_and_descendants
|
Chris@0
|
202 return
|
Chris@0
|
203 end
|
Chris@0
|
204 end
|
Chris@0
|
205 @page.destroy
|
chris@37
|
206 redirect_to :action => 'index', :project_id => @project
|
Chris@0
|
207 end
|
Chris@0
|
208
|
chris@37
|
209 # Export wiki to a single html file
|
chris@37
|
210 def export
|
chris@37
|
211 if User.current.allowed_to?(:export_wiki_pages, @project)
|
chris@37
|
212 @pages = @wiki.pages.find :all, :order => 'title'
|
chris@37
|
213 export = render_to_string :action => 'export_multiple', :layout => false
|
chris@37
|
214 send_data(export, :type => 'text/html', :filename => "wiki.html")
|
Chris@0
|
215 else
|
chris@37
|
216 redirect_to :action => 'show', :project_id => @project, :id => nil
|
Chris@0
|
217 end
|
chris@37
|
218 end
|
chris@37
|
219
|
Chris@0
|
220 def preview
|
chris@37
|
221 page = @wiki.find_page(params[:id])
|
Chris@0
|
222 # page is nil when previewing a new page
|
Chris@0
|
223 return render_403 unless page.nil? || editable?(page)
|
Chris@0
|
224 if page
|
Chris@0
|
225 @attachements = page.attachments
|
Chris@0
|
226 @previewed = page.content
|
Chris@0
|
227 end
|
Chris@0
|
228 @text = params[:content][:text]
|
Chris@0
|
229 render :partial => 'common/preview'
|
Chris@0
|
230 end
|
Chris@0
|
231
|
Chris@0
|
232 def add_attachment
|
Chris@0
|
233 return render_403 unless editable?
|
Chris@0
|
234 attachments = Attachment.attach_files(@page, params[:attachments])
|
Chris@0
|
235 render_attachment_warning_if_needed(@page)
|
chris@37
|
236 redirect_to :action => 'show', :id => @page.title, :project_id => @project
|
Chris@0
|
237 end
|
Chris@0
|
238
|
Chris@0
|
239 private
|
Chris@441
|
240
|
Chris@0
|
241 def find_wiki
|
chris@37
|
242 @project = Project.find(params[:project_id])
|
Chris@0
|
243 @wiki = @project.wiki
|
Chris@0
|
244 render_404 unless @wiki
|
Chris@0
|
245 rescue ActiveRecord::RecordNotFound
|
Chris@0
|
246 render_404
|
Chris@0
|
247 end
|
Chris@441
|
248
|
Chris@441
|
249 # Finds the requested page or a new page if it doesn't exist
|
Chris@441
|
250 def find_existing_or_new_page
|
Chris@441
|
251 @page = @wiki.find_or_new_page(params[:id])
|
Chris@441
|
252 if @wiki.page_found_with_redirect?
|
Chris@441
|
253 redirect_to params.update(:id => @page.title)
|
Chris@441
|
254 end
|
Chris@441
|
255 end
|
Chris@441
|
256
|
Chris@0
|
257 # Finds the requested page and returns a 404 error if it doesn't exist
|
Chris@0
|
258 def find_existing_page
|
chris@37
|
259 @page = @wiki.find_page(params[:id])
|
Chris@441
|
260 if @page.nil?
|
Chris@441
|
261 render_404
|
Chris@441
|
262 return
|
Chris@441
|
263 end
|
Chris@441
|
264 if @wiki.page_found_with_redirect?
|
Chris@441
|
265 redirect_to params.update(:id => @page.title)
|
Chris@441
|
266 end
|
Chris@0
|
267 end
|
Chris@441
|
268
|
Chris@0
|
269 # Returns true if the current user is allowed to edit the page, otherwise false
|
Chris@0
|
270 def editable?(page = @page)
|
Chris@0
|
271 page.editable_by?(User.current)
|
Chris@0
|
272 end
|
Chris@0
|
273
|
Chris@0
|
274 # Returns the default content of a new wiki page
|
Chris@0
|
275 def initial_page_content(page)
|
Chris@0
|
276 helper = Redmine::WikiFormatting.helper_for(Setting.text_formatting)
|
Chris@0
|
277 extend helper unless self.instance_of?(helper)
|
Chris@0
|
278 helper.instance_method(:initial_page_content).bind(self).call(page)
|
Chris@0
|
279 end
|
chris@37
|
280
|
Chris@441
|
281 def load_pages_for_index
|
Chris@441
|
282 @pages = @wiki.pages.with_updated_on.all(:order => 'title', :include => {:wiki => :project})
|
chris@37
|
283 end
|
Chris@0
|
284 end
|