jro_apps/redmine Commit - r4457:d076c1982227

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 ApplicationController < ActionController::Base

21

class ApplicationController < ActionController::Base

22

include Redmine::I18n

22

include Redmine::I18n

23

24

layout 'base'

24

layout 'base'

25

exempt_from_layout 'builder', 'rsb'

25

exempt_from_layout 'builder', 'rsb'

26

27

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

27

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

28

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

28

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

29

# TODO: remove it when Rails is fixed

29

# TODO: remove it when Rails is fixed

30

before_filter :delete_broken_cookies

30

before_filter :delete_broken_cookies

31

def delete_broken_cookies

31

def delete_broken_cookies

32

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

32

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

33

cookies.delete '_redmine_session'

33

cookies.delete '_redmine_session'

34

redirect_to home_path

34

redirect_to home_path

35

return false

35

return false

36

end

36

end

37

end

37

end

38

39

before_filter :user_setup, :check_if_login_required, :set_localization

39

before_filter :user_setup, :check_if_login_required, :set_localization

40

filter_parameter_logging :password

40

filter_parameter_logging :password

41

protect_from_forgery

41

protect_from_forgery

42

43

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

43

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

44

45

include Redmine::Search::Controller

45

include Redmine::Search::Controller

46

include Redmine::MenuManager::MenuController

46

include Redmine::MenuManager::MenuController

47

helper Redmine::MenuManager::MenuHelper

47

helper Redmine::MenuManager::MenuHelper

48

49

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

49

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

50

require_dependency "repository/#{scm.underscore}"

50

require_dependency "repository/#{scm.underscore}"

51

end

51

end

52

53

def user_setup

53

def user_setup

54

# Check the settings cache for each request

54

# Check the settings cache for each request

55

Setting.check_cache

55

Setting.check_cache

56

# Find the current user

56

# Find the current user

57

User.current = find_current_user

57

User.current = find_current_user

58

end

58

end

59

60

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

60

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

61

# and starts a session if needed

61

# and starts a session if needed

62

def find_current_user

62

def find_current_user

63

if session[:user_id]

63

if session[:user_id]

64

# existing session

64

# existing session

65

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

65

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

66

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

66

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

67

# auto-login feature starts a new session

67

# auto-login feature starts a new session

68

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

68

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

69

session[:user_id] = user.id if user

69

session[:user_id] = user.id if user

70

user

70

user

71

elsif params[:format] == 'atom' && params[:key] && accept_key_auth_actions.include?(params[:action])

71

elsif params[:format] == 'atom' && params[:key] && accept_key_auth_actions.include?(params[:action])

72

# RSS key authentication does not start a session

72

# RSS key authentication does not start a session

73

User.find_by_rss_key(params[:key])

73

User.find_by_rss_key(params[:key])

74

elsif Setting.rest_api_enabled? && ['xml', 'json'].include?(params[:format])

74

elsif Setting.rest_api_enabled? && ['xml', 'json'].include?(params[:format])

75

if params[:key].present? && accept_key_auth_actions.include?(params[:action])

75

if params[:key].present? && accept_key_auth_actions.include?(params[:action])

76

# Use API key

76

# Use API key

77

User.find_by_api_key(params[:key])

77

User.find_by_api_key(params[:key])

78

else

78

else

79

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

79

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

80

authenticate_with_http_basic do |username, password|

80

authenticate_with_http_basic do |username, password|

81

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

81

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

82

end

82

end

83

end

83

end

84

end

84

end

85

end

85

end

86

87

# Sets the logged in user

87

# Sets the logged in user

88

def logged_user=(user)

88

def logged_user=(user)

89

reset_session

89

reset_session

90

if user && user.is_a?(User)

90

if user && user.is_a?(User)

91

User.current = user

91

User.current = user

92

session[:user_id] = user.id

92

session[:user_id] = user.id

93

else

93

else

94

User.current = User.anonymous

94

User.current = User.anonymous

95

end

95

end

96

end

96

end

97

98

# check if login is globally required to access the application

98

# check if login is globally required to access the application

99

def check_if_login_required

99

def check_if_login_required

100

# no check needed if user is already logged in

100

# no check needed if user is already logged in

101

return true if User.current.logged?

101

return true if User.current.logged?

102

