jro_apps/redmine Commit - r11727:3e9aeea75d7f

1

# Redmine - project management software

1

# Redmine - project management software

2

3

#

3

#

4

# This program is free software; you can redistribute it and/or

4

# This program is free software; you can redistribute it and/or

5

# modify it under the terms of the GNU General Public License

5

# modify it under the terms of the GNU General Public License

6

# as published by the Free Software Foundation; either version 2

6

# as published by the Free Software Foundation; either version 2

7

# of the License, or (at your option) any later version.

7

# of the License, or (at your option) any later version.

8

#

8

#

9

# This program is distributed in the hope that it will be useful,

9

# This program is distributed in the hope that it will be useful,

10

# but WITHOUT ANY WARRANTY; without even the implied warranty of

10

# but WITHOUT ANY WARRANTY; without even the implied warranty of

11

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

11

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

12

# GNU General Public License for more details.

12

# GNU General Public License for more details.

13

#

13

#

14

# You should have received a copy of the GNU General Public License

14

# You should have received a copy of the GNU General Public License

15

# along with this program; if not, write to the Free Software

15

# along with this program; if not, write to the Free Software

16

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

16

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

17

18

require 'uri'

18

require 'uri'

19

require 'cgi'

19

require 'cgi'

20

21

class Unauthorized < Exception; end

21

class Unauthorized < Exception; end

22

23

class ApplicationController < ActionController::Base

23

class ApplicationController < ActionController::Base

24

include Redmine::I18n

24

include Redmine::I18n

25

include Redmine::Pagination

25

include Redmine::Pagination

26

include RoutesHelper

26

include RoutesHelper

27

helper :routes

27

helper :routes

28

29

class_attribute :accept_api_auth_actions

29

class_attribute :accept_api_auth_actions

30

class_attribute :accept_rss_auth_actions

30

class_attribute :accept_rss_auth_actions

31

class_attribute :model_object

31

class_attribute :model_object

32

33

layout 'base'

33

layout 'base'

34

35

protect_from_forgery

35

protect_from_forgery

36

def handle_unverified_request

36

def handle_unverified_request

37

super

37

super

38

cookies.delete(autologin_cookie_name)

38

cookies.delete(autologin_cookie_name)

39

end

39

end

40

41

before_filter :session_expiration, :user_setup, :check_if_login_required, :set_localization

41

before_filter :session_expiration, :user_setup, :check_if_login_required, :set_localization

42

43

rescue_from ActionController::InvalidAuthenticityToken, :with => :invalid_authenticity_token

43

rescue_from ActionController::InvalidAuthenticityToken, :with => :invalid_authenticity_token

44

rescue_from ::Unauthorized, :with => :deny_access

44

rescue_from ::Unauthorized, :with => :deny_access

45

rescue_from ::ActionView::MissingTemplate, :with => :missing_template

45

rescue_from ::ActionView::MissingTemplate, :with => :missing_template

46

47

include Redmine::Search::Controller

47

include Redmine::Search::Controller

48

include Redmine::MenuManager::MenuController

48

include Redmine::MenuManager::MenuController

49

helper Redmine::MenuManager::MenuHelper

49

helper Redmine::MenuManager::MenuHelper

50

51

def session_expiration

51

def session_expiration

52

if session[:user_id]

52

if session[:user_id]

53

if session_expired? && !try_to_autologin

53

if session_expired? && !try_to_autologin

54

reset_session

54

reset_session

55

flash[:error] = l(:error_session_expired)

55

flash[:error] = l(:error_session_expired)

56

redirect_to signin_url

56

redirect_to signin_url

57

else

57

else

58

session[:atime] = Time.now.utc.to_i

58

session[:atime] = Time.now.utc.to_i

59

end

59

end

60

end

60

end

61

end

61

end

62

63

def session_expired?

63

def session_expired?

64

if Setting.session_lifetime?

64

if Setting.session_lifetime?

65

unless session[:ctime] && (Time.now.utc.to_i - session[:ctime].to_i <= Setting.session_lifetime.to_i * 60)

65

unless session[:ctime] && (Time.now.utc.to_i - session[:ctime].to_i <= Setting.session_lifetime.to_i * 60)

66

return true

66

return true

67

end

67

end

68

end

68

end

69

if Setting.session_timeout?

69

if Setting.session_timeout?

70

unless session[:atime] && (Time.now.utc.to_i - session[:atime].to_i <= Setting.session_timeout.to_i * 60)

70

unless session[:atime] && (Time.now.utc.to_i - session[:atime].to_i <= Setting.session_timeout.to_i * 60)

71

return true

71

return true

72

end

72

end

73

end

73

end

74

false

74

false

75

end

75

end

76

77

def start_user_session(user)

77

def start_user_session(user)

78

session[:user_id] = user.id

78

session[:user_id] = user.id

79

session[:ctime] = Time.now.utc.to_i

79

session[:ctime] = Time.now.utc.to_i

80

session[:atime] = Time.now.utc.to_i

80

session[:atime] = Time.now.utc.to_i

81

end

81

end

82

83

def user_setup

83

def user_setup

84

# Check the settings cache for each request

84

# Check the settings cache for each request

85

Setting.check_cache

85

Setting.check_cache

86

# Find the current user

86

# Find the current user

87

User.current = find_current_user

87

User.current = find_current_user

88

logger.info(" Current user: " + (User.current.logged? ? "#{User.current.login} (id=#{User.current.id})" : "anonymous")) if logger

88

logger.info(" Current user: " + (User.current.logged? ? "#{User.current.login} (id=#{User.current.id})" : "anonymous")) if logger

89

end

89

end

90

91

# Returns the current user or nil if no user is logged in

91

# Returns the current user or nil if no user is logged in

92

# and starts a session if needed

92

# and starts a session if needed

93

def find_current_user

93

def find_current_user

94

user = nil

94

user = nil

95

unless api_request?

95

unless api_request?

96

if session[:user_id]

96

if session[:user_id]

97

# existing session

97

# existing session

98

user = (User.active.find(session[:user_id]) rescue nil)

98

user = (User.active.find(session[:user_id]) rescue nil)

99

elsif autologin_user = try_to_autologin

99

elsif autologin_user = try_to_autologin

100

user = autologin_user

100

user = autologin_user

101

elsif params[:format] == 'atom' && params[:key] && request.get? && accept_rss_auth?

101

elsif params[:format] == 'atom' && params[:key] && request.get? && accept_rss_auth?

102

# RSS key authentication does not start a session

102

