Pflichtenhefte: Dokumentation; Refactoring; Bugfix Diff-Berechnung
[kivitendo-erp.git] / SL / Controller / RequirementSpecVersion.pm
1 package SL::Controller::RequirementSpecVersion;
2
3 use strict;
4
5 use parent qw(SL::Controller::Base);
6
7 use Carp;
8 use List::MoreUtils qw(any);
9
10 use SL::ClientJS;
11 use SL::DB::Customer;
12 use SL::DB::Project;
13 use SL::DB::RequirementSpec;
14 use SL::DB::RequirementSpecVersion;
15 use SL::Helper::Flash;
16 use SL::Locale::String;
17
18 use Rose::Object::MakeMethods::Generic
19 (
20   'scalar --get_set_init' => [ qw(requirement_spec version js versioned_copies) ],
21 );
22
23 __PACKAGE__->run_before('check_auth');
24
25 #
26 # actions
27 #
28
29 sub action_list {
30   my ($self, %params) = @_;
31
32   $self->render('requirement_spec_version/list', { layout => 0 });
33 }
34
35 sub action_new {
36   my ($self) = @_;
37
38   $self->version(SL::DB::RequirementSpecVersion->new);
39
40   my $previous_version = $self->requirement_spec->highest_version;
41   $::lxdebug->message(0, "vers num " . $previous_version->version->version_number . " id " . $previous_version->version_id);
42
43   if (!$previous_version) {
44     $self->version->description(t8('Initial version.'));
45
46   } else {
47     my %differences = $self->calculate_differences(current => $self->requirement_spec, previous => $previous_version);
48
49     my @lines;
50
51     my $fb_diff = $differences{function_blocks};
52     push @lines, t8('Added sections and function blocks: #1',   $::locale->language_join([ map { $_->fb_number         } @{ $fb_diff->{additions} } ])) if @{ $fb_diff->{additions} };
53     push @lines, t8('Changed sections and function blocks: #1', $::locale->language_join([ map { $_->fb_number         } @{ $fb_diff->{changes}   } ])) if @{ $fb_diff->{changes}   };
54     push @lines, t8('Removed sections and function blocks: #1', $::locale->language_join([ map { $_->fb_number         } @{ $fb_diff->{removals}  } ])) if @{ $fb_diff->{removals}  };
55
56     my $tb_diff = $differences{text_blocks};
57     push @lines, t8('Added text blocks: #1',                    $::locale->language_join([ map { '"' . $_->title . '"' } @{ $tb_diff->{additions} } ])) if @{ $tb_diff->{additions} };
58     push @lines, t8('Changed text blocks: #1',                  $::locale->language_join([ map { '"' . $_->title . '"' } @{ $tb_diff->{changes}   } ])) if @{ $tb_diff->{changes}   };
59     push @lines, t8('Removed text blocks: #1',                  $::locale->language_join([ map { '"' . $_->title . '"' } @{ $tb_diff->{removals}  } ])) if @{ $tb_diff->{removals}  };
60
61     $self->version->description(@lines ? join("\n", @lines) : t8('No changes since previous version.'));
62   }
63
64   $self->render('requirement_spec_version/new', { layout => 0 }, title => t8('Create a new version'));
65 }
66
67 sub action_create {
68   my ($self, %params) = @_;
69
70   my %attributes = %{ delete($::form->{rs_version}) || {} };
71   my @errors     = SL::DB::RequirementSpecVersion->new(%attributes, version_number => 1)->validate;
72
73   return $self->js->error(@errors)->render($self) if @errors;
74
75   my $db     = $self->requirement_spec->db;
76   my @result = $self->version($self->requirement_spec->create_version(%attributes));
77
78   if (!@result) {
79     $::lxdebug->message(LXDebug::WARN(), "Error: " . $db->error);
80     return $self->js->error($::locale->text('Saving failed. Error message from the database: #1'), $db->error)->render($self);
81   }
82
83   my $html = $self->render('requirement_spec/_version', { output => 0 }, requirement_spec => $self->requirement_spec);
84
85   $self->js
86     ->html('#requirement_spec_version', $html)
87     ->jqmClose('.jqmWindow')
88     ->render($self);
89 }
90
91 #
92 # filters
93 #
94
95 sub check_auth {
96   my ($self, %params) = @_;
97   $::auth->assert('sales_quotation_edit');
98 }
99
100 #
101 # helpers
102 #
103
104 sub init_requirement_spec {
105   my ($self) = @_;
106   $self->requirement_spec(SL::DB::RequirementSpec->new(id => $::form->{requirement_spec_id})->load) if $::form->{requirement_spec_id};
107 }
108
109 sub init_version {
110   my ($self) = @_;
111   $self->version(SL::DB::RequirementSpecVersion->new(id => $::form->{id})->load) if $::form->{id};
112 }
113
114 sub init_js {
115   my ($self, %params) = @_;
116   $self->js(SL::ClientJS->new);
117 }
118
119 sub init_versioned_copies {
120   my ($self) = @_;
121   $self->versioned_copies([
122     sort { $b->mtime <=> $a->mtime } @{ $self->requirement_spec->versioned_copies }
123   ]);
124 }
125
126 sub has_item_changed {
127   my ($previous, $current) = @_;
128   croak "Missing previous/current" if !$previous || !$current;
129
130   return 1 if any { ($previous->$_ || '') ne ($current->$_ || '') } qw(item_type fb_number title description complexity_id risk_id);
131   return 0 if !$current->parent_id;
132   return $previous->parent->fb_number ne $current->parent->fb_number;
133 }
134
135 sub has_text_block_changed {
136   my ($previous, $current) = @_;
137   croak "Missing previous/current" if !$previous || !$current;
138   return any { ($previous->$_ || '') ne ($current->$_ || '') } qw(title text);
139 }
140
141 sub compare_items {
142   return -1 if ($a->item_type eq 'section') && ($b->item_type ne 'section');
143   return +1 if ($a->item_type ne 'section') && ($b->item_type eq 'section');
144   return $a->fb_number cmp $b->fb_number;
145 }
146
147 sub calculate_differences {
148   my ($self, %params) = @_;
149
150   my %differences = (
151     function_blocks => {
152       additions => [],
153       changes   => [],
154       removals  => [],
155     },
156     text_blocks => {
157       additions => [],
158       changes   => [],
159       removals  => [],
160     },
161   );
162
163   return %differences if !$params{previous} || !$params{current};
164
165   my @previous_items                         = sort compare_items @{ $params{previous}->items };
166   my @current_items                          = sort compare_items @{ $params{current}->items  };
167
168   my @previous_text_blocks                   = sort { lc $a->title cmp lc $b->title } @{ $params{previous}->text_blocks };
169   my @current_text_blocks                    = sort { lc $a->title cmp lc $b->title } @{ $params{current}->text_blocks  };
170
171   my %previous_items_map                     = map { $_->fb_number => $_ } @previous_items;
172   my %current_items_map                      = map { $_->fb_number => $_ } @current_items;
173
174   my %previous_text_blocks_map               = map { $_->title     => $_ } @previous_text_blocks;
175   my %current_text_blocks_map                = map { $_->title     => $_ } @current_text_blocks;
176
177   $differences{function_blocks}->{additions} = [ grep { !$previous_items_map{ $_->fb_number }                                                                         } @current_items        ];
178   $differences{function_blocks}->{removals}  = [ grep { !$current_items_map{  $_->fb_number }                                                                         } @previous_items       ];
179   $differences{function_blocks}->{changes}   = [ grep {  $previous_items_map{ $_->fb_number }       && has_item_changed($previous_items_map{ $_->fb_number }, $_)     } @current_items        ];
180
181   $differences{text_blocks}->{additions}     = [ grep { !$previous_text_blocks_map{ $_->title }                                                                       } @current_text_blocks  ];
182   $differences{text_blocks}->{removals}      = [ grep { !$current_text_blocks_map{  $_->title }                                                                       } @previous_text_blocks ];
183   $differences{text_blocks}->{changes}       = [ grep {  $previous_text_blocks_map{ $_->title } && has_text_block_changed($previous_text_blocks_map{ $_->title }, $_) } @current_text_blocks  ];
184
185   return %differences;
186 }
187
188 1;