require_login if Setting.login_required?

102

require_login if Setting.login_required?

103

end

103

end

104

105

def set_localization

105

def set_localization

106

lang = nil

106

lang = nil

107

if User.current.logged?

107

if User.current.logged?

108

lang = find_language(User.current.language)

108

lang = find_language(User.current.language)

109

end

109

end

110

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

110

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

111

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

111

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

112

if !accept_lang.blank?

112

if !accept_lang.blank?

113

accept_lang = accept_lang.downcase

113

accept_lang = accept_lang.downcase

114

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

114

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

115

end

115

end

116

end

116

end

117

lang ||= Setting.default_language

117

lang ||= Setting.default_language

118

set_language_if_valid(lang)

118

set_language_if_valid(lang)

119

end

119

end

120

121

def require_login

121

def require_login

122

if !User.current.logged?

122

if !User.current.logged?

123

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

123

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

124

if request.get?

124

if request.get?

125

url = url_for(params)

125

url = url_for(params)

126

else

126

else

127

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

127

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

128

end

128

end

129

respond_to do |format|

129

respond_to do |format|

130

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

130

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

131

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

131

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

132

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

132

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

133

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

133

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

134

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

134

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

135

end

135

end

136

return false

136

return false

137

end

137

end

138

true

138

true

139

end

139

end

140

141

def require_admin

141

def require_admin

142

return unless require_login

142

return unless require_login

143

if !User.current.admin?

143

if !User.current.admin?

144

render_403

144

render_403

145

return false

145

return false

146

end

146

end

147

true

147

true

148

end

148

end

149

150

def deny_access

150

def deny_access

151

User.current.logged? ? render_403 : require_login

151

User.current.logged? ? render_403 : require_login

152

end

152

end

153

154

# Authorize the user for the requested action

154

# Authorize the user for the requested action

155

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

155

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

156

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

156

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

157

if allowed

157

if allowed

158

true

158

true

159

else

159

else

160

if @project && @project.archived?

160

if @project && @project.archived?

161

render_403 :message => :notice_not_authorized_archived_project

161

render_403 :message => :notice_not_authorized_archived_project

162

else

162

else

163

deny_access

163

deny_access

164

end

164

end

165

end

165

end

166

end

166

end

167

168

# Authorize the user for the requested action outside a project

168

# Authorize the user for the requested action outside a project

169

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

169

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

170

authorize(ctrl, action, global)

170

authorize(ctrl, action, global)

171

end

171

end

172

173

# Find project of id params[:id]

173

# Find project of id params[:id]

174

def find_project

174

def find_project

175

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

175

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

176

rescue ActiveRecord::RecordNotFound

176

rescue ActiveRecord::RecordNotFound

177

render_404

177

render_404

178

end

178

end

179

180

# Find project of id params[:project_id]

180

# Find project of id params[:project_id]

181

def find_project_by_project_id

181

def find_project_by_project_id

182

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

182

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

183

rescue ActiveRecord::RecordNotFound

183

rescue ActiveRecord::RecordNotFound

184

render_404

184

render_404

185

end

185

end

186

187

# Find a project based on params[:project_id]

187

# Find a project based on params[:project_id]

188

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

188

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

189

def find_optional_project

189

def find_optional_project

190

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

190

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

191

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

191

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

192

allowed ? true : deny_access

192

allowed ? true : deny_access

193

rescue ActiveRecord::RecordNotFound

193

rescue ActiveRecord::RecordNotFound

194

render_404

194

render_404

195

end

195

end

196

197

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

197

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

198

def find_project_from_association

198

def find_project_from_association

199

render_404 unless @object.present?

199

render_404 unless @object.present?

200

201

@project = @object.project

201

@project = @object.project

202

rescue ActiveRecord::RecordNotFound

202

rescue ActiveRecord::RecordNotFound

203

render_404

203

render_404

204

end

204

end

205

206

def find_model_object

206

def find_model_object

207

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

207

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

208

if model

208

if model

209

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

209

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

210

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

210

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

211

end

211

end

212

rescue ActiveRecord::RecordNotFound

212

rescue ActiveRecord::RecordNotFound

213

render_404

213

render_404

214

end

214

end

215

216

def self.model_object(model)

216

def self.model_object(model)

217

