jro_apps/redmine Commit - r9259:ef2c5cab2d44

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

26

layout 'base'

26

layout 'base'

27

exempt_from_layout 'builder', 'rsb'

27

exempt_from_layout 'builder', 'rsb'

28

29

protect_from_forgery

29

protect_from_forgery

30

def handle_unverified_request

30

def handle_unverified_request

31

super

31

super

32

cookies.delete(:autologin)

32

cookies.delete(:autologin)

33

end

33

end

34

# Remove broken cookie after upgrade from 0.8.x (#4292)

34

# Remove broken cookie after upgrade from 0.8.x (#4292)

35

# See https://rails.lighthouseapp.com/projects/8994/tickets/3360

35

# See https://rails.lighthouseapp.com/projects/8994/tickets/3360

36

# TODO: remove it when Rails is fixed

36

# TODO: remove it when Rails is fixed

37

before_filter :delete_broken_cookies

37

before_filter :delete_broken_cookies

38

def delete_broken_cookies

38

def delete_broken_cookies

39

if cookies['_redmine_session'] && cookies['_redmine_session'] !~ /--/

39

if cookies['_redmine_session'] && cookies['_redmine_session'] !~ /--/

40

cookies.delete '_redmine_session'

40

cookies.delete '_redmine_session'

41

redirect_to home_path

41

redirect_to home_path

42

return false

42

return false

43

end

43

end

44

end

44

end

45

46

# FIXME: Remove this when all of Rack and Rails have learned how to

46

# FIXME: Remove this when all of Rack and Rails have learned how to

47

# properly use encodings

47

# properly use encodings

48

before_filter :params_filter

48

before_filter :params_filter

49

50

def params_filter

50

def params_filter

51

if RUBY_VERSION >= '1.9' && defined?(Rails) && Rails::VERSION::MAJOR < 3

51

if RUBY_VERSION >= '1.9' && defined?(Rails) && Rails::VERSION::MAJOR < 3

52

self.utf8nize!(params)

52

self.utf8nize!(params)

53

end

53

end

54

end

54

end

55

56

def utf8nize!(obj)

56

def utf8nize!(obj)

57

if obj.frozen?

57

if obj.frozen?

58

obj

58

obj

59

elsif obj.is_a? String

59

elsif obj.is_a? String

60

obj.respond_to?(:force_encoding) ? obj.force_encoding("UTF-8") : obj

60

obj.respond_to?(:force_encoding) ? obj.force_encoding("UTF-8") : obj

61

elsif obj.is_a? Hash

61

elsif obj.is_a? Hash

62

obj.each {|k, v| obj[k] = self.utf8nize!(v)}

62

obj.each {|k, v| obj[k] = self.utf8nize!(v)}

63

elsif obj.is_a? Array

63

elsif obj.is_a? Array

64

obj.each {|v| self.utf8nize!(v)}

64

obj.each {|v| self.utf8nize!(v)}

65

else

65

else

66

obj

66

obj

67

end

67

end

68

end

68

end

69

70

before_filter :user_setup, :check_if_login_required, :set_localization

70

before_filter :user_setup, :check_if_login_required, :set_localization

71

filter_parameter_logging :password

71

filter_parameter_logging :password

72

73

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

73

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

74

rescue_from ::Unauthorized, :with => :deny_access

74

rescue_from ::Unauthorized, :with => :deny_access

75

76

include Redmine::Search::Controller

76

include Redmine::Search::Controller

77

include Redmine::MenuManager::MenuController

77

include Redmine::MenuManager::MenuController

78

helper Redmine::MenuManager::MenuHelper

78

helper Redmine::MenuManager::MenuHelper

79

80

Redmine::Scm::Base.all.each do |scm|

80

Redmine::Scm::Base.all.each do |scm|

81

require_dependency "repository/#{scm.underscore}"

81

require_dependency "repository/#{scm.underscore}"

82

end

82

end

83

84

def user_setup

84

def user_setup

85

# Check the settings cache for each request

85

# Check the settings cache for each request

86

Setting.check_cache

86

Setting.check_cache

87

# Find the current user

87

# Find the current user

88

User.current = find_current_user

88

User.current = find_current_user

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

if session[:user_id]

94

if session[:user_id]

95

# existing session

95

# existing session

96

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

96

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

97

elsif cookies[:autologin] && Setting.autologin?

97