# RSS key authentication does not start a session

103

user = User.find_by_rss_key(params[:key])

103

user = User.find_by_rss_key(params[:key])

104

end

104

end

105

end

105

end

106

if user.nil? && Setting.rest_api_enabled? && accept_api_auth?

106

if user.nil? && Setting.rest_api_enabled? && accept_api_auth?

107

if (key = api_key_from_request)

107

if (key = api_key_from_request)

108

# Use API key

108

# Use API key

109

user = User.find_by_api_key(key)

109

user = User.find_by_api_key(key)

110

else

110

else

111

# HTTP Basic, either username/password or API key/random

111

# HTTP Basic, either username/password or API key/random

112

authenticate_with_http_basic do |username, password|

112

authenticate_with_http_basic do |username, password|

113

user = User.try_to_login(username, password) || User.find_by_api_key(username)

113

user = User.try_to_login(username, password) || User.find_by_api_key(username)

114

end

114

end

115

end

115

end

116

# Switch user if requested by an admin user

116

# Switch user if requested by an admin user

117

if user && user.admin? && (username = api_switch_user_from_request)

117

if user && user.admin? && (username = api_switch_user_from_request)

118

su = User.find_by_login(username)

118

su = User.find_by_login(username)

119

if su && su.active?

119

if su && su.active?

120

logger.info(" User switched by: #{user.login} (id=#{user.id})") if logger

120

logger.info(" User switched by: #{user.login} (id=#{user.id})") if logger

121

user = su

121

user = su

122

else

122

else

123

render_error :message => 'Invalid X-Redmine-Switch-User header', :status => 412

123

render_error :message => 'Invalid X-Redmine-Switch-User header', :status => 412

124

end

124

end

125

end

125

end

126

end

126

end

127

user

127

user

128

end

128

end

129

130

def autologin_cookie_name

130

def autologin_cookie_name

131

Redmine::Configuration['autologin_cookie_name'].presence || 'autologin'

131

Redmine::Configuration['autologin_cookie_name'].presence || 'autologin'

132

end

132

end

133

134

def try_to_autologin

134

def try_to_autologin

135

if cookies[autologin_cookie_name] && Setting.autologin?

135

if cookies[autologin_cookie_name] && Setting.autologin?

136

# auto-login feature starts a new session

136

# auto-login feature starts a new session

137

user = User.try_to_autologin(cookies[autologin_cookie_name])

137

user = User.try_to_autologin(cookies[autologin_cookie_name])

138

if user

138

if user

139

reset_session

139

reset_session

140

start_user_session(user)

140

start_user_session(user)

141

end

141

end

142

user

142

user

143

end

143

end

144

end

144

end

145

146

# Sets the logged in user

146

# Sets the logged in user

147

def logged_user=(user)

147

def logged_user=(user)

148

reset_session

148

reset_session

149

if user && user.is_a?(User)

149

if user && user.is_a?(User)

150

User.current = user

150

User.current = user

151

start_user_session(user)

151

start_user_session(user)

152

else

152

else

153

User.current = User.anonymous

153

User.current = User.anonymous

154

end

154

end

155

end

155

end

156

157

# Logs out current user

157

# Logs out current user

158

def logout_user

158

def logout_user

159

if User.current.logged?

159

if User.current.logged?

160

cookies.delete(autologin_cookie_name)

160

cookies.delete(autologin_cookie_name)

161

Token.delete_all(["user_id = ? AND action = ?", User.current.id, 'autologin'])

161

Token.delete_all(["user_id = ? AND action = ?", User.current.id, 'autologin'])

162

self.logged_user = nil

162

self.logged_user = nil

163

end

163

end

164

end

164

end

165

166

# check if login is globally required to access the application

166

# check if login is globally required to access the application

167

def check_if_login_required

167

def check_if_login_required

168

# no check needed if user is already logged in

168

# no check needed if user is already logged in

169

return true if User.current.logged?

169

return true if User.current.logged?

170

require_login if Setting.login_required?

170

require_login if Setting.login_required?

171

end

171

end

172

173

def set_localization

173

def set_localization

174

lang = nil

174

lang = nil

175

if User.current.logged?

175

if User.current.logged?

176

lang = find_language(User.current.language)

176

lang = find_language(User.current.language)

177

end

177

end

178

if lang.nil? && request.env['HTTP_ACCEPT_LANGUAGE']

178

if lang.nil? && request.env['HTTP_ACCEPT_LANGUAGE']

179

accept_lang = parse_qvalues(request.env['HTTP_ACCEPT_LANGUAGE']).first

179

accept_lang = parse_qvalues(request.env['HTTP_ACCEPT_LANGUAGE']).first

180

if !accept_lang.blank?

180

if !accept_lang.blank?

181

accept_lang = accept_lang.downcase

181

accept_lang = accept_lang.downcase

182

lang = find_language(accept_lang) || find_language(accept_lang.split('-').first)

182

lang = find_language(accept_lang) || find_language(accept_lang.split('-').first)

183

end

183

end

184

end

184

end

185

lang ||= Setting.default_language

185

lang ||= Setting.default_language

186

set_language_if_valid(lang)

186

set_language_if_valid(lang)

187

end

187

end

188

189

def require_login

189

def require_login

190

if !User.current.logged?

190

if !User.current.logged?

191

# Extract only the basic url parameters on non-GET requests

191

# Extract only the basic url parameters on non-GET requests

192

if request.get?

192

if request.get?

193

url = url_for(params)

193

url = url_for(params)

194

else

194

else

195

url = url_for(:controller => params[:controller], :action => params[:action], :id => params[:id], :project_id => params[:project_id])

195

url = url_for(:controller => params[:controller], :action => params[:action], :id => params[:id], :project_id => params[:project_id])

196

end

196

end

197

respond_to do |format|

197

respond_to do |format|

198

format.html { redirect_to :controller => "account", :action => "login", :back_url => url }

198

format.html { redirect_to :controller => "account", :action => "login", :back_url => url }

199

format.atom { redirect_to :controller => "account", :action => "login", :back_url => url }

199

format.atom { redirect_to :controller => "account", :action => "login", :back_url => url }

200