write_inheritable_attribute('model_object', model)

217

write_inheritable_attribute('model_object', model)

218

end

218

end

219

220

# Filter for bulk issue operations

220

# Filter for bulk issue operations

221

def find_issues

221

def find_issues

222

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

222

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

223

raise ActiveRecord::RecordNotFound if @issues.empty?

223

raise ActiveRecord::RecordNotFound if @issues.empty?

224

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

224

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

225

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

225

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

226

rescue ActiveRecord::RecordNotFound

226

rescue ActiveRecord::RecordNotFound

227

render_404

227

render_404

228

end

228

end

229

230

# Check if project is unique before bulk operations

230

# Check if project is unique before bulk operations

231

def check_project_uniqueness

231

def check_project_uniqueness

232

unless @project

232

unless @project

233

# TODO: let users bulk edit/move/destroy issues from different projects

233

# TODO: let users bulk edit/move/destroy issues from different projects

234

render_error 'Can not bulk edit/move/destroy issues from different projects'

234

render_error 'Can not bulk edit/move/destroy issues from different projects'

235

return false

235

return false

236

end

236

end

237

end

237

end

238

239

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

239

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

240

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

240

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

241

def check_project_privacy

241

def check_project_privacy

242

if @project && @project.active?

242

if @project && @project.active?

243

if @project.is_public? || User.current.member_of?(@project) || User.current.admin?

243

if @project.is_public? || User.current.member_of?(@project) || User.current.admin?

244

true

244

true

245

else

245

else

246

User.current.logged? ? render_403 : require_login

246

User.current.logged? ? render_403 : require_login

247

end

247

end

248

else

248

else

249

@project = nil

249

@project = nil

250

render_404

250

render_404

251

false

251

false

252

end

252

end

253

end

253

end

254

255

def back_url

255

def back_url

256

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

256

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

257

end

257

end

258

259

def redirect_back_or_default(default)

259

def redirect_back_or_default(default)

260

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

260

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

261

if !back_url.blank?

261

if !back_url.blank?

262

begin

262

begin

263

uri = URI.parse(back_url)

263

uri = URI.parse(back_url)

264

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

264

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

265

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

265

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

266

redirect_to(back_url)

266

redirect_to(back_url)

267

return

267

return

268

end

268

end

269

rescue URI::InvalidURIError

269

rescue URI::InvalidURIError

270

# redirect to default

270

# redirect to default

271

end

271

end

272

end

272

end

273

redirect_to default

273

redirect_to default

274

end

274

end

275

276

def render_403(options={})

276

def render_403(options={})

277

@project = nil

277

@project = nil

278

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

278

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

279

return false

279

return false

280

end

280

end

281

282

def render_404(options={})

282

def render_404(options={})

283

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

283

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

284

return false

284

return false

285

end

285

end

286

287

# Renders an error response

287

# Renders an error response

288

def render_error(arg)

288

def render_error(arg)

289

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

289

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

290

291

@message = arg[:message]

291

@message = arg[:message]

292

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

292

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

293

@status = arg[:status] || 500

293

@status = arg[:status] || 500

294

295

respond_to do |format|

295

respond_to do |format|

296

format.html {

296

format.html {

297

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

297

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

298

}

298

}

299

format.atom { head @status }

299

format.atom { head @status }

300

format.xml { head @status }

300

format.xml { head @status }

301

format.js { head @status }

301

format.js { head @status }

302

format.json { head @status }

302

format.json { head @status }

303

end

303

end

304

end

304

end

305

306

# Picks which layout to use based on the request

306

# Picks which layout to use based on the request

307

#

307

#

308

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

308

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

309

def use_layout

309

def use_layout

310

request.xhr? ? false : 'base'

310

request.xhr? ? false : 'base'

311

end

311

end

312

313

def invalid_authenticity_token

313

def invalid_authenticity_token

314

if api_request?

314

if api_request?

315

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

315

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

316

end

316

end

317

render_error "Invalid form authenticity token."

317

render_error "Invalid form authenticity token."

318

end

318

end

319

320

def render_feed(items, options={})

320

def render_feed(items, options={})

321

@items = items || []

321

@items = items || []

322

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

322

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

323

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

323

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

324

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

324

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

325