elsif cookies[:autologin] && Setting.autologin?

98

# auto-login feature starts a new session

98

# auto-login feature starts a new session

99

user = User.try_to_autologin(cookies[:autologin])

99

user = User.try_to_autologin(cookies[:autologin])

100

session[:user_id] = user.id if user

100

session[:user_id] = user.id if user

101

user

101

user

102

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

102

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

103

# RSS key authentication does not start a session

103

# RSS key authentication does not start a session

104

User.find_by_rss_key(params[:key])

104

User.find_by_rss_key(params[:key])

105

elsif Setting.rest_api_enabled? && accept_api_auth?

105

elsif Setting.rest_api_enabled? && accept_api_auth?

106

if (key = api_key_from_request)

106

if (key = api_key_from_request)

107

# Use API key

107

# Use API key

108

User.find_by_api_key(key)

108

User.find_by_api_key(key)

109

else

109

else

110

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

110

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

111

authenticate_with_http_basic do |username, password|

111

authenticate_with_http_basic do |username, password|

112

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

112

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

113

end

113

end

114

end

114

end

115

end

115

end

116

end

116

end

117

118

# Sets the logged in user

118

# Sets the logged in user

119

def logged_user=(user)

119

def logged_user=(user)

120

reset_session

120

reset_session

121

if user && user.is_a?(User)

121

if user && user.is_a?(User)

122

User.current = user

122

User.current = user

123

session[:user_id] = user.id

123

session[:user_id] = user.id

124

else

124

else

125

User.current = User.anonymous

125

User.current = User.anonymous

126

end

126

end

127

end

127

end

128

129

# check if login is globally required to access the application

129

# check if login is globally required to access the application

130

def check_if_login_required

130

def check_if_login_required

131

# no check needed if user is already logged in

131

# no check needed if user is already logged in

132

return true if User.current.logged?

132

return true if User.current.logged?

133

require_login if Setting.login_required?

133

require_login if Setting.login_required?

134

end

134

end

135

136

def set_localization

136

def set_localization

137

lang = nil

137

lang = nil

138

if User.current.logged?

138

if User.current.logged?

139

lang = find_language(User.current.language)

139

lang = find_language(User.current.language)

140

end

140

end

141

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

141

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

142

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

142

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

143

if !accept_lang.blank?

143

if !accept_lang.blank?

144

accept_lang = accept_lang.downcase

144

accept_lang = accept_lang.downcase

145

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

145

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

146

end

146

end

147

end

147

end

148

lang ||= Setting.default_language

148

lang ||= Setting.default_language

149

set_language_if_valid(lang)

149

set_language_if_valid(lang)

150

end

150

end

151

152

def require_login

152

def require_login

153

if !User.current.logged?

153

if !User.current.logged?

154

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

154

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

155

if request.get?

155

if request.get?

156

url = url_for(params)

156

url = url_for(params)

157

else

157

else

158

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

158

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

159

end

159

end

160

respond_to do |format|

160

respond_to do |format|

161

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

161

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

162

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

162

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

163

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

163

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

164

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

164

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

165

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

165

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

166

end

166

end

167

return false

167

return false

168

end

168

end

169

true

169

true

170

end

170

end

171

172

def require_admin

172

def require_admin

173

return unless require_login

173

return unless require_login

174

if !User.current.admin?

174

if !User.current.admin?

175

render_403

175

render_403

176

return false

176

return false

177

end

177

end

178

true

178

true

179

end

179

end

180

181

def deny_access

181

def deny_access

182

User.current.logged? ? render_403 : require_login

182

User.current.logged? ? render_403 : require_login

183

end

183

end

184

185

# Authorize the user for the requested action

185

# Authorize the user for the requested action

186

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

186

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

187

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

187

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

188

if allowed

188

if allowed

189

true

189

true

190

else

190

else

191

if @project && @project.archived?

191

if @project && @project.archived?

192

render_403 :message => :notice_not_authorized_archived_project

192

render_403 :message => :notice_not_authorized_archived_project

193

else

193

else

194

deny_access

194

deny_access

195

end

195

end

196

end

196

end

197

end

197

end

198

199

# Authorize the user for the requested action outside a project

199

# Authorize the user for the requested action outside a project

200

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

200

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

201

authorize(ctrl, action, global)

201

authorize(ctrl, action, global)

202

end

202

end

203

204

# Find project of id params[:id]

204

# Find project of id params[:id]

