-
Notifications
You must be signed in to change notification settings - Fork 434
/
bs_request.rb
1309 lines (1123 loc) · 44.8 KB
/
bs_request.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
require 'xmlhash'
include MaintenanceHelper
class BsRequest < ApplicationRecord
class InvalidStateError < APIError
setup 'request_not_modifiable', 404
end
class InvalidReview < APIError
setup 'invalid_review', 400, 'request review item is not specified via by_user, by_group or by_project'
end
class InvalidDate < APIError
setup 'invalid_date', 400
end
class UnderEmbargo < APIError
setup 'under_embargo', 400
end
class SaveError < APIError
setup 'request_save_error'
end
SEARCHABLE_FIELDS = [
'bs_requests.creator',
'bs_requests.priority',
'bs_request_actions.target_project',
'bs_request_actions.target_package',
'bs_request_actions.source_project',
'bs_request_actions.source_package',
'bs_request_actions.type'
].freeze
FINAL_REQUEST_STATES = ['accepted', 'declined', 'superseded', 'revoked'].freeze
VALID_REQUEST_STATES = [:new, :deleted, :declined, :accepted, :review, :revoked, :superseded].freeze
OBSOLETE_STATES = [:declined, :superseded, :revoked].freeze
ACTION_NOTIFY_LIMIT = 50
scope :to_accept_by_time, -> { where(state: ['new', 'review']).where('accept_at < ?', Time.now) }
# Scopes for collections
scope :with_actions, -> { includes(:bs_request_actions).references(:bs_request_actions).distinct.order(priority: :asc, id: :desc) }
scope :with_involved_projects, ->(project_ids) { where(bs_request_actions: { target_project_id: project_ids }) }
scope :with_involved_packages, ->(package_ids) { where(bs_request_actions: { target_package_id: package_ids }) }
scope :with_source_subprojects, ->(project_name) { where('bs_request_actions.source_project like ?', project_name) }
scope :with_target_subprojects, ->(project_name) { where('bs_request_actions.target_project like ?', project_name) }
scope :in_states, ->(states) { where(state: states) }
scope :with_types, lambda { |types|
includes(:bs_request_actions).where(bs_request_actions: { type: types }).distinct.order(priority: :asc, id: :desc)
}
scope :from_source_project, ->(source_project) { where(bs_request_actions: { source_project: source_project }) }
scope :in_ids, ->(ids) { where(id: ids) }
scope :not_creator, ->(login) { where.not(creator: login) }
# Searching capabilities using dataTable (1.9)
scope :do_search, lambda { |search|
includes(:bs_request_actions)
.references(:bs_request_actions)
.where(
[
SEARCHABLE_FIELDS.map { |field| "#{field} like ?" }.join(' or '), ["%#{search}%"] * SEARCHABLE_FIELDS.length
].flatten
)
}
scope :with_actions_and_reviews, -> { joins(:bs_request_actions).left_outer_joins(:reviews).distinct.order(priority: :asc, id: :desc) }
scope :with_submit_requests, -> { joins(:bs_request_actions).where(bs_request_actions: { type: 'submit' }) }
scope :by_user_reviews, ->(user_ids) { where(reviews: { user: user_ids }) }
scope :by_project_reviews, ->(project_ids) { where(reviews: { project: project_ids }) }
scope :by_package_reviews, ->(package_ids) { where(reviews: { package: package_ids }) }
scope :by_group_reviews, ->(group_ids) { where(reviews: { group: group_ids }) }
scope :for_user, ->(params) { BsRequest::FindFor::User.new(params).all }
scope :for_group, ->(params) { BsRequest::FindFor::Group.new(params).all }
scope :for_project, ->(params) { BsRequest::FindFor::Project.new(params).all }
scope :find_for, ->(params) { BsRequest::FindFor::Query.new(params).all }
scope :obsolete, -> { where(state: OBSOLETE_STATES) }
before_save :assign_number
has_many :bs_request_actions, -> { includes([:bs_request_action_accept_info]) }, dependent: :destroy
has_many :reviews, dependent: :delete_all
has_many :comments, as: :commentable, dependent: :delete_all
has_many :request_history_elements, -> { order(:created_at) }, class_name: 'HistoryElement::Request', foreign_key: :op_object_id
has_many :review_history_elements, through: :reviews, source: :history_elements
has_many :status_reports, as: :checkable, class_name: 'Status::Report', dependent: :destroy
has_many :target_project_objects, through: :bs_request_actions
validates :state, inclusion: { in: VALID_REQUEST_STATES }
validates :creator, presence: true
validate :check_supersede_state
validate :check_creator, on: [:create, :save!]
validates :comment, length: { maximum: 65_535 }
validates :description, length: { maximum: 65_535 }
validates :number, uniqueness: true
validates_associated :bs_request_actions, message: ->(_, record) { record[:value].map { |r| r.errors.full_messages }.flatten.to_sentence }
before_update :send_state_change
after_commit :update_cache
def self.delayed_auto_accept
to_accept_by_time.each do |request|
BsRequestAutoAcceptJob.perform_later(request.id)
end
end
def self.find_by_number!(number)
# overload for propper error reporting
r = BsRequest.find_by_number(number)
unless r
# the external visible request id is stored in number row.
# the database id must not be exposed to the outside
raise NotFoundError, "Couldn't find request with id '#{number}'"
end
r
end
def self.list(opts)
# All types means don't pass 'type'
if opts[:types] == 'all' || (opts[:types].respond_to?(:include?) && opts[:types].include?('all'))
opts.delete(:types)
end
# Do not allow a full collection to avoid server load
if [:project, :user, :package].all? { |filter| opts[filter].blank? }
raise 'This call requires at least one filter, either by user, project or package'
end
roles = opts[:roles] || []
states = opts[:states] || []
# it's wiser to split the queries
if opts[:project] && roles.empty? && (states.empty? || states.include?('review'))
(BsRequest.find_for(opts.merge(roles: ['reviewer'])) +
BsRequest.find_for(opts.merge(roles: ['target', 'source']))).uniq
else
BsRequest.find_for(opts).uniq
end
end
def self.list_numbers(opts)
list(opts).pluck(:number)
end
def self.actions_summary(payload)
ret = []
payload.with_indifferent_access['actions'][0..ACTION_NOTIFY_LIMIT].each do |a|
str = "#{a['type']} #{a['targetproject']}"
str += "/#{a['targetpackage']}" if a['targetpackage']
str += "/#{a['targetrepository']}" if a['targetrepository']
ret << str
end
ret.join(', ')
end
def self.new_from_xml(xml)
hashed = Xmlhash.parse(xml)
raise SaveError, 'Failed parsing the request xml' unless hashed
new_from_hash(hashed)
end
def self.new_from_hash(hashed)
if hashed['id']
theid = hashed.delete('id') { raise 'not found' }
theid = Integer(theid)
else
theid = nil
end
# we will set it our own according to the user
hashed.delete('creator')
if hashed['submit'] && hashed['type'] == 'submit'
# old style, convert to new style on the fly
hashed.delete('type')
hashed['action'] = hashed.delete('submit')
hashed['action']['type'] = 'submit'
end
request = nil
BsRequest.transaction do
request = BsRequest.new
request.number = theid if theid
actions = hashed.delete('action')
actions = [actions] if actions.is_a?(Hash)
request.priority = hashed.delete('priority') || 'moderate'
state = hashed.delete('state') || Xmlhash::XMLHash.new('name' => 'new')
request.state = state.delete('name') || 'new'
request.state = :declined if request.state.to_s == 'rejected'
request.state = :accepted if request.state.to_s == 'accept'
request.state = request.state.to_sym
request.comment = state.value('comment')
state.delete('comment')
request.commenter = state.delete('who')
unless request.commenter
raise 'no one logged in and no user in request' unless User.current
request.commenter = User.current.login
end
# to be overwritten if we find history
request.creator = request.commenter
if actions
actions.each do |ac|
a = BsRequestAction.new_from_xml_hash(ac)
request.bs_request_actions << a
a.bs_request = request
end
end
str = state.delete('when')
request.updated_when = Time.zone.parse(str) if str
str = state.delete('superseded_by') || ''
request.superseded_by = Integer(str) if str.present?
str = state.delete('approver')
request.approver = str if str.present?
raise ArgumentError, "too much information #{state.inspect}" if state.present?
request.description = hashed.value('description')
hashed.delete('description')
str = hashed.value('accept_at')
request.accept_at = Time.parse(str) if str
hashed.delete('accept_at')
raise SaveError, 'Auto accept time is in the past' if request.accept_at && request.accept_at < Time.now
# we do not support to import history anymore on purpose
# would be all fake, but means also history gets lost when
# updating from OBS 2.3 or older.
hashed.delete('history')
reviews = hashed.delete('review')
reviews = [reviews] if reviews.is_a?(Hash)
if reviews
reviews.each do |r|
request.reviews << Review.new_from_xml_hash(r)
end
end
raise ArgumentError, "too much information #{hashed.inspect}" if hashed.present?
request.updated_at ||= Time.now
end
request
end
def self.truncated_diffs?(request)
submit_requests = request['actions'].select { |action| action[:type] == :submit && action[:sourcediff] }
submit_requests.any? do |action|
action[:sourcediff].any? { |sourcediff| sourcediff_has_shown_attribute?(sourcediff) }
end
end
def self.sourcediff_has_shown_attribute?(sourcediff)
if sourcediff && sourcediff['files']
# the 'shown' attribute is only set if the backend truncated the diff
sourcediff['files'].any? { |file| file[1]['diff'].try(:[], 'shown') }
else
false
end
end
private_class_method :sourcediff_has_shown_attribute?
# Requests in 'review' state that have new reviews for the given project
#
# @param [Hash] props can contain :by_project, :by_group, :by_user, :by_package
# or :target_project
# @return [Array] Array of Request objects
def self.with_open_reviews_for(attributes)
with_reviews(attributes).where(state: 'new').rewhere('bs_requests.state': 'review').map(&:bs_request)
end
def self.in_state_new(attributes)
with_reviews(attributes).where('bs_requests.state': 'new').map(&:bs_request)
end
def self.with_reviews(attributes)
review_attributes = attributes.slice(:by_project, :by_group, :by_user, :by_package, :state)
reviews = Review.where(review_attributes).includes(bs_request: [:reviews, :bs_request_actions])
return reviews unless attributes[:target_project]
reviews.where('bs_request_actions.target_project': attributes[:target_project])
end
# Currently only used by staging projects for the obs factories and
# customized for that.
def as_json(*)
super(except: [:state, :comment, :commenter]).tap do |request_hash|
request_hash['superseded_by_id'] = superseded_by if has_attribute?(:superseded_by)
request_hash['state'] = state.to_s if has_attribute?(:state)
request_hash['request_type'] = bs_request_actions.first.type
request_hash['package'] = bs_request_actions.first.target_package
request_hash['project'] = bs_request_actions.first.target_project
end
end
def save!(args = {})
new = created_at ? nil : 1
sanitize! if new && !@skip_sanitize
super
notify if new
end
def history_elements
HistoryElement::Base.where(id: request_history_elements.pluck(:id) + review_history_elements.pluck(:id)).order(:created_at)
end
def set_add_revision
@addrevision = true
end
def set_ignore_build_state
@ignore_build_state = true
end
def skip_sanitize
@skip_sanitize = true
end
def check_creator
errors.add(:creator, 'No creator defined') unless creator
user = User.not_deleted.find_by(login: creator)
# FIXME: We should run the authorization on controller level
raise APIError unless User.current.can_modify_user?(user)
errors.add(:creator, "Invalid creator specified #{creator}") unless user
return if user.is_active?
errors.add(:creator, "Login #{user.login} is not an active user")
end
def assign_number
return if number
# to assign a unique and steady incremental number.
# Using MySQL auto-increment mechanism is not working on clusters.
BsRequest.transaction do
request_counter = BsRequestCounter.lock(true).first_or_create
self.number = request_counter.counter
request_counter.increment(:counter)
request_counter.save!
end
end
def check_supersede_state
if state == :superseded && (!superseded_by.is_a?(Numeric) || !(superseded_by > 0))
errors.add(:superseded_by, 'Superseded_by should be set')
end
return unless superseded_by && !(state == :superseded)
errors.add(:superseded_by, 'Superseded_by should not be set')
end
def updated_when
self[:updated_when] || self[:updated_at]
end
def superseding
BsRequest.where(superseded_by: number)
end
def first_target_package
bs_request_actions.first.target_package
end
def state
self[:state].to_sym
end
after_rollback :reset_cache
after_save :reset_cache
def reset_cache
return unless id
Rails.cache.delete("xml_bs_request_fullhistory_#{cache_key}")
Rails.cache.delete("xml_bs_request_history_#{cache_key}")
Rails.cache.delete("xml_bs_request_#{cache_key}")
end
def to_axml(opts = {})
if opts[:withfullhistory]
Rails.cache.fetch("xml_bs_request_fullhistory_#{cache_key}") do
render_xml(withfullhistory: 1)
end
elsif opts[:withhistory]
Rails.cache.fetch("xml_bs_request_history_#{cache_key}") do
render_xml(withhistory: 1)
end
else
Rails.cache.fetch("xml_bs_request_#{cache_key}") do
render_xml
end
end
end
def to_axml_id
# FIXME: naming it axml is nonsense if it's just a string
"<request id='#{number}'/>\n"
end
def to_param
number
end
def render_xml(opts = {})
builder = Nokogiri::XML::Builder.new
builder.request(id: number, creator: creator) do |r|
bs_request_actions.each do |action|
action.render_xml(r)
end
r.priority(priority) unless priority == 'moderate'
# state element
attributes = { name: state, who: commenter, when: updated_when.strftime('%Y-%m-%dT%H:%M:%S') }
attributes[:superseded_by] = superseded_by if superseded_by
attributes[:approver] = approver if approver
r.state(attributes) do |s|
comment = self.comment
comment ||= ''
s.comment!(comment)
end
reviews.each do |review|
review.render_xml(r)
end
if opts[:withfullhistory] || opts[:withhistory]
attributes = { who: creator, when: created_at.strftime('%Y-%m-%dT%H:%M:%S') }
builder.history(attributes) do
# request description is on purpose the comment in history:
builder.description!('Request created')
builder.comment!(description) if description.present?
end
end
if opts[:withfullhistory]
history_elements.each do |history|
# we do ignore the review history here on purpose to stay compatible
history.render_xml(r)
end
elsif opts[:withhistory]
request_history_elements.each do |history|
# we do ignore the review history here on purpose to stay compatible
history.render_xml(r)
end
end
r.accept_at(accept_at) unless accept_at.nil?
r.description(description) unless description.nil?
end
builder.to_xml(save_with: Nokogiri::XML::Node::SaveOptions::NO_DECLARATION |
Nokogiri::XML::Node::SaveOptions::FORMAT)
end
def is_reviewer?(user)
return false if reviews.blank?
reviews.each do |r|
if r.by_user
return true if user.login == r.by_user
elsif r.by_group
return true if user.is_in_group?(r.by_group)
elsif r.by_project
if r.by_package
pkg = Package.find_by_project_and_name(r.by_project, r.by_package)
return true if pkg && user.can_modify?(pkg)
else
prj = Project.find_by_name(r.by_project)
return true if prj && user.can_modify?(prj)
end
end
end
false
end
def obsolete_reviews(opts)
return false unless opts[:by_user] || opts[:by_group] || opts[:by_project] || opts[:by_package]
reviews.each do |review|
next unless review.reviewable_by?(opts)
logger.debug "Obsoleting review #{review.id}"
review.state = :obsoleted
review.save
history = HistoryElement::ReviewObsoleted
history.create(review: review, comment: 'reviewer got removed', user_id: User.current.id)
# Maybe this will turn the request into an approved state?
next unless state == :review && reviews.where(state: 'new').none?
self.state = :new
save
history = HistoryElement::RequestAllReviewsApproved
history.create(request: self, comment: opts[:comment], user_id: User.current.id)
end
end
def permission_check_change_review!(params)
checker = BsRequestPermissionCheck.new(self, params)
checker.cmd_changereviewstate_permissions(params)
end
def permission_check_setincident!(incident)
checker = BsRequestPermissionCheck.new(self, incident: incident)
checker.cmd_setincident_permissions
end
def permission_check_setpriority!
checker = BsRequestPermissionCheck.new(self, {})
checker.cmd_setpriority_permissions
end
def permission_check_addreview!
# allow request creator to add further reviewers
checker = BsRequestPermissionCheck.new(self, {})
checker.cmd_addreview_permissions(creator == User.current.login || is_reviewer?(User.current))
end
def permission_check_change_state!(opts)
checker = BsRequestPermissionCheck.new(self, opts)
checker.cmd_changestate_permissions(opts)
# check target write permissions
return unless opts[:newstate] == 'accepted'
check_bs_request_actions!(skip_source: true)
end
def changestate_accepted(opts)
# all maintenance_incident actions go into the same incident project
incident_project = nil # .where(type: 'maintenance_incident')
bs_request_actions.each do |action|
source_project = Project.find_by_name(action.source_project)
if action.source_project && action.is_maintenance_release?
if source_project.is_a?(Project)
at = AttribType.find_by_namespace_and_name!('OBS', 'EmbargoDate')
attrib = source_project.attribs.find_by(attrib_type: at)
v = attrib.values.first if attrib
if defined?(v) && v
begin
embargo = Time.parse(v.value)
if /^\d{4}-\d\d?-\d\d?$/.match?(v.value)
# no time specified, allow it next day
embargo = embargo.tomorrow
end
rescue ArgumentError
raise InvalidDate, "Unable to parse the date in OBS:EmbargoDate of project #{source_project.name}: #{v}"
end
if embargo > Time.now
raise UnderEmbargo, "The project #{source_project.name} is under embargo until #{v}"
end
end
end
end
next unless action.is_maintenance_incident?
target_project = Project.get_by_name(action.target_project)
# create a new incident if needed
next unless target_project.is_maintenance?
# create incident if it is a maintenance project
incident_project ||= MaintenanceIncident.build_maintenance_incident(target_project, source_project.nil?, self).project
opts[:check_for_patchinfo] = true
unless incident_project.name.start_with?(target_project.name)
raise MultipleMaintenanceIncidents, 'This request handles different maintenance incidents, this is not allowed !'
end
action.target_project = incident_project.name
action.save!
end
# We have permission to change all requests inside, now execute
bs_request_actions.each do |action|
action.execute_accept(opts)
end
# now do per request cleanup
bs_request_actions.each do |action|
action.per_request_cleanup(opts)
end
end
def changestate_revoked
bs_request_actions.where(type: 'maintenance_release').find_each do |action|
# unlock incident project in the soft way
prj = Project.get_by_name(action.source_project)
if prj.is_locked?
prj.unlock_by_request(self)
else
pkg = Package.get_by_project_and_name(action.source_project, action.source_package)
pkg.unlock_by_request(self) if pkg.is_locked?
end
end
end
def change_state(opts)
with_lock do
permission_check_change_state!(opts)
changestate_revoked if opts[:newstate] == 'revoked'
changestate_accepted(opts) if opts[:newstate] == 'accepted'
state = opts[:newstate].to_sym
bs_request_actions.each do |a|
# "inform" the actions
a.request_changes_state(state)
end
self.state = state
self.commenter = User.current.login
self.comment = opts[:comment]
self.superseded_by = opts[:superseded_by]
# check for not accepted reviews on re-open
if state == :new || state == :review
reviews.each do |review|
next unless review.state != :accepted
# FIXME3.0 review history?
review.state = :new
review.save!
self.state = :review
end
end
save!
params = { request: self, comment: opts[:comment], user_id: User.current.id }
case opts[:newstate]
when 'accepted' then
history = HistoryElement::RequestAccepted
when 'declined' then
history = HistoryElement::RequestDeclined
when 'revoked' then
history = HistoryElement::RequestRevoked
when 'superseded' then
history = HistoryElement::RequestSuperseded
params[:description_extension] = superseded_by.to_s
when 'review' then
history = HistoryElement::RequestReopened
when 'new' then
history = HistoryElement::RequestReopened
when 'deleted' then
history = HistoryElement::RequestDeleted
else
raise "Unhandled state #{opts[:newstate]} for history"
end
history.create(params)
end
end
def assignreview(opts = {})
unless state == :review || (state == :new && state == :new)
raise InvalidStateError, 'request is not in review state'
end
reviewer = User.find_by_login!(opts[:reviewer])
Review.transaction do
# check if user is a reviewer already
user_review = reviews.where(by_user: reviewer.login).last
if opts[:revert]
_assignreview_update_reviews(reviewer, opts)
raise Review::NotFoundError unless user_review
raise InvalidStateError, 'review is not in new state' unless user_review.state == :new
raise Review::NotFoundError, 'Not an assigned review' unless HistoryElement::ReviewAssigned.where(op_object_id: user_review.id).last
user_review.destroy
elsif user_review
review_comment = _assignreview_update_reviews(reviewer, opts)
user_review.state = :new
user_review.save!
HistoryElement::ReviewReopened.create(review: user_review, comment: review_comment, user: User.current)
else
review = reviews.create(by_user: reviewer.login, creator: User.current.login, state: :new)
review_comment = _assignreview_update_reviews(reviewer, opts, review)
HistoryElement::ReviewAssigned.create(review: review, comment: review_comment, user: User.current)
end
save!
end
end
def approval_handling(new_approver, opts)
unless state == :review
raise InvalidStateError, 'request is not in review state'
end
# check if User.current is allowed to potentially accept the request
# (note: setting the :force key to true will skip some checks but
# none of them is supposed to be crucial wrt. permission checking)
my_opts = opts.merge(newstate: 'accepted', force: true)
checker = BsRequestPermissionCheck.new(self, my_opts)
checker.cmd_changestate_permissions(my_opts)
check_bs_request_actions!(skip_source: true)
self.approver = new_approver
save!
reset_cache
end
private :approval_handling
def approve(opts)
raise InvalidStateError, "already approved by #{approver}" if approver
approval_handling(User.current, opts)
end
def cancelapproval(opts)
raise InvalidStateError, 'request is not approved' unless approver
approval_handling(nil, opts)
end
def calculate_state_from_reviews
return :declined if reviews.declined.exists?
if reviews.all?(&:accepted?)
:new
else
:review
end
end
def find_review_for_opts(opts)
reviews.reverse.find { |review| review.reviewable_by?(opts) }
end
def supersede_request(history_arguments, superseded_opt)
self.state = :superseded
self.superseded_by = superseded_opt
history_arguments[:description_extension] = superseded_by.to_s
save!
HistoryElement::RequestSuperseded.create(history_arguments)
end
def change_review_state(new_review_state, opts = {})
with_lock do
new_review_state = new_review_state.to_sym
unless state == :review || (state == :new && new_review_state == :new)
raise InvalidStateError, 'request is not in review state'
end
check_if_valid_review!(opts)
unless new_review_state.in?([:new, :accepted, :declined, :superseded])
raise InvalidStateError, "review state must be new, accepted, declined or superseded, was #{new_review_state}"
end
old_request_state = state
review = find_review_for_opts(opts)
raise Review::NotFoundError unless review
return unless review.change_state(new_review_state, opts[:comment] || '')
history_parameters = { request: self, comment: opts[:comment], user_id: User.current.id }
return supersede_request(history_parameters, opts[:superseded_by]) if new_review_state == :superseded
new_request_state = calculate_state_from_reviews
return if new_request_state == old_request_state
self.comment = review.reason
self.state = new_request_state
self.commenter = User.current.login
if new_request_state == :new
self.comment = 'All reviewers accepted request'
save!
Event::RequestReviewsDone.create(notify_parameters)
HistoryElement::RequestAllReviewsApproved.create(history_parameters)
# pre-approved requests can be processed
BsRequestAutoAcceptJob.perform_later(id) if approver
elsif new_request_state == :review
save!
elsif new_request_state == :declined
HistoryElement::RequestDeclined.create(history_parameters)
save!
end
end
end
def check_if_valid_review!(opts)
return if opts[:by_user] || opts[:by_group] || opts[:by_project]
raise InvalidReview
end
def create_new_review(opts)
newreview = reviews.create(
reason: opts[:comment],
by_user: opts[:by_user],
by_group: opts[:by_group],
by_project: opts[:by_project],
by_package: opts[:by_package],
creator: User.current.try(:login),
reviewer: User.current.try(:login)
)
return newreview if newreview.valid?
raise InvalidReview, 'Review invalid: ' + newreview.errors.full_messages.join("\n")
end
private :create_new_review
def addreview(opts)
with_lock do
permission_check_addreview!
check_if_valid_review!(opts)
self.state = 'review'
self.commenter = User.current.login
self.comment = opts[:comment] if opts[:comment]
newreview = create_new_review(opts)
save!
history_params = {
request: self,
user_id: User.current.id,
description_extension: newreview.id.to_s
}
history_params[:comment] = opts[:comment] if opts[:comment]
HistoryElement::RequestReviewAdded.create(history_params)
newreview.create_notification(notify_parameters)
end
end
def setpriority(opts)
permission_check_setpriority!
unless opts[:priority].in?(['low', 'moderate', 'important', 'critical'])
raise SaveError, "Illegal priority '#{opts[:priority]}'"
end
p = { request: self, user_id: User.current.id, description_extension: "#{priority} => #{opts[:priority]}" }
p[:comment] = opts[:comment] if opts[:comment]
self.priority = opts[:priority]
save!
reset_cache
HistoryElement::RequestPriorityChange.create(p)
end
def setincident(incident)
permission_check_setincident!(incident)
touched = false
# all maintenance_incident actions go into the same incident project
p = { request: self, user_id: User.current.id }
bs_request_actions.where(type: 'maintenance_incident').find_each do |action|
tprj = Project.get_by_name(action.target_project)
# use an existing incident
if tprj.is_maintenance?
tprj = Project.get_by_name(action.target_project + ':' + incident.to_s)
action.target_project = tprj.name
action.save!
touched = true
p[:description_extension] = tprj.name
end
end
return unless touched
save!
HistoryElement::RequestSetIncident.create(p)
end
def send_state_change
intermediate_state = ['new', 'review']
return if state_was.to_s == state.to_s
# new->review && review->new are not worth an event - it's just spam
return if state.to_s.in?(intermediate_state) && state_was.to_s.in?(intermediate_state)
Event::RequestStatechange.create(notify_parameters)
end
def notify_parameters(ret = {})
ret[:number] = number
ret[:description] = description
ret[:state] = state
ret[:oldstate] = state_was if state_changed?
ret[:who] = commenter if commenter.present?
ret[:when] = updated_when.strftime('%Y-%m-%dT%H:%M:%S')
ret[:comment] = comment
ret[:author] = creator
# Use a nested data structure to support multiple actions in one request
ret[:actions] = []
bs_request_actions[0..ACTION_NOTIFY_LIMIT].each do |a|
ret[:actions] << a.notify_params
end
ret
end
def review_matches_user?(review, user)
return false unless user
return user.login == review.by_user if review.by_user
return user.is_in_group?(review.by_group) if review.by_group
if review.by_project
p = nil
m = 'change_project'
if review.by_package
p = Package.find_by_project_and_name(review.by_project, review.by_package)
m = 'change_package'
else
p = Project.find_by_name(review.by_project)
end
return false unless p
return user.has_local_permission?(m, p)
end
false
end
def reviews_for_user_and_others(user)
user_reviews = []
other_open_reviews = []
reviews.where(state: 'new').find_each do |review|
if review_matches_user?(review, user)
user_reviews << review.webui_infos
else
other_open_reviews << review.webui_infos
end
end
[user_reviews, other_open_reviews]
end
def webui_infos(opts = {})
opts.reverse_merge!(diffs: true)
result = {}
result['id'] = id
result['number'] = number
result['description'] = description
result['priority'] = priority
result['state'] = state
result['creator'] = User.find_by_login(creator)
result['created_at'] = created_at
result['accept_at'] = accept_at if accept_at
result['superseded_by'] = superseded_by if superseded_by
result['superseding'] = superseding unless superseding.empty?
result['is_target_maintainer'] = is_target_maintainer?(User.current)
result['my_open_reviews'], result['other_open_reviews'] = reviews_for_user_and_others(User.current)
result['actions'] = webui_actions(opts)
result
end
def auto_accept
# do not run for processed requests. Ignoring review on purpose since this
# must also work when people do not react anymore
return unless state == :new || state == :review
# use approve mechanic in case you want to wait for reviews
return if approver && state == :review
with_lock do
User.current ||= User.find_by_login(creator) if accept_at
User.current = User.find_by_login(approver) if approver
begin
change_state(newstate: 'accepted', comment: 'Auto accept')
rescue BsRequestPermissionCheck::NotExistingTarget
change_state(newstate: 'revoked', comment: 'Target disappeared')
rescue PostRequestNoPermission
change_state(newstate: 'revoked', comment: 'Permission problem')
rescue APIError
change_state(newstate: 'declined', comment: 'Unhandled error during accept')
end
end
end
# Check if 'user' is maintainer in _all_ request targets:
def is_target_maintainer?(user = User.current)
has_target = false
is_target_maintainer = true
bs_request_actions.each do |a|
next unless a.target_project
if a.target_package
tpkg = Package.find_by_project_and_name(a.target_project, a.target_package)
if tpkg
has_target = true
is_target_maintainer &= user.can_modify?(tpkg)
next
end
end
tprj = Project.find_by_name(a.target_project)
if tprj
has_target = true
is_target_maintainer &= user.can_modify?(tprj)
end
end
has_target && is_target_maintainer
end
def sanitize!
# apply default values, expand and do permission checks
self.creator ||= User.current.login
self.commenter ||= User.current.login
# FIXME: Move permission checks to controller level
unless self.creator == User.current.login || User.current.is_admin?
raise SaveError, 'Admin permissions required to set request creator to foreign user'
end
unless self.commenter == User.current.login || User.current.is_admin?
raise SaveError, 'Admin permissions required to set request commenter to foreign user'
end
# ensure correct initial values, no matter what has been sent to us
self.state = :new
# expand release and submit request targets if not specified
expand_targets