render :template => "common/feed.atom.rxml", :layout => false, :content_type => 'application/atom+xml'

325

render :template => "common/feed.atom.rxml", :layout => false, :content_type => 'application/atom+xml'

326

end

326

end

327

328

def self.accept_key_auth(*actions)

328

def self.accept_key_auth(*actions)

329

actions = actions.flatten.map(&:to_s)

329

actions = actions.flatten.map(&:to_s)

330

write_inheritable_attribute('accept_key_auth_actions', actions)

330

write_inheritable_attribute('accept_key_auth_actions', actions)

331

end

331

end

332

333

def accept_key_auth_actions

333

def accept_key_auth_actions

334

self.class.read_inheritable_attribute('accept_key_auth_actions') || []

334

self.class.read_inheritable_attribute('accept_key_auth_actions') || []

335

end

335

end

336

337

# Returns the number of objects that should be displayed

337

# Returns the number of objects that should be displayed

338

# on the paginated list

338

# on the paginated list

339

def per_page_option

339

def per_page_option

340

per_page = nil

340

per_page = nil

341

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

341

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

342

per_page = params[:per_page].to_s.to_i

342

per_page = params[:per_page].to_s.to_i

343

session[:per_page] = per_page

343

session[:per_page] = per_page

344

elsif session[:per_page]

344

elsif session[:per_page]

345

per_page = session[:per_page]

345

per_page = session[:per_page]

346

else

346

else

347

per_page = Setting.per_page_options_array.first || 25

347

per_page = Setting.per_page_options_array.first || 25

348

end

348

end

349

per_page

349

per_page

350

end

350

end

351

352

def api_offset_and_limit

352

# Returns offset and limit used to retrieve objects

353

offset = nil

353

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

354

if params[:offset].present?

354

def api_offset_and_limit(options=params)

355

offset = params[:offset].to_i

355

if options[:offset].present?

356

offset = options[:offset].to_i

356

if offset < 0

357

if offset < 0

357

offset = 0

358

offset = 0

358

end

359

end

359

end

360

end

360

limit = ~~param~~s[:limit].to_i

361

limit = options[:limit].to_i

361

if limit < 1

362

if limit < 1

362

limit = 25

363

limit = 25

363

elsif limit > 100

364

elsif limit > 100

364

limit = 100

365

limit = 100

365

end

366

end

367

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

368

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

369

offset = 0 if offset < 0

370

end

371

offset ||= 0

372

366

[offset, limit]

373

[offset, limit]

367

end

374

end

368

375

369

# qvalues http header parser

376

# qvalues http header parser

370

# code taken from webrick

377

# code taken from webrick

371

def parse_qvalues(value)

378

def parse_qvalues(value)

372

tmp = []

379

tmp = []

373

if value

380

if value

374

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

381

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

375

parts.each {|part|

382

parts.each {|part|

376

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

383

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

377

val = m[1]

384

val = m[1]

378

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

385

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

379

tmp.push([val, q])

386

tmp.push([val, q])

380

end

387

end

381

}

388

}

382

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

389

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

383

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

390

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

384

end

391

end

385

return tmp

392

return tmp

386

rescue

393

rescue

387

nil

394

nil

388

end

395

end

389

396

390

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

397

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

391

def filename_for_content_disposition(name)

398

def filename_for_content_disposition(name)

392

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

399

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

393

end

400

end

394

401

395

def api_request?

402

def api_request?

396

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

403

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

397

end

404

end

398

405

399

# Renders a warning flash if obj has unsaved attachments

406

# Renders a warning flash if obj has unsaved attachments

400

def render_attachment_warning_if_needed(obj)

407

def render_attachment_warning_if_needed(obj)

401

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

408

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

402

end

409

end

403

410

404

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

411

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

405

#

412

#

406

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

413

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

407

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

414

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

408

def set_flash_from_bulk_issue_save(issues, unsaved_issue_ids)

415

def set_flash_from_bulk_issue_save(issues, unsaved_issue_ids)

409

if unsaved_issue_ids.empty?

416

if unsaved_issue_ids.empty?

410

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

417

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

411

else

418

else

412