205

def find_project

205

def find_project

206

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

206

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

207

rescue ActiveRecord::RecordNotFound

207

rescue ActiveRecord::RecordNotFound

208

render_404

208

render_404

209

end

209

end

210

211

# Find project of id params[:project_id]

211

# Find project of id params[:project_id]

212

def find_project_by_project_id

212

def find_project_by_project_id

213

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

213

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

214

rescue ActiveRecord::RecordNotFound

214

rescue ActiveRecord::RecordNotFound

215

render_404

215

render_404

216

end

216

end

217

218

# Find a project based on params[:project_id]

218

# Find a project based on params[:project_id]

219

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

219

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

220

def find_optional_project

220

def find_optional_project

221

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

221

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

222

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

222

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

223

allowed ? true : deny_access

223

allowed ? true : deny_access

224

rescue ActiveRecord::RecordNotFound

224

rescue ActiveRecord::RecordNotFound

225

render_404

225

render_404

226

end

226

end

227

228

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

228

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

229

def find_project_from_association

229

def find_project_from_association

230

render_404 unless @object.present?

230

render_404 unless @object.present?

231

232

@project = @object.project

232

@project = @object.project

233

end

233

end

234

235

def find_model_object

235

def find_model_object

236

model = self.class.read_inheritable_attribute('model_object')

236

model = self.class.read_inheritable_attribute('model_object')

237

if model

237

if model

238

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

238

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

239

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

239

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

240

end

240

end

241

rescue ActiveRecord::RecordNotFound

241

rescue ActiveRecord::RecordNotFound

242

render_404

242

render_404

243

end

243

end

244

245

def self.model_object(model)

245

def self.model_object(model)

246

write_inheritable_attribute('model_object', model)

246

write_inheritable_attribute('model_object', model)

247

end

247

end

248

249

# Filter for bulk issue operations

249

# Filter for bulk issue operations

250

def find_issues

250

def find_issues

251

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

251

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

252

raise ActiveRecord::RecordNotFound if @issues.empty?

252

raise ActiveRecord::RecordNotFound if @issues.empty?

253

if @issues.detect {|issue| !issue.visible?}

253

if @issues.detect {|issue| !issue.visible?}

254

deny_access

254

deny_access

255

return

255

return

256

end

256

end

257

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

257

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

258

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

258

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

259

rescue ActiveRecord::RecordNotFound

259

rescue ActiveRecord::RecordNotFound

260

render_404

260

render_404

261

end

261

end

262

263

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

263

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

264

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

264

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

265

def check_project_privacy

265

def check_project_privacy

266

if @project && @project.active?

266

if @project && @project.active?

267

if @project.visible?

267

if @project.visible?

268

true

268

true

269

else

269

else

270

deny_access

270

deny_access

271

end

271

end

272

else

272

else

273

@project = nil

273

@project = nil

274

render_404

274

render_404

275

false

275

false

276

end

276

end

277

end

277

end

278

279

def back_url

279

def back_url

280

params[:back_url] || request.env['HTTP_REFERER']

280

params[:back_url] || request.env['HTTP_REFERER']

281

end

281

end

282

283

def redirect_back_or_default(default)

283

def redirect_back_or_default(default)

284

back_url = CGI.unescape(params[:back_url].to_s)

284

back_url = CGI.unescape(params[:back_url].to_s)

285

if !back_url.blank?

285

if !back_url.blank?

286

begin

286

begin

287

uri = URI.parse(back_url)

287

uri = URI.parse(back_url)

288

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

288

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

289

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

289

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

290

redirect_to(back_url)

290

redirect_to(back_url)

291

return

291

return

292

end

292

end

293

rescue URI::InvalidURIError

293

rescue URI::InvalidURIError

294

# redirect to default

294

# redirect to default

295

end

295

end

296

end

296

end

297

redirect_to default

297

redirect_to default

298

false

298

false

299

end

299

end

300

301

def render_403(options={})

301

def render_403(options={})

302

@project = nil

302

@project = nil

303

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

303

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

304

return false

304

return false

305

end

305

end

306

307

def render_404(options={})

307

def render_404(options={})

308

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

308

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

309

return false

309

return false

310

end

310

end

311

312

# Renders an error response

312

# Renders an error response

313

def render_error(arg)

313

def render_error(arg)

314

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

314

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

315

316

@message = arg[:message]

316

