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
|
package LatexIndent::BackUpFileProcedure;
# 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 3 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.
#
# See http://www.gnu.org/licenses/.
#
# Chris Hughes, 2017
#
# For all communication, please visit: https://github.com/cmhughes/latexindent.pl
use strict;
use warnings;
use LatexIndent::GetYamlSettings qw/%mainSettings/;
use LatexIndent::Switches qw/%switches/;
use LatexIndent::LogFile qw/$logger/;
use File::Basename; # to get the filename and directory path
use File::Copy; # to copy the original file to backup (if overwrite option set)
use Exporter qw/import/;
our @EXPORT_OK = qw/create_back_up_file check_if_different/;
# copy main file to a back up in the case of the overwrite switch being active
sub create_back_up_file {
my $self = shift;
return unless ( ${$self}{overwrite} );
# if we want to over write the current file create a backup first
$logger->info("*Backup procedure (-w flag active):");
my $fileName = ${$self}{fileName};
# grab the file extension preferences
my %fileExtensionPreference = %{ $mainSettings{fileExtensionPreference} };
# sort the file extensions by preference
my @fileExtensions
= sort { $fileExtensionPreference{$a} <=> $fileExtensionPreference{$b} } keys(%fileExtensionPreference);
# backup file name is the base name
my $backupFile = basename( ${$self}{fileName}, @fileExtensions );
# add the user's backup directory to the backup path
$backupFile = "${$self}{cruftDirectory}/$backupFile";
# local variables, determined from the YAML settings
my $onlyOneBackUp = $mainSettings{onlyOneBackUp};
my $maxNumberOfBackUps = $mainSettings{maxNumberOfBackUps};
my $cycleThroughBackUps = $mainSettings{cycleThroughBackUps};
my $backupExtension = $mainSettings{backupExtension};
# if both ($onlyOneBackUp and $maxNumberOfBackUps) then we have
# a conflict- er on the side of caution and turn off onlyOneBackUp
if ( $onlyOneBackUp and $maxNumberOfBackUps > 1 ) {
$logger->warn("*onlyOneBackUp=$onlyOneBackUp and maxNumberOfBackUps: $maxNumberOfBackUps");
$logger->warn("setting onlyOneBackUp=0 which will allow you to reach $maxNumberOfBackUps back ups");
$onlyOneBackUp = 0;
}
# if the user has specified that $maxNumberOfBackUps = 1 then
# they only want one backup
if ( $maxNumberOfBackUps == 1 ) {
$onlyOneBackUp = 1;
$logger->info("you set maxNumberOfBackUps=1, so I'm setting onlyOneBackUp: 1 ");
}
elsif ( $maxNumberOfBackUps <= 0 and !$onlyOneBackUp ) {
$onlyOneBackUp = 0;
$maxNumberOfBackUps = -1;
}
# if onlyOneBackUp is set, then the backup file will
# be overwritten each time
if ($onlyOneBackUp) {
$backupFile .= $backupExtension;
$logger->info("copying $fileName to $backupFile");
$logger->info("$backupFile was overwritten (see onlyOneBackUp)") if ( -e $backupFile );
}
else {
# start with a backup file .bak0 (or whatever $backupExtension is present)
my $backupCounter = 0;
$backupFile .= $backupExtension . $backupCounter;
# if it exists, then keep going: .bak0, .bak1, ...
while ( -e $backupFile or $maxNumberOfBackUps > 1 ) {
if ( $backupCounter == $maxNumberOfBackUps ) {
$logger->info("maxNumberOfBackUps reached ($maxNumberOfBackUps, see maxNumberOfBackUps)");
# some users may wish to cycle through back up files, e.g:
# copy myfile.bak1 to myfile.bak0
# copy myfile.bak2 to myfile.bak1
# copy myfile.bak3 to myfile.bak2
#
# current back up is stored in myfile.bak4
if ($cycleThroughBackUps) {
$logger->info("cycleThroughBackUps detected (see cycleThroughBackUps) ");
for ( my $i = 1; $i <= $maxNumberOfBackUps; $i++ ) {
# remove number from backUpFile
my $oldBackupFile = $backupFile;
$oldBackupFile =~ s/$backupExtension.*/$backupExtension/;
my $newBackupFile = $oldBackupFile;
# add numbers back on
$oldBackupFile .= $i;
$newBackupFile .= $i - 1;
# check that the oldBackupFile exists
if ( -e $oldBackupFile ) {
$logger->info(" copying $oldBackupFile to $newBackupFile ");
my $backUpFilePossible = 1;
copy( $oldBackupFile, $newBackupFile ) or ( $backUpFilePossible = 0 );
if ( $backUpFilePossible == 0 ) {
$logger->fatal(
"*Could not write to backup file $backupFile. Please check permissions. Exiting.");
$logger->fatal("Exiting, no indendation done.");
$self->output_logfile();
exit(5);
}
}
}
}
# rest maxNumberOfBackUps
$maxNumberOfBackUps = 1;
last; # break out of the loop
}
elsif ( !( -e $backupFile ) ) {
$maxNumberOfBackUps = 1;
last; # break out of the loop
}
$logger->info(
"$backupFile already exists, incrementing by 1... (see maxNumberOfBackUps and onlyOneBackUp)");
$backupCounter++;
$backupFile =~ s/$backupExtension.*/$backupExtension$backupCounter/;
}
$logger->info("copying $fileName to $backupFile");
}
# output these lines to the log file
$logger->info("Backup file: $backupFile");
$logger->info("$fileName will be overwritten after indentation");
my $backUpFilePossible = 1;
copy( $fileName, $backupFile ) or ( $backUpFilePossible = 0 );
if ( $backUpFilePossible == 0 ) {
$logger->fatal("*Could not write to backup file $backupFile. Please check permissions.");
$logger->fatal("Exiting, no indendation done.");
$self->output_logfile();
exit(5);
}
}
sub check_if_different {
my $self = shift;
if ( ${$self}{originalBody} eq ${$self}{body} ) {
$logger->info("*-wd switch active");
$logger->info("Original body matches indented body, NOT overwriting, no back up files created");
return;
}
# otherwise, continue
$logger->info("*-wd switch active");
$logger->info("Original body is *different* from indented body");
$logger->info("activating overwrite switch, -w");
${$self}{overwrite} = 1;
$self->create_back_up_file;
}
1;
|
