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
|
package App::BorgRestore::DB;
use v5.14;
use strict;
use warnings;
use App::BorgRestore::Helper;
use autodie;
use DBI;
use Function::Parameters;
use Log::Any qw($log);
use Number::Bytes::Human qw(format_bytes);
use Path::Tiny;
=encoding utf-8
=head1 NAME
App::BorgRestore::DB - Database layer
=head1 DESCRIPTION
App::BorgRestore::DB abstracts the database storage used internally by L<App::BorgRestore>.
=cut
method new($class: $db_path, $cache_size) {
my $self = {};
bless $self, $class;
if ($db_path =~ /^:/) {
$self->_open_db($db_path);
$self->initialize_db();
} elsif (! -f $db_path) {
# ensure the cache directory exists
path($db_path)->parent->mkpath({mode => oct(700)});
$self->_open_db($db_path);
$self->initialize_db();
} else {
$self->_open_db($db_path);
}
$self->{cache_size} = $cache_size;
return $self;
}
method _open_db($dbfile) {
$log->debugf("Opening database at %s", $dbfile);
$self->{dbh} = DBI->connect("dbi:SQLite:dbname=$dbfile","","", {RaiseError => 1, Taint => 1});
$self->{dbh}->do("PRAGMA strict=ON");
}
method set_cache_size() {
$self->{dbh}->do("PRAGMA cache_size=-".$self->{cache_size});
}
method initialize_db() {
$log->debug("Creating initial database");
$self->{dbh}->do('create table `files` (`path` text, primary key (`path`)) without rowid;');
$self->{dbh}->do('create table `archives` (`archive_name` text unique);');
}
method get_archive_names() {
my @ret;
my $st = $self->{dbh}->prepare("select `archive_name` from `archives`;");
$st->execute();
while (my $result = $st->fetchrow_hashref) {
push @ret, $result->{archive_name};
}
return \@ret;
}
method get_archive_row_count() {
my $st = $self->{dbh}->prepare("select count(*) count from `files`;");
$st->execute();
my $result = $st->fetchrow_hashref;
return $result->{count};
}
method add_archive_name($archive) {
$archive = App::BorgRestore::Helper::untaint_archive_name($archive);
my $st = $self->{dbh}->prepare('insert into `archives` (`archive_name`) values (?);');
$st->execute($archive);
$self->_add_column_to_table("files", $archive);
}
method _add_column_to_table($table, $column) {
my $st = $self->{dbh}->prepare('alter table `'.$table.'` add column `'._prefix_archive_id($column).'` integer;');
$st->execute();
}
method remove_archive($archive) {
$archive = App::BorgRestore::Helper::untaint_archive_name($archive);
my $archive_id = $self->get_archive_id($archive);
my @keep_archives = grep {$_ ne $archive;} @{$self->get_archive_names()};
$self->{dbh}->do('create table `files_new` (`path` text, primary key (`path`)) without rowid;');
for my $archive (@keep_archives) {
$self->_add_column_to_table("files_new", $archive);
}
my @columns_to_copy = map {'`'._prefix_archive_id($_).'`'} @keep_archives;
@columns_to_copy = ('`path`', @columns_to_copy);
$self->{dbh}->do('insert into `files_new` select '.join(',', @columns_to_copy).' from files');
$self->{dbh}->do('drop table `files`');
$self->{dbh}->do('alter table `files_new` rename to `files`');
my $sql = 'delete from `files` where ';
$sql .= join(' is null and ', grep {$_ ne '`path`' } @columns_to_copy);
$sql .= " is null";
my $st = $self->{dbh}->prepare($sql);
my $rows = $st->execute();
$st = $self->{dbh}->prepare('delete from `archives` where `archive_name` = ?;');
$st->execute($archive);
}
fun _prefix_archive_id($archive) {
$archive = App::BorgRestore::Helper::untaint_archive_name($archive);
return 'timestamp-'.$archive;
}
method get_archive_id($archive) {
return _prefix_archive_id($archive);
}
method get_archives_for_path($path) {
my $st = $self->{dbh}->prepare('select * from `files` where `path` = ?;');
$st->execute(App::BorgRestore::Helper::untaint($path, qr(.*)));
my @ret;
my $result = $st->fetchrow_hashref;
my $archives = $self->get_archive_names();
for my $archive (@$archives) {
my $archive_id = $self->get_archive_id($archive);
my $timestamp = $result->{$archive_id};
push @ret, {
modification_time => $timestamp,
archive => $archive,
};
}
return \@ret;
}
method _insert_path($archive_id, $path, $time) {
my $st = $self->{dbh}->prepare_cached('insert or ignore into `files` (`path`, `'.$archive_id.'`)
values(?, ?)');
$st->execute($path, $time);
}
method add_path($archive_id, $path, $time) {
$self->_insert_path($archive_id, $path, $time);
my $st = $self->{dbh}->prepare_cached('update files set `'.$archive_id.'` = ? where `path` = ?');
$st->execute($time, $path);
}
method update_path_if_greater($archive_id, $path, $time) {
$self->_insert_path($archive_id, $path, $time);
my $st = $self->{dbh}->prepare_cached('update files set `'.$archive_id.'` = ? where `path` = ? and `'.$archive_id.'` < ?');
$st->execute($time, $path, $time);
}
method begin_work() {
$self->{dbh}->begin_work();
}
method commit() {
$self->{dbh}->commit();
}
method verify_cache_fill_rate_ok() {
my $used = $self->{dbh}->sqlite_db_status()->{cache_used}->{current};
$log->debugf("sqlite page cache usage: %s", format_bytes($used, si=>1));
if ($used > $self->{cache_size} * 1024 * 0.95) {
$log->debugf("sqlite cache usage is %s of %s", format_bytes($used, si=>1), format_bytes($self->{cache_size} * 1024, si => 1));
$log->debug("Consider increasing the sqlite cache if you notice performance issues (see documentation of App::BorgRestore::Settings)");
}
}
method search_path($pattern) {
$log->debugf("Preparing path search for pattern '%s'", $pattern);
my $st = $self->{dbh}->prepare('select path from files where path like ?');
$log->debug("Executing search");
$st->execute($pattern);
$log->debug("Fetching search result");
my @ret;
while (my $row = $st->fetchrow_hashref()) {
push @ret, $row->{path};
}
$log->debugf("Found %d matching paths", 0+@ret);
return \@ret;
}
method vacuum() {
$self->{dbh}->do("vacuum");
}
1;
__END__
|