@message = arg[:message]

317

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

317

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

318

@status = arg[:status] || 500

318

@status = arg[:status] || 500

319

320

respond_to do |format|

320

respond_to do |format|

321

format.html {

321

format.html {

322

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

322

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

323

}

323

}

324

format.atom { head @status }

324

format.atom { head @status }

325

format.xml { head @status }

325

format.xml { head @status }

326

format.js { head @status }

326

format.js { head @status }

327

format.json { head @status }

327

format.json { head @status }

328

end

328

end

329

end

329

end

330

331

# Filter for actions that provide an API response

331

# Filter for actions that provide an API response

332

# but have no HTML representation for non admin users

332

# but have no HTML representation for non admin users

333

def require_admin_or_api_request

333

def require_admin_or_api_request

334

return true if api_request?

334

return true if api_request?

335

if User.current.admin?

335

if User.current.admin?

336

true

336

true

337

elsif User.current.logged?

337

elsif User.current.logged?

338

render_error(:status => 406)

338

render_error(:status => 406)

339

else

339

else

340

deny_access

340

deny_access

341

end

341

end

342

end

342

end

343

344

# Picks which layout to use based on the request

344

# Picks which layout to use based on the request

345

#

345

#

346

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

346

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

347

def use_layout

347

def use_layout

348

request.xhr? ? false : 'base'

348

request.xhr? ? false : 'base'

349

end

349

end

350

351

def invalid_authenticity_token

351

def invalid_authenticity_token

352

if api_request?

352

if api_request?

353

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

353

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

354

end

354

end

355

render_error "Invalid form authenticity token."

355

render_error "Invalid form authenticity token."

356

end

356

end

357

358

def render_feed(items, options={})

358

def render_feed(items, options={})

359

@items = items || []

359

@items = items || []

360

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

360

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

361

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

361

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

362

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

362

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

363

render :template => "common/feed.atom", :layout => false,

363

render :template => "common/feed.atom", :layout => false,

364

:content_type => 'application/atom+xml'

364

:content_type => 'application/atom+xml'

365

end

365

end

366

367

# TODO: remove in Redmine 1.4

368

def self.accept_key_auth(*actions)

369

ActiveSupport::Deprecation.warn "ApplicationController.accept_key_auth is deprecated and will be removed in Redmine 1.4. Use accept_rss_auth (or accept_api_auth) instead."

370

accept_rss_auth(*actions)

371

end

372

373

# TODO: remove in Redmine 1.4

374

def accept_key_auth_actions

375

ActiveSupport::Deprecation.warn "ApplicationController.accept_key_auth_actions is deprecated and will be removed in Redmine 1.4. Use accept_rss_auth (or accept_api_auth) instead."

376

self.class.accept_rss_auth

377

end

378

379

def self.accept_rss_auth(*actions)

367

def self.accept_rss_auth(*actions)

380

if actions.any?

368

if actions.any?

381

write_inheritable_attribute('accept_rss_auth_actions', actions)

369

write_inheritable_attribute('accept_rss_auth_actions', actions)

382

else

370

else

383

read_inheritable_attribute('accept_rss_auth_actions') || []

371

read_inheritable_attribute('accept_rss_auth_actions') || []

384

end

372

end

385

end

373

end

386

374

387

def accept_rss_auth?(action=action_name)

375

def accept_rss_auth?(action=action_name)

388

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

376

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

389

end

377

end

390

378

391

def self.accept_api_auth(*actions)

379

def self.accept_api_auth(*actions)

392

if actions.any?

380

if actions.any?

393

write_inheritable_attribute('accept_api_auth_actions', actions)

381

write_inheritable_attribute('accept_api_auth_actions', actions)

394

else

382

else

395

read_inheritable_attribute('accept_api_auth_actions') || []

383

read_inheritable_attribute('accept_api_auth_actions') || []

396

end

384

end

397

end

385

end

398

386

399

def accept_api_auth?(action=action_name)

387

def accept_api_auth?(action=action_name)

400

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

388

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

401

end

389

end

402

390

403

# Returns the number of objects that should be displayed

391

# Returns the number of objects that should be displayed

404

# on the paginated list

392

# on the paginated list

405

def per_page_option

393

def per_page_option

406

per_page = nil

394

per_page = nil

407

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

395

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

408

per_page = params[:per_page].to_s.to_i

396

per_page = params[:per_page].to_s.to_i

