Imported Upstream version 3.3.0
[debian/amanda] / perl / Amanda / Taper / Scan / oldest.pm
1 # Copyright (c) 2010 Zmanda, Inc.  All Rights Reserved.
2 #
3 # This program is free software; you can redistribute it and/or modify it
4 # under the terms of the GNU General Public License version 2 as published
5 # by the Free Software Foundation.
6 #
7 # This program is distributed in the hope that it will be useful, but
8 # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
9 # or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
10 # for more details.
11 #
12 # You should have received a copy of the GNU General Public License along
13 # with this program; if not, write to the Free Software Foundation, Inc.,
14 # 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
15 #
16 # Contact information: Zmanda Inc., 465 S. Mathilda Ave., Suite 300
17 # Sunnyvale, CA 94085, USA, or: http://www.zmanda.com
18
19 package Amanda::Taper::Scan::oldest;
20
21 =head1 NAME
22
23 Amanda::Taper::Scan::oldest
24
25 =head1 SYNOPSIS
26
27 This package implements the "oldest" taperscan algorithm.  See
28 C<amanda-taperscan(7)>.
29
30 =cut
31
32 use strict;
33 use warnings;
34 use base qw( Amanda::ScanInventory Amanda::Taper::Scan );
35 use Amanda::Tapelist;
36 use Carp;
37 use POSIX ();
38 use Data::Dumper;
39 use vars qw( @ISA );
40 use base qw(Exporter);
41 our @EXPORT_OK = qw($DEFAULT_CHANGER);
42
43 use Amanda::Paths;
44 use Amanda::Util;
45 use Amanda::Device qw( :constants );
46 use Amanda::Debug qw( debug );
47 use Amanda::Changer;
48 use Amanda::MainLoop;
49 use Amanda::Interactivity;
50 use Amanda::Taper::Scan::traditional;
51
52 our $DEFAULT_CHANGER = {};
53
54 sub new {
55     my $class = shift;
56     my %params = @_;
57
58     my $chg = $params{'changer'};
59     if (!defined $chg) {
60         $chg = Amanda::Changer->new();
61         $params{'changer'} = $chg;
62     }
63     if (!$chg->have_inventory()) {
64         return Amanda::Taper::Scan::traditional->new(%params);
65     }
66     my $self = Amanda::ScanInventory->new(%params);
67     return bless ($self, $class);
68 }
69
70 sub most_prefered {
71     my $self = shift;
72     return $self->oldest_reusable_volume();
73 }
74
75 sub first_reusable_label {
76     my $self = shift;
77
78     my $label;
79
80     for my $tle (@{$self->{'tapelist'}->{'tles'}}) {
81         $label = $tle->{'label'} if $self->is_reusable_volume(label => $tle->{'label'});
82     }
83     return $label;
84 }
85
86 sub last_use_label {
87     my $self = shift;
88
89     my $tles = $self->{'tapelist'}->{tles};
90     my $label = $tles->[0]->{'label'};
91 }
92
93 sub analyze {
94     my $self = shift;
95     my $inventory  = shift;
96     my $seen  = shift;
97     my $res = shift;
98
99     my $most_prefered;
100     my @reusable;
101     my @new_labeled;
102     my $first_new_volume;
103     my $new_volume;
104     my @new_volume;
105     my $first_unknown;
106     my $unknown;
107     my $current;
108     my $label = $self->most_prefered();
109     $self->{'most_prefered_label'} = $label;
110
111     for my $i (0..(scalar(@$inventory)-1)) {
112         my $sl = $inventory->[$i];
113         if ($sl->{current}) {
114             $current = $sl;
115         }
116         next if $seen->{$sl->{slot}} and (!$res || $res->{'this_slot'} ne $sl->{'slot'});
117
118         if (!defined $sl->{'state'} ||
119             $sl->{'state'} == Amanda::Changer::SLOT_UNKNOWN) {
120             $first_unknown = $sl if !$first_unknown;
121             $unknown = $sl if $current && !$unknown;
122         } elsif ($sl->{'state'} == Amanda::Changer::SLOT_EMPTY) {
123         } elsif (defined $sl->{'label'}) {
124             if ($label && $sl->{'label'} eq $label) {
125                 $most_prefered = $sl;
126             } elsif ($self->is_reusable_volume(label => $sl->{'label'})) {
127                 push @reusable, $sl;
128             } else {
129                 my $vol_tle = $self->{'tapelist'}->lookup_tapelabel($sl->{'label'});
130                 if ($vol_tle) {
131                     if ($vol_tle->{'datestamp'} eq '0') {
132                         push @new_labeled, $sl;
133                     }
134                 } elsif ($self->{'chg'}->volume_is_labelable($sl->{'device_status'},
135                                                              $sl->{'f_type'},
136                                                              $sl->{'label'})) {
137                     $first_new_volume = $sl if !$first_new_volume;
138                     $new_volume = $sl if $current && !$new_volume;
139                     push @new_volume, $sl;
140                 }
141             }
142         } elsif ($self->{'chg'}->volume_is_labelable($sl->{'device_status'},
143                                                      $sl->{'f_type'},
144                                                      $sl->{'label'})) {
145             $first_new_volume = $sl if !$first_new_volume;
146             $new_volume = $sl if $current && !$new_volume;
147             push @new_volume, $sl;
148         } elsif (!defined($sl->{device_status}) && !defined($sl->{label})) {
149             $first_unknown = $sl if !$first_unknown;
150             $unknown = $sl if $current && !$unknown;
151         } else {
152         }
153     }
154     $unknown = $first_unknown if !defined $unknown;
155     $new_volume = $first_new_volume if !defined $new_volume;
156
157     my $first_label = $self->first_reusable_label();
158     my $last_label = $self->last_use_label();
159
160     my $reusable;
161     for my $sl (@reusable) {
162         my $tle = $self->{'tapelist'}->lookup_tapelabel($sl->{'label'});
163         $sl->{'datestamp'} = $tle->{'datestamp'};
164         $reusable = $sl if !defined $reusable or
165                            $sl->{'datestamp'} < $reusable->{'datestamp'};
166     }
167
168     my $new_labeled;
169     for my $sl (@new_labeled) {
170         $new_labeled = $sl if !defined $new_labeled or
171                               (!$last_label and
172                                $sl->{'label'} lt $new_labeled->{'label'}) or
173                               ($last_label and
174                                $sl->{'label'} gt $last_label and
175                                $sl->{'label'} lt $new_labeled->{'label'}) or
176                               ($last_label and
177                                $sl->{'label'} gt $last_label and
178                                $new_labeled->{'label'} lt $last_label) or
179                               ($last_label and
180                                $new_labeled->{'label'} lt $last_label and
181                                $sl->{'label'} lt $new_labeled->{'label'});
182     }
183
184     for my $sl (@new_volume) {
185         $sl->{'label'} = $self->{'chg'}->make_new_tape_label(
186                                         barcode => $sl->{'barcode'},
187                                         meta => $sl->{'meta'});
188         $new_volume = $sl if defined $last_label and
189                              $new_volume->{'label'} ne $sl->{'label'} and
190                              (($sl->{'label'} gt $last_label and
191                                $sl->{'label'} lt $new_volume->{'label'}) or
192                               ($sl->{'label'} gt $last_label and
193                                $new_volume->{'label'} lt $last_label) or
194                               ($new_volume->{'label'} lt $last_label and
195                                $sl->{'label'} lt $new_volume->{'label'}));
196     }
197
198     my $use;
199     if ($new_labeled && $self->{'scan_conf'}->{'new_labeled'} eq 'soon') {
200         $use = $new_labeled;
201     } elsif ($new_volume && $self->{'scan_conf'}->{'new_volume'} eq 'soon') {
202         $use = $new_volume;
203     } elsif ($new_labeled &&
204               $self->{'scan_conf'}->{'new_labeled'} eq 'order' and
205               (!$label || !$first_label || !$last_label || !$most_prefered or
206                ($last_label and $most_prefered and
207                 $new_labeled->{'label'} gt $last_label and
208                 $new_labeled->{'label'} lt $most_prefered->{'label'}) or
209                ($last_label and $most_prefered and
210                 $new_labeled->{'label'} gt $last_label and
211                 $most_prefered->{'label'} lt $last_label) or
212                ($first_label and $most_prefered and
213                 $new_labeled->{'label'} lt $first_label and
214                 $new_labeled->{'label'} lt $most_prefered->{'label'}))) {
215         $use = $new_labeled;
216     } elsif ($new_volume and
217              $self->{'scan_conf'}->{'new_volume'} eq 'order' and
218              (!$label || !$first_label || !$last_label || !$most_prefered or
219               ($last_label and $most_prefered and
220                $new_volume->{'label'} gt $last_label and
221                $new_volume->{'label'} lt $most_prefered->{'label'}) or
222               ($last_label and $most_prefered and
223                $new_volume->{'label'} gt $last_label and
224                $most_prefered->{'label'} lt $last_label) or
225               ($first_label and $most_prefered and
226                $new_volume->{'label'} lt $first_label and
227                $new_volume->{'label'} lt $most_prefered->{'label'}))) {
228         $use = $new_volume;
229     } elsif (defined $most_prefered) {
230         $use = $most_prefered;
231     } elsif (defined $reusable) {
232         $use = $reusable;
233     } elsif ($new_labeled and $self->{'scan_conf'}->{'new_labeled'} eq 'last') {
234         $use = $new_labeled;
235     } elsif ($new_volume and $self->{'scan_conf'}->{'new_volume'} eq 'last') {
236         $use = $new_volume;
237     }
238
239     if ($use) {
240         if (defined $res and $res->{'this_slot'} eq $use->{'slot'}) {
241             return (Amanda::ScanInventory::SCAN_DONE);
242         } else {
243             return (Amanda::ScanInventory::SCAN_LOAD,
244                     $use->{'slot'});
245         }
246     } elsif ($unknown and $self->{'scan_conf'}->{'scan'}) {
247         return (Amanda::ScanInventory::SCAN_LOAD,
248                 $unknown->{'slot'});
249     } elsif ($self->{'scan_conf'}->{'ask'}) {
250         return (Amanda::ScanInventory::SCAN_ASK_POLL);
251     } else {
252         return (Amanda::ScanInventory::SCAN_FAIL);
253     }
254 }
255
256 1;