flash[:error] = l(:notice_failed_to_save_issues,

419

flash[:error] = l(:notice_failed_to_save_issues,

413

:count => unsaved_issue_ids.size,

420

:count => unsaved_issue_ids.size,

414

:total => issues.size,

421

:total => issues.size,

415

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

422

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

416

end

423

end

417

end

424

end

418

425

419

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

426

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

420

def query_statement_invalid(exception)

427

def query_statement_invalid(exception)

421

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

428

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

422

session.delete(:query)

429

session.delete(:query)

423

sort_clear if respond_to?(:sort_clear)

430

sort_clear if respond_to?(:sort_clear)

424

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

431

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

425

end

432

end

426

433

427

# Converts the errors on an ActiveRecord object into a common JSON format

434

# Converts the errors on an ActiveRecord object into a common JSON format

428

def object_errors_to_json(object)

435

def object_errors_to_json(object)

429

object.errors.collect do |attribute, error|

436

object.errors.collect do |attribute, error|

430

{ attribute => error }

437

{ attribute => error }

431

end.to_json

438

end.to_json

432

end

439

end

433

440

434

# Renders API response on validation failure

441

# Renders API response on validation failure

435

def render_validation_errors(object)

442

def render_validation_errors(object)

436

options = { :status => :unprocessable_entity, :layout => false }

443

options = { :status => :unprocessable_entity, :layout => false }

437

options.merge!(case params[:format]

444

options.merge!(case params[:format]

438

when 'xml'; { :xml => object.errors }

445

when 'xml'; { :xml => object.errors }

439

when 'json'; { :json => {'errors' => object.errors} } # ActiveResource client compliance

446

when 'json'; { :json => {'errors' => object.errors} } # ActiveResource client compliance

440

else

447

else

441

raise "Unknown format #{params[:format]} in #render_validation_errors"

448

raise "Unknown format #{params[:format]} in #render_validation_errors"

442

end

449

end

443

)

450

)

444

render options

451

render options

445

end

452

end

446

453

447

# Overrides #default_template so that the api template

454

# Overrides #default_template so that the api template

448

# is used automatically if it exists

455

# is used automatically if it exists

449

def default_template(action_name = self.action_name)

456

def default_template(action_name = self.action_name)

450

if api_request?

457

if api_request?

451

begin

458

begin

452

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

459

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

453

rescue ::ActionView::MissingTemplate

460

rescue ::ActionView::MissingTemplate

454

# the api template was not found

461

# the api template was not found

455

# fallback to the default behaviour

462

# fallback to the default behaviour

456

end

463

end

457

end

464

end

458

super

465

super

459

end

466

end

460

467

461

# Overrides #pick_layout so that #render with no arguments

468

# Overrides #pick_layout so that #render with no arguments

462

# doesn't use the layout for api requests

469

# doesn't use the layout for api requests

463

def pick_layout(*args)

470

def pick_layout(*args)

464

api_request? ? nil : super

471

api_request? ? nil : super

465

end

472

end

466

end

473

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-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require 'uri'
             require 'cgi'
             class ApplicationController < ActionController::Base
               include Redmine::I18n
               layout 'base'
               exempt_from_layout 'builder', 'rsb'
               # 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
               before_filter :user_setup, :check_if_login_required, :set_localization
               filter_parameter_logging :password
               protect_from_forgery
               rescue_from ActionController::InvalidAuthenticityToken, :with => :invalid_authenticity_token
               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] && accept_key_auth_actions.include?(params[:action])
                   # RSS key authentication does not start a session
                   User.find_by_rss_key(params[:key])
                 elsif Setting.rest_api_enabled? && ['xml', 'json'].include?(params[:format])
                   if params[:key].present? && accept_key_auth_actions.include?(params[:action])
                     # Use API key
                     User.find_by_api_key(params[: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
               rescue ActiveRecord::RecordNotFound
                 render_404
               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?
                 @projects = @issues.collect(&:project).compact.uniq
                 @project = @projects.first if @projects.size == 1
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               # Check if project is unique before bulk operations
               def check_project_uniqueness
                 unless @project
                   # TODO: let users bulk edit/move/destroy issues from different projects
                   render_error 'Can not bulk edit/move/destroy issues from different projects'
                   return false
                 end
               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.is_public? || User.current.member_of?(@project) || User.current.admin?
                     true
                   else
                     User.current.logged? ? render_403 : require_login
                   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
               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
               # 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.rxml", :layout => false, :content_type => 'application/atom+xml'
               end
               def self.accept_key_auth(*actions)
                 actions = actions.flatten.map(&:to_s)
                 write_inheritable_attribute('accept_key_auth_actions', actions)
               end
               def accept_key_auth_actions
                 self.class.read_inheritable_attribute('accept_key_auth_actions') || []
               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
-              def api_offset_and_limit
+              # Returns offset and limit used to retrieve objects
-                offset = nil
+              # for an API response based on offset, limit and page parameters
-                if params[:offset].present?
+              def api_offset_and_limit(options=params)
-                  offset = params[:offset].to_i
+                if options[:offset].present?
+                  offset = options[:offset].to_i
                   if offset < 0
                     offset = 0
                   end
                 end
-                limit = params[:limit].to_i
+                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
               # 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
               # Converts the errors on an ActiveRecord object into a common JSON format
               def object_errors_to_json(object)
                 object.errors.collect do |attribute, error|
                   { attribute => error }
                 end.to_json
               end
               # Renders API response on validation failure
               def render_validation_errors(object)
                 options = { :status => :unprocessable_entity, :layout => false }
                 options.merge!(case params[:format]
                   when 'xml';  { :xml =>  object.errors }
                   when 'json'; { :json => {'errors' => object.errors} } # ActiveResource client compliance
                   else
                     raise "Unknown format #{params[:format]} in #render_validation_errors"
                   end
                 )
                 render options
               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

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require File.expand_path('../../test_helper', __FILE__)
             require 'application_controller'
             # Re-raise errors caught by the controller.
             class ApplicationController; def rescue_action(e) raise e end; end
             class ApplicationControllerTest < ActionController::TestCase
               include Redmine::I18n
               def setup
                 @controller = ApplicationController.new
                 @request    = ActionController::TestRequest.new
                 @response   = ActionController::TestResponse.new
               end
               # check that all language files are valid
               def test_localization
                 lang_files_count = Dir["#{RAILS_ROOT}/config/locales/*.yml"].size
                 assert_equal lang_files_count, valid_languages.size
                 valid_languages.each do |lang|
                   assert set_language_if_valid(lang)
                 end
                 set_language_if_valid('en')
               end
               def test_call_hook_mixed_in
                 assert @controller.respond_to?(:call_hook)
               end
+              context "test_api_offset_and_limit" do
+                context "without params" do
+                  should "return 0, 25" do
+                    assert_equal [0, 25], @controller.api_offset_and_limit({})
+                  end
+                end
+                context "with limit" do
+                  should "return 0, limit" do
+                    assert_equal [0, 30], @controller.api_offset_and_limit({:limit => 30})
+                  end
+                  should "not exceed 100" do
+                    assert_equal [0, 100], @controller.api_offset_and_limit({:limit => 120})
+                  end
+                  should "not be negative" do
+                    assert_equal [0, 25], @controller.api_offset_and_limit({:limit => -10})
+                  end
+                end
+                context "with offset" do
+                  should "return offset, 25" do
+                    assert_equal [10, 25], @controller.api_offset_and_limit({:offset => 10})
+                  end
+                  should "not be negative" do
+                    assert_equal [0, 25], @controller.api_offset_and_limit({:offset => -10})
+                  end
+                  context "and limit" do
+                    should "return offset, limit" do
+                      assert_equal [10, 50], @controller.api_offset_and_limit({:offset => 10, :limit => 50})
+                    end
+                  end
+                end
+                context "with page" do
+                  should "return offset, 25" do
+                    assert_equal [0, 25], @controller.api_offset_and_limit({:page => 1})
+                    assert_equal [50, 25], @controller.api_offset_and_limit({:page => 3})
+                  end
+                  should "not be negative" do
+                    assert_equal [0, 25], @controller.api_offset_and_limit({:page => 0})
+                    assert_equal [0, 25], @controller.api_offset_and_limit({:page => -2})
+                  end
+                  context "and limit" do
+                    should "return offset, limit" do
+                      assert_equal [0, 100], @controller.api_offset_and_limit({:page => 1, :limit => 100})
+                      assert_equal [200, 100], @controller.api_offset_and_limit({:page => 3, :limit => 100})
+                    end
+                  end
+                end
+              end
             end