409

session[:per_page] = per_page

397

session[:per_page] = per_page

410

elsif session[:per_page]

398

elsif session[:per_page]

411

per_page = session[:per_page]

399

per_page = session[:per_page]

412

else

400

else

413

per_page = Setting.per_page_options_array.first || 25

401

per_page = Setting.per_page_options_array.first || 25

414

end

402

end

415

per_page

403

per_page

416

end

404

end

417

405

418

# Returns offset and limit used to retrieve objects

406

# Returns offset and limit used to retrieve objects

419

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

407

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

420

def api_offset_and_limit(options=params)

408

def api_offset_and_limit(options=params)

421

if options[:offset].present?

409

if options[:offset].present?

422

offset = options[:offset].to_i

410

offset = options[:offset].to_i

423

if offset < 0

411

if offset < 0

424

offset = 0

412

offset = 0

425

end

413

end

426

end

414

end

427

limit = options[:limit].to_i

415

limit = options[:limit].to_i

428

if limit < 1

416

if limit < 1

429

limit = 25

417

limit = 25

430

elsif limit > 100

418

elsif limit > 100

431

limit = 100

419

limit = 100

432

end

420

end

433

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

421

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

434

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

422

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

435

offset = 0 if offset < 0

423

offset = 0 if offset < 0

436

end

424

end

437

offset ||= 0

425

offset ||= 0

438

426

439

[offset, limit]

427

[offset, limit]

440

end

428

end

441

429

442

# qvalues http header parser

430

# qvalues http header parser

443

# code taken from webrick

431

# code taken from webrick

444

def parse_qvalues(value)

432

def parse_qvalues(value)

445

tmp = []

433

tmp = []

446

if value

434

if value

447

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

435

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

448

parts.each {|part|

436

parts.each {|part|

449

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

437

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

450

val = m[1]

438

val = m[1]

451

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

439

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

452

tmp.push([val, q])

440

tmp.push([val, q])

453

end

441

end

454

}

442

}

455

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

443

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

456

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

444

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

457

end

445

end

458

return tmp

446

return tmp

459

rescue

447

rescue

460

nil

448

nil

461

end

449

end

462

450

463

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

451

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

464

def filename_for_content_disposition(name)

452

def filename_for_content_disposition(name)

465

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

453

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

466

end

454

end

467

455

468

def api_request?

456

def api_request?

469

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

457

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

470

end

458

end

471

459

472

# Returns the API key present in the request

460

# Returns the API key present in the request

473

def api_key_from_request

461

def api_key_from_request

474

if params[:key].present?

462

if params[:key].present?

475

params[:key]

463

params[:key]

476

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

464

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

477

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

465

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

478

end

466

end

479

end

467

end

480

468

481

# Renders a warning flash if obj has unsaved attachments

469

# Renders a warning flash if obj has unsaved attachments

482

def render_attachment_warning_if_needed(obj)

470

def render_attachment_warning_if_needed(obj)

483

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

471

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

484

end

472

end

485

473

486

# Sets the `flash` notice or error based the number of issues that did not save

474

# Sets the `flash` notice or error based the number of issues that did not save

487

#

475

#

488

# @param [Array, Issue] issues all of the saved and unsaved Issues

476

# @param [Array, Issue] issues all of the saved and unsaved Issues

489

# @param [Array, Integer] unsaved_issue_ids the issue ids that were not saved

477

# @param [Array, Integer] unsaved_issue_ids the issue ids that were not saved

490

def set_flash_from_bulk_issue_save(issues, unsaved_issue_ids)

478

def set_flash_from_bulk_issue_save(issues, unsaved_issue_ids)

491

if unsaved_issue_ids.empty?

479

if unsaved_issue_ids.empty?

492

flash[:notice] = l(:notice_successful_update) unless issues.empty?

480

flash[:notice] = l(:notice_successful_update) unless issues.empty?

493

else

481

else

494

flash[:error] = l(:notice_failed_to_save_issues,

482

flash[:error] = l(:notice_failed_to_save_issues,

495

:count => unsaved_issue_ids.size,

483

:count => unsaved_issue_ids.size,

496

:total => issues.size,

484

:total => issues.size,

497

:ids => '#' + unsaved_issue_ids.join(', #'))

485

:ids => '#' + unsaved_issue_ids.join(', #'))

498

end

486

end

499

end

487

end

500

488

501

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