format.xml { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' }

200

format.xml { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' }

201

format.js { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' }

201

format.js { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' }

202

format.json { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' }

202

format.json { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' }

203

end

203

end

204

return false

204

return false

205

end

205

end

206

true

206

true

207

end

207

end

208

209

def require_admin

209

def require_admin

210

return unless require_login

210

return unless require_login

211

if !User.current.admin?

211

if !User.current.admin?

212

render_403

212

render_403

213

return false

213

return false

214

end

214

end

215

true

215

true

216

end

216

end

217

218

def deny_access

218

def deny_access

219

User.current.logged? ? render_403 : require_login

219

User.current.logged? ? render_403 : require_login

220

end

220

end

221

222

# Authorize the user for the requested action

222

# Authorize the user for the requested action

223

def authorize(ctrl = params[:controller], action = params[:action], global = false)

223

def authorize(ctrl = params[:controller], action = params[:action], global = false)

224

allowed = User.current.allowed_to?({:controller => ctrl, :action => action}, @project || @projects, :global => global)

224

allowed = User.current.allowed_to?({:controller => ctrl, :action => action}, @project || @projects, :global => global)

225

if allowed

225

if allowed

226

true

226

true

227

else

227

else

228

if @project && @project.archived?

228

if @project && @project.archived?

229

render_403 :message => :notice_not_authorized_archived_project

229

render_403 :message => :notice_not_authorized_archived_project

230

else

230

else

231

deny_access

231

deny_access

232

end

232

end

233

end

233

end

234

end

234

end

235

236

# Authorize the user for the requested action outside a project

236

# Authorize the user for the requested action outside a project

237

def authorize_global(ctrl = params[:controller], action = params[:action], global = true)

237

def authorize_global(ctrl = params[:controller], action = params[:action], global = true)

238

authorize(ctrl, action, global)

238

authorize(ctrl, action, global)

239

end

239

end

240

241

# Find project of id params[:id]

241

# Find project of id params[:id]

242

def find_project

242

def find_project

243

@project = Project.find(params[:id])

243

@project = Project.find(params[:id])

244

rescue ActiveRecord::RecordNotFound

244

rescue ActiveRecord::RecordNotFound

245

render_404

245

render_404

246

end

246

end

247

248

# Find project of id params[:project_id]

248

# Find project of id params[:project_id]

249

def find_project_by_project_id

249

def find_project_by_project_id

250

@project = Project.find(params[:project_id])

250

@project = Project.find(params[:project_id])

251

rescue ActiveRecord::RecordNotFound

251

rescue ActiveRecord::RecordNotFound

252

render_404

252

render_404

253

end

253

end

254

255

# Find a project based on params[:project_id]

255

# Find a project based on params[:project_id]

256

# TODO: some subclasses override this, see about merging their logic

256

# TODO: some subclasses override this, see about merging their logic

257

def find_optional_project

257

def find_optional_project

258

@project = Project.find(params[:project_id]) unless params[:project_id].blank?

258

@project = Project.find(params[:project_id]) unless params[:project_id].blank?

259

allowed = User.current.allowed_to?({:controller => params[:controller], :action => params[:action]}, @project, :global => true)

259

allowed = User.current.allowed_to?({:controller => params[:controller], :action => params[:action]}, @project, :global => true)

260

allowed ? true : deny_access

260

allowed ? true : deny_access

261

rescue ActiveRecord::RecordNotFound

261

rescue ActiveRecord::RecordNotFound

262

render_404

262

render_404

263

end

263

end

264

265

# Finds and sets @project based on @object.project

265

# Finds and sets @project based on @object.project

266

def find_project_from_association

266

def find_project_from_association

267

render_404 unless @object.present?

267

render_404 unless @object.present?

268

269

@project = @object.project

269

@project = @object.project

270

end

270

end

271

272

def find_model_object

272

def find_model_object

273

model = self.class.model_object

273

model = self.class.model_object

274

if model

274

if model

275

@object = model.find(params[:id])

275

@object = model.find(params[:id])

276

self.instance_variable_set('@' + controller_name.singularize, @object) if @object

276

self.instance_variable_set('@' + controller_name.singularize, @object) if @object

277

end

277

end

278

rescue ActiveRecord::RecordNotFound

278

rescue ActiveRecord::RecordNotFound

279

render_404

279

render_404

280

end

280

end

281

282

def self.model_object(model)

282

def self.model_object(model)

283

self.model_object = model

283

self.model_object = model

284

end

284

end

285

286

# Find the issue whose id is the :id parameter

286

# Find the issue whose id is the :id parameter

287

# Raises a Unauthorized exception if the issue is not visible

287

# Raises a Unauthorized exception if the issue is not visible

288

def find_issue

288

def find_issue

289

# Issue.visible.find(...) can not be used to redirect user to the login form

289

# Issue.visible.find(...) can not be used to redirect user to the login form

290

# if the issue actually exists but requires authentication

290

# if the issue actually exists but requires authentication

291

@issue = Issue.find(params[:id])

291

@issue = Issue.find(params[:id])

292

raise Unauthorized unless @issue.visible?

292

raise Unauthorized unless @issue.visible?

293

@project = @issue.project

293

@project = @issue.project

294

rescue ActiveRecord::RecordNotFound

294

rescue ActiveRecord::RecordNotFound

295

render_404

295

render_404

296

end

296

end

297

298

# Find issues with a single :id param or :ids array param

298

# Find issues with a single :id param or :ids array param

299

# Raises a Unauthorized exception if one of the issues is not visible

299

# Raises a Unauthorized exception if one of the issues is not visible

300

def find_issues

300

def find_issues

301

@issues = Issue.find_all_by_id(params[:id] || params[:ids])

301

@issues = Issue.where(:id => (params[:id] || params[:ids])).preload(:project, :status, :tracker, :priority, :author, :assigned_to, :relations_to).to_a

302

raise ActiveRecord::RecordNotFound if @issues.empty?

302

raise ActiveRecord::RecordNotFound if @issues.empty?

303

raise Unauthorized unless @issues.all?(&:visible?)

303

raise Unauthorized unless @issues.all?(&:visible?)

304

@projects = @issues.collect(&:project).compact.uniq

304

@projects = @issues.collect(&:project).compact.uniq

305

@project = @projects.first if @projects.size == 1

305

@project = @projects.first if @projects.size == 1

306

rescue ActiveRecord::RecordNotFound

306

rescue ActiveRecord::RecordNotFound

307

render_404

307

render_404

308

end

308

end

309

310

def find_attachments

310

def find_attachments

311

if (attachments = params[:attachments]).present?

311

if (attachments = params[:attachments]).present?

312

att = attachments.values.collect do |attachment|

312

att = attachments.values.collect do |attachment|

313

Attachment.find_by_token( attachment[:token] ) if attachment[:token].present?

313

Attachment.find_by_token( attachment[:token] ) if attachment[:token].present?

314

end

314

end

315

att.compact!

315

att.compact!

316

end

316

end

317

@attachments = att || []

317

@attachments = att || []

318

end

318

end

319

320

# make sure that the user is a member of the project (or admin) if project is private

320

# make sure that the user is a member of the project (or admin) if project is private

321

# used as a before_filter for actions that do not require any particular permission on the project

321

# used as a before_filter for actions that do not require any particular permission on the project

322

def check_project_privacy

322

def check_project_privacy

323

if @project && !@project.archived?

323

if @project && !@project.archived?

324

if @project.visible?

324

if @project.visible?

325

true

325

true

326

else

326

else

327

deny_access

327

deny_access

328

end

328

end

329

else

329

else

330

@project = nil

330

@project = nil

331

render_404

331

render_404

332

false

332

false

333

end

333

end

334

end

334

end

335

336

def back_url

336

def back_url

337

url = params[:back_url]

337

url = params[:back_url]

338

if url.nil? && referer = request.env['HTTP_REFERER']

338

if url.nil? && referer = request.env['HTTP_REFERER']

339

url = CGI.unescape(referer.to_s)

339

url = CGI.unescape(referer.to_s)

340

end

340

end

341

url

341

url

342

end

342

end

343

344

def redirect_back_or_default(default)

344

def redirect_back_or_default(default)

345

back_url = params[:back_url].to_s

345

back_url = params[:back_url].to_s

346

if back_url.present?

346

if back_url.present?

347

begin

347

begin

348

uri = URI.parse(back_url)

348

uri = URI.parse(back_url)

349

# do not redirect user to another host or to the login or register page

349

# do not redirect user to another host or to the login or register page

350

if (uri.relative? || (uri.host == request.host)) && !uri.path.match(%r{/(login|account/register)})

350

if (uri.relative? || (uri.host == request.host)) && !uri.path.match(%r{/(login|account/register)})

351

redirect_to(back_url)

351

redirect_to(back_url)

352

return

352

return

353

end

353

end

354

rescue URI::InvalidURIError

354

rescue URI::InvalidURIError

355

logger.warn("Could not redirect to invalid URL #{back_url}")

355

logger.warn("Could not redirect to invalid URL #{back_url}")

356

# redirect to default

356

# redirect to default

357

end

357

end

358

end

358

end

359

redirect_to default

359

redirect_to default

360

false

360

false

361

end

361

end

362

363

# Redirects to the request referer if present, redirects to args or call block otherwise.

363

# Redirects to the request referer if present, redirects to args or call block otherwise.

364

def redirect_to_referer_or(*args, &block)

364

def redirect_to_referer_or(*args, &block)

365

redirect_to :back

365

redirect_to :back

366

rescue ::ActionController::RedirectBackError

366

rescue ::ActionController::RedirectBackError

367

if args.any?

367

if args.any?

368

redirect_to *args

368

redirect_to *args

369

elsif block_given?

369

elsif block_given?

370

block.call

370

block.call

371

else

371

else

372

raise "#redirect_to_referer_or takes arguments or a block"

372

raise "#redirect_to_referer_or takes arguments or a block"

373

end

373

end

374

end

374

end

375

376

def render_403(options={})

376

def render_403(options={})

377

@project = nil

377

@project = nil

378

render_error({:message => :notice_not_authorized, :status => 403}.merge(options))

378

render_error({:message => :notice_not_authorized, :status => 403}.merge(options))

379

return false

379

return false

380

end

380

end

381

382

def render_404(options={})

382

def render_404(options={})

383

render_error({:message => :notice_file_not_found, :status => 404}.merge(options))

383

render_error({:message => :notice_file_not_found, :status => 404}.merge(options))

384

return false

384

return false

385

end

385

end

386

387

# Renders an error response

387

# Renders an error response

388

def render_error(arg)

388

def render_error(arg)

389

arg = {:message => arg} unless arg.is_a?(Hash)

389

arg = {:message => arg} unless arg.is_a?(Hash)

390

391

@message = arg[:message]

391

@message = arg[:message]

392

@message = l(@message) if @message.is_a?(Symbol)

392

@message = l(@message) if @message.is_a?(Symbol)

393

@status = arg[:status] || 500

393

@status = arg[:status] || 500

394

395

respond_to do |format|

395

respond_to do |format|

396

format.html {

396

format.html {

397

render :template => 'common/error', :layout => use_layout, :status => @status

397

render :template => 'common/error', :layout => use_layout, :status => @status

398

}

398

}

399

format.any { head @status }

399

format.any { head @status }

400

end

400

end

401

end

401

end

402

403

# Handler for ActionView::MissingTemplate exception

403

# Handler for ActionView::MissingTemplate exception

404

def missing_template

404

def missing_template

405

logger.warn "Missing template, responding with 404"

405

logger.warn "Missing template, responding with 404"

406

@project = nil

406

@project = nil

407

render_404

407

render_404

408

end

408

end

409

410

# Filter for actions that provide an API response

410

# Filter for actions that provide an API response

411

# but have no HTML representation for non admin users

411

# but have no HTML representation for non admin users

412

def require_admin_or_api_request

412

def require_admin_or_api_request

413

return true if api_request?

413

return true if api_request?

414

if User.current.admin?

414

if User.current.admin?

415

true

415

true

416

elsif User.current.logged?

416

elsif User.current.logged?

417

render_error(:status => 406)

417

render_error(:status => 406)

418

else

418

else

419

deny_access

419

deny_access

420

end

420

end

421

end

421

end

422

423

# Picks which layout to use based on the request

423

# Picks which layout to use based on the request

424

#

424

#

425

# @return [boolean, string] name of the layout to use or false for no layout

425

# @return [boolean, string] name of the layout to use or false for no layout

426

def use_layout

426

def use_layout

427

request.xhr? ? false : 'base'

427

request.xhr? ? false : 'base'

428

end

428

end

429

430

def invalid_authenticity_token

430

def invalid_authenticity_token

431

if api_request?

431

if api_request?

432

logger.error "Form authenticity token is missing or is invalid. API calls must include a proper Content-type header (text/xml or text/json)."

432

logger.error "Form authenticity token is missing or is invalid. API calls must include a proper Content-type header (text/xml or text/json)."

433

end

433

end

434

render_error "Invalid form authenticity token."

434

render_error "Invalid form authenticity token."

435

end

435

end

436

437

def render_feed(items, options={})

437

def render_feed(items, options={})

438

@items = items || []

438

@items = items || []

439

@items.sort! {|x,y| y.event_datetime <=> x.event_datetime }

439

@items.sort! {|x,y| y.event_datetime <=> x.event_datetime }

440

@items = @items.slice(0, Setting.feeds_limit.to_i)

440

@items = @items.slice(0, Setting.feeds_limit.to_i)

441

@title = options[:title] || Setting.app_title

441

@title = options[:title] || Setting.app_title

442

render :template => "common/feed", :formats => [:atom], :layout => false,

442

render :template => "common/feed", :formats => [:atom], :layout => false,

443

:content_type => 'application/atom+xml'

443

:content_type => 'application/atom+xml'

444

end

444

end

445

446

def self.accept_rss_auth(*actions)

446

def self.accept_rss_auth(*actions)

447

if actions.any?

447

if actions.any?

448

self.accept_rss_auth_actions = actions

448

self.accept_rss_auth_actions = actions

449

else

449

else

450

self.accept_rss_auth_actions || []

450

self.accept_rss_auth_actions || []

451

end

451

end

452

end

452

end

453

454

def accept_rss_auth?(action=action_name)

454

def accept_rss_auth?(action=action_name)

455

self.class.accept_rss_auth.include?(action.to_sym)

455

self.class.accept_rss_auth.include?(action.to_sym)

456

end

456

end

457

458

def self.accept_api_auth(*actions)

458

def self.accept_api_auth(*actions)

459

if actions.any?

459

if actions.any?

460

self.accept_api_auth_actions = actions

460

self.accept_api_auth_actions = actions

461

else

461

else

462

self.accept_api_auth_actions || []

462

self.accept_api_auth_actions || []

463

end

463

end

464

end

464

end

465

466

def accept_api_auth?(action=action_name)

466

def accept_api_auth?(action=action_name)

467

self.class.accept_api_auth.include?(action.to_sym)

467

self.class.accept_api_auth.include?(action.to_sym)

468

end

468

end

469

470

# Returns the number of objects that should be displayed

470

# Returns the number of objects that should be displayed

471

# on the paginated list

471

# on the paginated list

472

def per_page_option

472

def per_page_option

473

per_page = nil

473

per_page = nil

474

if params[:per_page] && Setting.per_page_options_array.include?(params[:per_page].to_s.to_i)

474

if params[:per_page] && Setting.per_page_options_array.include?(params[:per_page].to_s.to_i)

475

per_page = params[:per_page].to_s.to_i

475

per_page = params[:per_page].to_s.to_i

476

session[:per_page] = per_page

476

session[:per_page] = per_page

477

elsif session[:per_page]

477

elsif session[:per_page]

478

per_page = session[:per_page]

478

per_page = session[:per_page]

479

else

479

else

480

per_page = Setting.per_page_options_array.first || 25

480

per_page = Setting.per_page_options_array.first || 25

481

end

481

end

482

per_page

482

per_page

483

end

483

end

484

485

# Returns offset and limit used to retrieve objects

485

# Returns offset and limit used to retrieve objects

486

# for an API response based on offset, limit and page parameters

486

# for an API response based on offset, limit and page parameters

487

def api_offset_and_limit(options=params)

487

def api_offset_and_limit(options=params)

488

if options[:offset].present?

488

if options[:offset].present?

489

offset = options[:offset].to_i

489

offset = options[:offset].to_i

490

if offset < 0

490

if offset < 0

491

offset = 0

491

offset = 0

492

end

492

end

493

end

493

end

494

limit = options[:limit].to_i

494

limit = options[:limit].to_i

495

if limit < 1

495

if limit < 1

496

limit = 25

496

limit = 25

497

elsif limit > 100

497

elsif limit > 100

498

limit = 100

498

limit = 100

499

end

499

end

500

if offset.nil? && options[:page].present?

500

if offset.nil? && options[:page].present?

501

offset = (options[:page].to_i - 1) * limit

501

offset = (options[:page].to_i - 1) * limit

502

offset = 0 if offset < 0

502

offset = 0 if offset < 0

503

end

503

end

504

offset ||= 0

504

offset ||= 0

505

506

[offset, limit]

506

[offset, limit]

507

end

507

end

508

509

# qvalues http header parser

509

# qvalues http header parser

510

# code taken from webrick

510

# code taken from webrick

511

def parse_qvalues(value)

511

def parse_qvalues(value)

512

tmp = []

512

tmp = []

513

if value

513

if value

514

parts = value.split(/,\s*/)

514

parts = value.split(/,\s*/)

515

parts.each {|part|

515

parts.each {|part|

516

if m = %r{^([^\s,]+?)(?:;\s*q=(\d+(?:\.\d+)?))?$}.match(part)

516

if m = %r{^([^\s,]+?)(?:;\s*q=(\d+(?:\.\d+)?))?$}.match(part)

517

val = m[1]

517

val = m[1]

518

q = (m[2] or 1).to_f

518

q = (m[2] or 1).to_f

519

tmp.push([val, q])

519

tmp.push([val, q])

520

end

520

end

521

}

521

}

522

tmp = tmp.sort_by{|val, q| -q}

522

tmp = tmp.sort_by{|val, q| -q}

523

tmp.collect!{|val, q| val}

523

tmp.collect!{|val, q| val}

524

end

524

end

525

return tmp

525

return tmp

526

rescue

526

rescue

527

nil

527

nil

528

end

528

end

529

530

# Returns a string that can be used as filename value in Content-Disposition header

530

# Returns a string that can be used as filename value in Content-Disposition header

531

def filename_for_content_disposition(name)

531

def filename_for_content_disposition(name)

532

request.env['HTTP_USER_AGENT'] =~ %r{MSIE} ? ERB::Util.url_encode(name) : name

532

request.env['HTTP_USER_AGENT'] =~ %r{MSIE} ? ERB::Util.url_encode(name) : name

533

end

533

end

534

535

def api_request?

535

def api_request?

536

%w(xml json).include? params[:format]

536

%w(xml json).include? params[:format]

537

end

537

end

538

539

# Returns the API key present in the request

539

# Returns the API key present in the request

540

def api_key_from_request

540

def api_key_from_request

541

if params[:key].present?

541

if params[:key].present?

542

params[:key].to_s

542

params[:key].to_s

543

elsif request.headers["X-Redmine-API-Key"].present?

543

elsif request.headers["X-Redmine-API-Key"].present?

544

request.headers["X-Redmine-API-Key"].to_s

544

request.headers["X-Redmine-API-Key"].to_s

545

end

545

end

546

end

546

end

547

548

# Returns the API 'switch user' value if present

548

# Returns the API 'switch user' value if present

549

def api_switch_user_from_request

549

def api_switch_user_from_request

550

request.headers["X-Redmine-Switch-User"].to_s.presence

550

request.headers["X-Redmine-Switch-User"].to_s.presence

551

end

551

end

552

553

# Renders a warning flash if obj has unsaved attachments

553

# Renders a warning flash if obj has unsaved attachments

554

def render_attachment_warning_if_needed(obj)

554

def render_attachment_warning_if_needed(obj)

555

flash[:warning] = l(:warning_attachments_not_saved, obj.unsaved_attachments.size) if obj.unsaved_attachments.present?

555

flash[:warning] = l(:warning_attachments_not_saved, obj.unsaved_attachments.size) if obj.unsaved_attachments.present?

556

end

556

end

557

558

# Rescues an invalid query statement. Just in case...

558

# Rescues an invalid query statement. Just in case...

559

def query_statement_invalid(exception)

559

def query_statement_invalid(exception)

560

logger.error "Query::StatementInvalid: #{exception.message}" if logger

560

logger.error "Query::StatementInvalid: #{exception.message}" if logger

561

session.delete(:query)

561

session.delete(:query)

562

sort_clear if respond_to?(:sort_clear)

562

sort_clear if respond_to?(:sort_clear)

563

render_error "An error occurred while executing the query and has been logged. Please report this error to your Redmine administrator."

563

render_error "An error occurred while executing the query and has been logged. Please report this error to your Redmine administrator."

564

end

564

end

565

566

# Renders a 200 response for successfull updates or deletions via the API

566

# Renders a 200 response for successfull updates or deletions via the API

567

def render_api_ok

567

def render_api_ok

568

render_api_head :ok

568

render_api_head :ok

569

end

569

end

570

571

# Renders a head API response

571

# Renders a head API response

572

def render_api_head(status)

572

def render_api_head(status)

573

# #head would return a response body with one space

573

# #head would return a response body with one space

574

render :text => '', :status => status, :layout => nil

574

render :text => '', :status => status, :layout => nil

575

end

575

end

576

577

# Renders API response on validation failure

577

# Renders API response on validation failure

578

def render_validation_errors(objects)

578

def render_validation_errors(objects)

579

if objects.is_a?(Array)

579

if objects.is_a?(Array)

580

@error_messages = objects.map {|object| object.errors.full_messages}.flatten

580

@error_messages = objects.map {|object| object.errors.full_messages}.flatten

581

else

581

else

582

@error_messages = objects.errors.full_messages

582

@error_messages = objects.errors.full_messages

583

end

583

end

584

render :template => 'common/error_messages.api', :status => :unprocessable_entity, :layout => nil

584

render :template => 'common/error_messages.api', :status => :unprocessable_entity, :layout => nil

585

end

585

end

586

587

# Overrides #_include_layout? so that #render with no arguments

587

# Overrides #_include_layout? so that #render with no arguments

588

# doesn't use the layout for api requests

588

# doesn't use the layout for api requests

589

def _include_layout?(*args)

589

def _include_layout?(*args)

590

api_request? ? false : super

590

api_request? ? false : super

591

end

591

end

592

end

592

end

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

             # Redmine - project management software
             # Copyright (C) 2006-2013  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 'uri'
             require 'cgi'
             class Unauthorized < Exception; end
             class ApplicationController < ActionController::Base
               include Redmine::I18n
               include Redmine::Pagination
               include RoutesHelper
               helper :routes
               class_attribute :accept_api_auth_actions
               class_attribute :accept_rss_auth_actions
               class_attribute :model_object
               layout 'base'
               protect_from_forgery
               def handle_unverified_request
                 super
                 cookies.delete(autologin_cookie_name)
               end
               before_filter :session_expiration, :user_setup, :check_if_login_required, :set_localization
               rescue_from ActionController::InvalidAuthenticityToken, :with => :invalid_authenticity_token
               rescue_from ::Unauthorized, :with => :deny_access
               rescue_from ::ActionView::MissingTemplate, :with => :missing_template
               include Redmine::Search::Controller
               include Redmine::MenuManager::MenuController
               helper Redmine::MenuManager::MenuHelper
               def session_expiration
                 if session[:user_id]
                   if session_expired? && !try_to_autologin
                     reset_session
                     flash[:error] = l(:error_session_expired)
                     redirect_to signin_url
                   else
                     session[:atime] = Time.now.utc.to_i
                   end
                 end
               end
               def session_expired?
                 if Setting.session_lifetime?
                   unless session[:ctime] && (Time.now.utc.to_i - session[:ctime].to_i <= Setting.session_lifetime.to_i * 60)
                     return true
                   end
                 end
                 if Setting.session_timeout?
                   unless session[:atime] && (Time.now.utc.to_i - session[:atime].to_i <= Setting.session_timeout.to_i * 60)
                     return true
                   end
                 end
                 false
               end
               def start_user_session(user)
                 session[:user_id] = user.id
                 session[:ctime] = Time.now.utc.to_i
                 session[:atime] = Time.now.utc.to_i
               end
               def user_setup
                 # Check the settings cache for each request
                 Setting.check_cache
                 # Find the current user
                 User.current = find_current_user
                 logger.info("  Current user: " + (User.current.logged? ? "#{User.current.login} (id=#{User.current.id})" : "anonymous")) if logger
               end
               # Returns the current user or nil if no user is logged in
               # and starts a session if needed
               def find_current_user
                 user = nil
                 unless api_request?
                   if session[:user_id]
                     # existing session
                     user = (User.active.find(session[:user_id]) rescue nil)
                   elsif autologin_user = try_to_autologin
                     user = autologin_user
                   elsif params[:format] == 'atom' && params[:key] && request.get? && accept_rss_auth?
                     # RSS key authentication does not start a session
                     user = User.find_by_rss_key(params[:key])
                   end
                 end
                 if user.nil? && Setting.rest_api_enabled? && accept_api_auth?
                   if (key = api_key_from_request)
                     # Use API key
                     user = User.find_by_api_key(key)
                   else
                     # HTTP Basic, either username/password or API key/random
                     authenticate_with_http_basic do |username, password|
                       user = User.try_to_login(username, password) || User.find_by_api_key(username)
                     end
                   end
                   # Switch user if requested by an admin user
                   if user && user.admin? && (username = api_switch_user_from_request)
                     su = User.find_by_login(username)
                     if su && su.active?
                       logger.info("  User switched by: #{user.login} (id=#{user.id})") if logger
                       user = su
                     else
                       render_error :message => 'Invalid X-Redmine-Switch-User header', :status => 412
                     end
                   end
                 end
                 user
               end
               def autologin_cookie_name
                 Redmine::Configuration['autologin_cookie_name'].presence || 'autologin'
               end
               def try_to_autologin
                 if cookies[autologin_cookie_name] && Setting.autologin?
                   # auto-login feature starts a new session
                   user = User.try_to_autologin(cookies[autologin_cookie_name])
                   if user
                     reset_session
                     start_user_session(user)
                   end
                   user
                 end
               end
               # Sets the logged in user
               def logged_user=(user)
                 reset_session
                 if user && user.is_a?(User)
                   User.current = user
                   start_user_session(user)
                 else
                   User.current = User.anonymous
                 end
               end
               # Logs out current user
               def logout_user
                 if User.current.logged?
                   cookies.delete(autologin_cookie_name)
                   Token.delete_all(["user_id = ? AND action = ?", User.current.id, 'autologin'])
                   self.logged_user = nil
                 end
               end
               # check if login is globally required to access the application
               def check_if_login_required
                 # no check needed if user is already logged in
                 return true if User.current.logged?
                 require_login if Setting.login_required?
               end
               def set_localization
                 lang = nil
                 if User.current.logged?
                   lang = find_language(User.current.language)
                 end
                 if lang.nil? && request.env['HTTP_ACCEPT_LANGUAGE']
                   accept_lang = parse_qvalues(request.env['HTTP_ACCEPT_LANGUAGE']).first
                   if !accept_lang.blank?
                     accept_lang = accept_lang.downcase
                     lang = find_language(accept_lang) || find_language(accept_lang.split('-').first)
                   end
                 end
                 lang ||= Setting.default_language
                 set_language_if_valid(lang)
               end
               def require_login
                 if !User.current.logged?
                   # Extract only the basic url parameters on non-GET requests
                   if request.get?
                     url = url_for(params)
                   else
                     url = url_for(:controller => params[:controller], :action => params[:action], :id => params[:id], :project_id => params[:project_id])
                   end
                   respond_to do |format|
                     format.html { redirect_to :controller => "account", :action => "login", :back_url => url }
                     format.atom { redirect_to :controller => "account", :action => "login", :back_url => url }
                     format.xml  { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' }
                     format.js   { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' }
                     format.json { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' }
                   end
                   return false
                 end
                 true
               end
               def require_admin
                 return unless require_login
                 if !User.current.admin?
                   render_403
                   return false
                 end
                 true
               end
               def deny_access
                 User.current.logged? ? render_403 : require_login
               end
               # Authorize the user for the requested action
               def authorize(ctrl = params[:controller], action = params[:action], global = false)
                 allowed = User.current.allowed_to?({:controller => ctrl, :action => action}, @project || @projects, :global => global)
                 if allowed
                   true
                 else
                   if @project && @project.archived?
                     render_403 :message => :notice_not_authorized_archived_project
                   else
                     deny_access
                   end
                 end
               end
               # Authorize the user for the requested action outside a project
               def authorize_global(ctrl = params[:controller], action = params[:action], global = true)
                 authorize(ctrl, action, global)
               end
               # Find project of id params[:id]
               def find_project
                 @project = Project.find(params[:id])
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               # Find project of id params[:project_id]
               def find_project_by_project_id
                 @project = Project.find(params[:project_id])
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               # Find a project based on params[:project_id]
               # TODO: some subclasses override this, see about merging their logic
               def find_optional_project
                 @project = Project.find(params[:project_id]) unless params[:project_id].blank?
                 allowed = User.current.allowed_to?({:controller => params[:controller], :action => params[:action]}, @project, :global => true)
                 allowed ? true : deny_access
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               # Finds and sets @project based on @object.project
               def find_project_from_association
                 render_404 unless @object.present?
                 @project = @object.project
               end
               def find_model_object
                 model = self.class.model_object
                 if model
                   @object = model.find(params[:id])
                   self.instance_variable_set('@' + controller_name.singularize, @object) if @object
                 end
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               def self.model_object(model)
                 self.model_object = model
               end
               # Find the issue whose id is the :id parameter
               # Raises a Unauthorized exception if the issue is not visible
               def find_issue
                 # Issue.visible.find(...) can not be used to redirect user to the login form
                 # if the issue actually exists but requires authentication
                 @issue = Issue.find(params[:id])
                 raise Unauthorized unless @issue.visible?
                 @project = @issue.project
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               # Find issues with a single :id param or :ids array param
               # Raises a Unauthorized exception if one of the issues is not visible
               def find_issues
-                @issues = Issue.find_all_by_id(params[:id] || params[:ids])
+                @issues = Issue.where(:id => (params[:id] || params[:ids])).preload(:project, :status, :tracker, :priority, :author, :assigned_to, :relations_to).to_a
                 raise ActiveRecord::RecordNotFound if @issues.empty?
                 raise Unauthorized unless @issues.all?(&:visible?)
                 @projects = @issues.collect(&:project).compact.uniq
                 @project = @projects.first if @projects.size == 1
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               def find_attachments
                 if (attachments = params[:attachments]).present?
                   att = attachments.values.collect do |attachment|
                     Attachment.find_by_token( attachment[:token] ) if attachment[:token].present?
                   end
                   att.compact!
                 end
                 @attachments = att || []
               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
                 if @project && !@project.archived?
                   if @project.visible?
                     true
                   else
                     deny_access
                   end
                 else
                   @project = nil
                   render_404
                   false
                 end
               end
               def back_url
                 url = params[:back_url]
                 if url.nil? && referer = request.env['HTTP_REFERER']
                   url = CGI.unescape(referer.to_s)
                 end
                 url
               end
               def redirect_back_or_default(default)
                 back_url = params[:back_url].to_s
                 if back_url.present?
                   begin
                     uri = URI.parse(back_url)
                     # do not redirect user to another host or to the login or register page
                     if (uri.relative? || (uri.host == request.host)) && !uri.path.match(%r{/(login|account/register)})
                       redirect_to(back_url)
                       return
                     end
                   rescue URI::InvalidURIError
                     logger.warn("Could not redirect to invalid URL #{back_url}")
                     # redirect to default
                   end
                 end
                 redirect_to default
                 false
               end
               # Redirects to the request referer if present, redirects to args or call block otherwise.
               def redirect_to_referer_or(*args, &block)
                 redirect_to :back
               rescue ::ActionController::RedirectBackError
                 if args.any?
                   redirect_to *args
                 elsif block_given?
                   block.call
                 else
                   raise "#redirect_to_referer_or takes arguments or a block"
                 end
               end
               def render_403(options={})
                 @project = nil
                 render_error({:message => :notice_not_authorized, :status => 403}.merge(options))
                 return false
               end
               def render_404(options={})
                 render_error({:message => :notice_file_not_found, :status => 404}.merge(options))
                 return false
               end
               # Renders an error response
               def render_error(arg)
                 arg = {:message => arg} unless arg.is_a?(Hash)
                 @message = arg[:message]
                 @message = l(@message) if @message.is_a?(Symbol)
                 @status = arg[:status] || 500
                 respond_to do |format|
                   format.html {
                     render :template => 'common/error', :layout => use_layout, :status => @status
                   }
                   format.any { head @status }
                 end
               end
               # Handler for ActionView::MissingTemplate exception
               def missing_template
                 logger.warn "Missing template, responding with 404"
                 @project = nil
                 render_404
               end
               # Filter for actions that provide an API response
               # but have no HTML representation for non admin users
               def require_admin_or_api_request
                 return true if api_request?
                 if User.current.admin?
                   true
                 elsif User.current.logged?
                   render_error(:status => 406)
                 else
                   deny_access
                 end
               end
               # Picks which layout to use based on the request
               #
               # @return [boolean, string] name of the layout to use or false for no layout
               def use_layout
                 request.xhr? ? false : 'base'
               end
               def invalid_authenticity_token
                 if api_request?
                   logger.error "Form authenticity token is missing or is invalid. API calls must include a proper Content-type header (text/xml or text/json)."
                 end
                 render_error "Invalid form authenticity token."
               end
               def render_feed(items, options={})
                 @items = items || []
                 @items.sort! {|x,y| y.event_datetime <=> x.event_datetime }
                 @items = @items.slice(0, Setting.feeds_limit.to_i)
                 @title = options[:title] || Setting.app_title
                 render :template => "common/feed", :formats => [:atom], :layout => false,
                        :content_type => 'application/atom+xml'
               end
               def self.accept_rss_auth(*actions)
                 if actions.any?
                   self.accept_rss_auth_actions = actions
                 else
                   self.accept_rss_auth_actions || []
                 end
               end
               def accept_rss_auth?(action=action_name)
                 self.class.accept_rss_auth.include?(action.to_sym)
               end
               def self.accept_api_auth(*actions)
                 if actions.any?
                   self.accept_api_auth_actions = actions
                 else
                   self.accept_api_auth_actions || []
                 end
               end
               def accept_api_auth?(action=action_name)
                 self.class.accept_api_auth.include?(action.to_sym)
               end
               # Returns the number of objects that should be displayed
               # on the paginated list
               def per_page_option
                 per_page = nil
                 if params[:per_page] && Setting.per_page_options_array.include?(params[:per_page].to_s.to_i)
                   per_page = params[:per_page].to_s.to_i
                   session[:per_page] = per_page
                 elsif session[:per_page]
                   per_page = session[:per_page]
                 else
                   per_page = Setting.per_page_options_array.first || 25
                 end
                 per_page
               end
               # Returns offset and limit used to retrieve objects
               # for an API response based on offset, limit and page parameters
               def api_offset_and_limit(options=params)
                 if options[:offset].present?
                   offset = options[:offset].to_i
                   if offset < 0
                     offset = 0
                   end
                 end
                 limit = options[:limit].to_i
                 if limit < 1
                   limit = 25
                 elsif limit > 100
                   limit = 100
                 end
                 if offset.nil? && options[:page].present?
                   offset = (options[:page].to_i - 1) * limit
                   offset = 0 if offset < 0
                 end
                 offset ||= 0
                 [offset, limit]
               end
               # qvalues http header parser
               # code taken from webrick
               def parse_qvalues(value)
                 tmp = []
                 if value
                   parts = value.split(/,\s*/)
                   parts.each {|part|
                     if m = %r{^([^\s,]+?)(?:;\s*q=(\d+(?:\.\d+)?))?$}.match(part)
                       val = m[1]
                       q = (m[2] or 1).to_f
                       tmp.push([val, q])
                     end
                   }
                   tmp = tmp.sort_by{|val, q| -q}
                   tmp.collect!{|val, q| val}
                 end
                 return tmp
               rescue
                 nil
               end
               # Returns a string that can be used as filename value in Content-Disposition header
               def filename_for_content_disposition(name)
                 request.env['HTTP_USER_AGENT'] =~ %r{MSIE} ? ERB::Util.url_encode(name) : name
               end
               def api_request?
                 %w(xml json).include? params[:format]
               end
               # Returns the API key present in the request
               def api_key_from_request
                 if params[:key].present?
                   params[:key].to_s
                 elsif request.headers["X-Redmine-API-Key"].present?
                   request.headers["X-Redmine-API-Key"].to_s
                 end
               end
               # Returns the API 'switch user' value if present
               def api_switch_user_from_request
                 request.headers["X-Redmine-Switch-User"].to_s.presence
               end
               # Renders a warning flash if obj has unsaved attachments
               def render_attachment_warning_if_needed(obj)
                 flash[:warning] = l(:warning_attachments_not_saved, obj.unsaved_attachments.size) if obj.unsaved_attachments.present?
               end
               # Rescues an invalid query statement. Just in case...
               def query_statement_invalid(exception)
                 logger.error "Query::StatementInvalid: #{exception.message}" if logger
                 session.delete(:query)
                 sort_clear if respond_to?(:sort_clear)
                 render_error "An error occurred while executing the query and has been logged. Please report this error to your Redmine administrator."
               end
               # Renders a 200 response for successfull updates or deletions via the API
               def render_api_ok
                 render_api_head :ok
               end
               # Renders a head API response
               def render_api_head(status)
                 # #head would return a response body with one space
                 render :text => '', :status => status, :layout => nil
               end
               # Renders API response on validation failure
               def render_validation_errors(objects)
                 if objects.is_a?(Array)
                   @error_messages = objects.map {|object| object.errors.full_messages}.flatten
                 else
                   @error_messages = objects.errors.full_messages
                 end
                 render :template => 'common/error_messages.api', :status => :unprocessable_entity, :layout => nil
               end
               # Overrides #_include_layout? so that #render with no arguments
               # doesn't use the layout for api requests
               def _include_layout?(*args)
                 api_request? ? false : super
               end
             end