Codit/Plugins/Backups.pm untested

filter: Statementstmt 0.0% 0 / 134 Branchbran 0.0% 0 / 50 Conditioncond 0.0% 0 / 9 MC/DCmcdc 0.0% 0 / 6 Subroutinesub 0.0% 0 / 23 Podpod 0.0% 0 / 16 totaltotal 0.0% 0 / 238 CC 26 SCAR 25.5
CC
26
Cov
0%
backupCheck
42.0
openDocBefore
20.0
backupExists
12.0
CRAP 12.8
1 package App::Codit::Plugins::Backups;
2  
3 =head1 NAME
4  
5 App::Codit::Plugins::Backups - plugin for App::Codit
6  
7 =cut
8  
9 use strict;
10 use warnings;
11 use Carp;
12 use vars qw( $VERSION );
13 $VERSION = '0.19';
14  
15 use File::Basename;
16 use File::Path qw(make_path);
17  
18 use base qw( Tk::AppWindow::BaseClasses::PluginJobs );
19  
20 =head1 DESCRIPTION
21  
22 Protect yourself against crashes. This plugin keeps backups of your unsaved files.
23  
24 =head1 DETAILS
25  
26 The Backups plugin protects you against crashes of all kinds.
27 It silently does it's job in the background and only reports when it
28 finds an existing backup of a file you open.
29  
30 It keeps backups of all open and unsaved files. Whenever a file is saved or closed
31 the backup is removed.
32  
33 It keeps the backups in the configuration folder, it does not pollute your working folders.
34  
35 =cut
36  
37 sub new {
38 my $class = shift;
39 my $self = $class->SUPER::new(@_);
40 return undef unless defined $self;
41
42 $self->interval(1000);
43 $self->{MODIFIED} = {};
44 $self->{ACTIVE} = {};
45
46 $self->cmdHookBefore('deferred_open', 'openDocBefore', $self);
47 $self->cmdHookAfter('doc_close', 'closeDocAfter', $self);
48 $self->cmdHookBefore('doc_rename', 'docRenameBefore', $self);
49 $self->cmdHookAfter('doc_save', 'saveDocAfter', $self);
50  
51 $self->backupFolder;
52 return $self;
53 }
54  
55 sub backupCheck {
56 my ($self, $name) = @_;
57 croak 'Name not defined' unless defined $name;
58 my $mdi = $self->extGet('CoditMDI');
59  
60 unless ($mdi->docExists($name)) {
61 $self->jobEnd($name);
62 return
63 }
64  
65 my $mod = $self->{MODIFIED};
66  
67 if ($mdi->docModified($name)) {
68 my $widg = $mdi->docGet($name)->CWidg;
69 my $em = $widg->editModified;
70 my $modified = $mod->{$name};
71  
72 if (defined $modified) {
73 $self->backupSave($name) if $em ne $modified
74 } else {
75 $self->backupSave($name);
76 }
77  
78 $mod->{$name} = $em;
79 } else {
80 $self->backupRemove($name);
81 }
82 }
83  
84 sub backupExists {
85 my ($self, $name) = @_;
86 croak 'Name not defined' unless defined $name;
87 my @list = $self->backupList;
88 for (@list) {
89 return 1 if $_ eq $name
90 }
91 return 0;
92 }
93  
94 sub backupFile {
95 my ($self, $name) = @_;
96 croak 'Name not defined' unless defined $name;
97 $name =~ s/^\///;
98 $name =~ s/\//_-_/g;
99 return $self->backupFolder . "/$name";
100 }
101  
102 sub backupFolder {
103 my $self = shift;
104 my $config = $self->extGet('ConfigFolder')->ConfigFolder . '/Backups';
105 make_path($config) unless -e $config;
106 return $config
107 }
108  
109 sub backupList {
110 my $self = shift;
111 my $folder = $self->backupFolder;
112 my @names = ();
113 if (opendir my $dh, $folder) {
114 while (my $file = readdir $dh) {
115 push @names, $self->backupName($file);
116 }
117 closedir $dh
118 }
119 return @names
120 }
121  
122 sub backupName {
123 my ($self, $file) = @_;
124 croak 'Name not defined' unless defined $file;
125 $file =~ s/_-_/\//g;
126 $file = "/$file";
127 return $file
128 }
129  
130 sub backupRemove {
131 my ($self, $name) = @_;
132 croak 'Name not defined' unless defined $name;
133 my $file = $self->backupFile($name);
134 unlink $file if -e $file;
135 }
136  
137 sub backupRestore {
138 my ($self, $name) = @_;
139 croak 'Name not defined' unless defined $name;
140 my $file = $self->backupFile($name);
141 my $mdi = $self->extGet('CoditMDI');
142 my $widg = $mdi->docGet($name)->CWidg;
143 if ($widg->load($file)) {
144 $widg->editModified(1);
145 return 1
146 }
147 return 0
148 }
149  
150 sub backupSave {
151 my ($self, $name) = @_;
152 croak 'Name not defined' unless defined $name;
153 my $file = $self->backupFile($name);
154 my $mdi = $self->extGet('CoditMDI');
155 my $widg = $mdi->docGet($name)->CWidg;
156 $widg->saveExport($file);
157 return 0;
158 }
159  
160 sub closeDocAfter {
161 my ($self, $name) = @_;
162 if ((defined $name) and $name) {
163 $self->jobEnd($name) if $self->jobExists($name);
164 $self->backupRemove($name);
165 }
166 }
167  
168 sub docRenameBefore {
169 my ($self, $name, $new) = @_;
170 croak 'Name not defined' unless defined $name;
171 croak 'New name not defined' unless defined $new;
172 $self->jobEnd($name);
173 $self->jobStart($new, 'backupCheck', $self, $new);
174 }
175  
176 sub openDocBefore {
177 my ($self, $name) = @_;
178 if ((defined $name) and $name) {
179 if ($self->backupExists($name)) {
180 my $title = 'Backup exists';
181 my $text = 'A backup for ' . basename($name) . " exists.\nDo you want to recover?";
182 my $icon = 'dialog-question';
183 my $response = $self->popDialog($title, $text, $icon, qw/Yes No/);
184 $self->after(300, ['backupRestore', $self, $name]) if $response eq 'Yes';
185 }
186 $self->jobStart($name, 'backupCheck', $self, $name)
187 }
188 }
189  
190 sub saveDocAfter {
191 my ($self, $name) = @_;
192 if ((defined $name) and $name) {
193 $self->backupRemove($name);
194 delete $self->{MODIFIED}->{$name};
195 }
196 }
197  
198 sub Quit {
199 my $self = shift;
200 for ($self->jobList) { $self->jobEnd($_) }
201 }
202  
203 sub Unload {
204 my $self = shift;
205 $self->cmdUnhookBefore('deferred_open', 'openDocBefore', $self);
206 $self->cmdUnhookAfter('doc_close', 'closeDocAfter', $self);
207 $self->cmdUnhookBefore('doc_rename', 'docRenameBefore', $self);
208 $self->cmdUnhookAfter('doc_save', 'saveDocAfter', $self);
209 return $self->SUPER::Unload;
210 }
211  
212 =head1 LICENSE
213  
214 Same as Perl.
215  
216 =head1 AUTHOR
217  
218 Hans Jeuken (hanje at cpan dot org)
219  
220 =head1 TODO
221  
222 =over 4
223  
224 =back
225  
226 =head1 BUGS AND CAVEATS
227  
228 If you find any bugs, please report them here L<https://github.com/haje61/App-Codit/issues>.
229  
230 =head1 SEE ALSO
231  
232 =over 4
233  
234 =back
235  
236 =cut
237  
238 1;
239  
240  
241  
242  
243  
244  
245  
246  
247  
248  
249  
250  
251  
252  
253  
254