489

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

502

def query_statement_invalid(exception)

490

def query_statement_invalid(exception)

503

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

491

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

504

session.delete(:query)

492

session.delete(:query)

505

sort_clear if respond_to?(:sort_clear)

493

sort_clear if respond_to?(:sort_clear)

506

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

494

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

507

end

495

end

508

496

509

# Renders API response on validation failure

497

# Renders API response on validation failure

510

def render_validation_errors(objects)

498

def render_validation_errors(objects)

511

if objects.is_a?(Array)

499

if objects.is_a?(Array)

512

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

500

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

513

else

501

else

514

@error_messages = objects.errors.full_messages

502

@error_messages = objects.errors.full_messages

515

end

503

end

516

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

504

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

517

end

505

end

518

506

519

# Overrides #default_template so that the api template

507

# Overrides #default_template so that the api template

520

# is used automatically if it exists

508

# is used automatically if it exists

521

def default_template(action_name = self.action_name)

509

def default_template(action_name = self.action_name)

522

if api_request?

510

if api_request?

523

begin

511

begin

524

return self.view_paths.find_template(default_template_name(action_name), 'api')

512

return self.view_paths.find_template(default_template_name(action_name), 'api')

525

rescue ::ActionView::MissingTemplate

513

rescue ::ActionView::MissingTemplate

526

# the api template was not found

514

# the api template was not found

527

# fallback to the default behaviour

515

# fallback to the default behaviour

528

end

516

end

529

end

517

end

530

super

518

super

531

end

519

end

532

520

533

# Overrides #pick_layout so that #render with no arguments

521

# Overrides #pick_layout so that #render with no arguments

534

# doesn't use the layout for api requests

522

# doesn't use the layout for api requests

535

def pick_layout(*args)

523

def pick_layout(*args)

536

api_request? ? nil : super

524

api_request? ? nil : super

537

end

525

end

538

end

526

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-2011  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
               layout 'base'
               exempt_from_layout 'builder', 'rsb'
               protect_from_forgery
               def handle_unverified_request
                 super
                 cookies.delete(:autologin)
               end
               # Remove broken cookie after upgrade from 0.8.x (#4292)
               # See https://rails.lighthouseapp.com/projects/8994/tickets/3360
               # TODO: remove it when Rails is fixed
               before_filter :delete_broken_cookies
               def delete_broken_cookies
                 if cookies['_redmine_session'] && cookies['_redmine_session'] !~ /--/
                   cookies.delete '_redmine_session'
                   redirect_to home_path
                   return false
                 end
               end
               # FIXME: Remove this when all of Rack and Rails have learned how to
               # properly use encodings
               before_filter :params_filter
               def params_filter
                 if RUBY_VERSION >= '1.9' && defined?(Rails) && Rails::VERSION::MAJOR < 3
                   self.utf8nize!(params)
                 end
               end
               def utf8nize!(obj)
                 if obj.frozen?
                   obj
                 elsif obj.is_a? String
                   obj.respond_to?(:force_encoding) ? obj.force_encoding("UTF-8") : obj
                 elsif obj.is_a? Hash
                   obj.each {|k, v| obj[k] = self.utf8nize!(v)}
                 elsif obj.is_a? Array
                   obj.each {|v| self.utf8nize!(v)}
                 else
                   obj
                 end
               end
               before_filter :user_setup, :check_if_login_required, :set_localization
               filter_parameter_logging :password
               rescue_from ActionController::InvalidAuthenticityToken, :with => :invalid_authenticity_token
               rescue_from ::Unauthorized, :with => :deny_access
               include Redmine::Search::Controller
               include Redmine::MenuManager::MenuController
               helper Redmine::MenuManager::MenuHelper
               Redmine::Scm::Base.all.each do |scm|
                 require_dependency "repository/#{scm.underscore}"
               end
               def user_setup
                 # Check the settings cache for each request
                 Setting.check_cache
                 # Find the current user
                 User.current = find_current_user
               end
               # Returns the current user or nil if no user is logged in
               # and starts a session if needed
               def find_current_user
                 if session[:user_id]
                   # existing session
                   (User.active.find(session[:user_id]) rescue nil)
                 elsif cookies[:autologin] && Setting.autologin?
                   # auto-login feature starts a new session
                   user = User.try_to_autologin(cookies[:autologin])
                   session[:user_id] = user.id if user
                   user
                 elsif params[:format] == 'atom' && params[:key] && request.get? && accept_rss_auth?
                   # RSS key authentication does not start a session
                   User.find_by_rss_key(params[:key])
                 elsif Setting.rest_api_enabled? && accept_api_auth?
                   if (key = api_key_from_request)
                     # Use API key
                     User.find_by_api_key(key)
                   else
                     # HTTP Basic, either username/password or API key/random
                     authenticate_with_http_basic do |username, password|
                       User.try_to_login(username, password) || User.find_by_api_key(username)
                     end
                   end
                 end
               end
               # Sets the logged in user
               def logged_user=(user)
                 reset_session
                 if user && user.is_a?(User)
                   User.current = user
                   session[:user_id] = user.id
                 else
                   User.current = User.anonymous
                 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.read_inheritable_attribute('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)
                 write_inheritable_attribute('model_object', model)
               end
               # Filter for bulk issue operations
               def find_issues
                 @issues = Issue.find_all_by_id(params[:id] || params[:ids])
                 raise ActiveRecord::RecordNotFound if @issues.empty?
                 if @issues.detect {|issue| !issue.visible?}
                   deny_access
                   return
                 end
                 @projects = @issues.collect(&:project).compact.uniq
                 @project = @projects.first if @projects.size == 1
               rescue ActiveRecord::RecordNotFound
                 render_404
               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.active?
                   if @project.visible?
                     true
                   else
                     deny_access
                   end
                 else
                   @project = nil
                   render_404
                   false
                 end
               end
               def back_url
                 params[:back_url] || request.env['HTTP_REFERER']
               end
               def redirect_back_or_default(default)
                 back_url = CGI.unescape(params[:back_url].to_s)
                 if !back_url.blank?
                   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
                     # redirect to default
                   end
                 end
                 redirect_to default
                 false
               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.atom { head @status }
                   format.xml { head @status }
                   format.js { head @status }
                   format.json { head @status }
                 end
               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.atom", :layout => false,
                        :content_type => 'application/atom+xml'
               end
-              # TODO: remove in Redmine 1.4
-              def self.accept_key_auth(*actions)
-                ActiveSupport::Deprecation.warn "ApplicationController.accept_key_auth is deprecated and will be removed in Redmine 1.4. Use accept_rss_auth (or accept_api_auth) instead."
-                accept_rss_auth(*actions)
-              end
-              # TODO: remove in Redmine 1.4
-              def accept_key_auth_actions
-                ActiveSupport::Deprecation.warn "ApplicationController.accept_key_auth_actions is deprecated and will be removed in Redmine 1.4. Use accept_rss_auth (or accept_api_auth) instead."
-                self.class.accept_rss_auth
-              end
               def self.accept_rss_auth(*actions)
                 if actions.any?
                   write_inheritable_attribute('accept_rss_auth_actions', actions)
                 else
                   read_inheritable_attribute('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?
                   write_inheritable_attribute('accept_api_auth_actions', actions)
                 else
                   read_inheritable_attribute('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]
                 elsif request.headers["X-Redmine-API-Key"].present?
                   request.headers["X-Redmine-API-Key"]
                 end
               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
               # Sets the `flash` notice or error based the number of issues that did not save
               #
               # @param [Array, Issue] issues all of the saved and unsaved Issues
               # @param [Array, Integer] unsaved_issue_ids the issue ids that were not saved
               def set_flash_from_bulk_issue_save(issues, unsaved_issue_ids)
                 if unsaved_issue_ids.empty?
                   flash[:notice] = l(:notice_successful_update) unless issues.empty?
                 else
                   flash[:error] = l(:notice_failed_to_save_issues,
                                     :count => unsaved_issue_ids.size,
                                     :total => issues.size,
                                     :ids => '#' + unsaved_issue_ids.join(', #'))
                 end
               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 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 => false
               end
               # Overrides #default_template so that the api template
               # is used automatically if it exists
               def default_template(action_name = self.action_name)
                 if api_request?
                   begin
                     return self.view_paths.find_template(default_template_name(action_name), 'api')
                   rescue ::ActionView::MissingTemplate
                     # the api template was not found
                     # fallback to the default behaviour
                   end
                 end
                 super
               end
               # Overrides #pick_layout so that #render with no arguments
               # doesn't use the layout for api requests
               def pick_layout(*args)
                 api_request? ? nil : super
               end
             end