| 1 | package Makerelease::Step; | ||
| 2 | |||
| 3 | use strict; | ||
| 4 | use Makerelease; | ||
| 5 | |||
| 6 | our $VERSION = '0.1'; | ||
| 7 | |||
| 8 | our @ISA=qw(Makerelease); | ||
| 9 | |||
| 10 | sub start_step { | ||
| 11 | my ($self, $step) = @_; | ||
| 12 | } | ||
| 13 | |||
| 14 | sub possibly_skip_yn { | ||
| 15 | my ($self, $step, $parentstep, $counter) = @_; | ||
| 16 | |||
| 17 | if ($self->{'opts'}{'n'}) { | ||
| 18 | $self->output("(Pause here to ensure the operator wishes to perform the step)"); | ||
| 19 | return 1; | ||
| 20 | } | ||
| 21 | if ($self->{'opts'}{'i'} || $step->{'interactive'}) { | ||
| 22 | my $info = $self->getinput("Do step $parentstep$counter (y,n,q)?"); | ||
| 23 | if ($info eq 'q') { | ||
| 24 | $self->output("... quitting as requested\n"); | ||
| 25 | exit; | ||
| 26 | } | ||
| 27 | if ($info eq 'n') { | ||
| 28 | $self->output("... skipping step $parentstep$counter\n"); | ||
| 29 | return 1; | ||
| 30 | } | ||
| 31 | } | ||
| 32 | return 0; | ||
| 33 | } | ||
| 34 | |||
| 35 | sub possibly_skip_dryrun { | ||
| 36 | my ($self, $step, $parentstep, $counter) = @_; | ||
| 37 | if ($self->{'opts'}{'n'}) { | ||
| 38 | $self->document_step($step, $parentstep, $counter); | ||
| 39 | return 1; | ||
| 40 | } | ||
| 41 | return 0; | ||
| 42 | } | ||
| 43 | |||
| 44 | # return 1 to skip, 0 to do it | ||
| 45 | sub possibly_skip { | ||
| 46 | my $self = shift; | ||
| 47 | |||
| 48 | my ($step, $parentstep, $counter) = @_; | ||
| 49 | |||
| 50 | # handle -n | ||
| 51 | return 1 if ($self->possibly_skip_dryrun(@_)); | ||
| 52 | |||
| 53 | # handle mandatory steps | ||
| 54 | return 0 if ($step->{'mandatory'}); | ||
| 55 | |||
| 56 | # handle -i | ||
| 57 | return $self->possibly_skip_yn(@_); | ||
| 58 | |||
| 59 | return 0; | ||
| 60 | } | ||
| 61 | |||
| 62 | sub print_description { | ||
| 63 | my ($self, $step) = @_; | ||
| 64 | my $text = $self->expand_text($step->{'text'}); | ||
| 65 | $text =~ s/\n\s*$//g; | ||
| 66 | $self->output($text, "\n\n") if ($text); | ||
| 67 | } | ||
| 68 | |||
| 69 | sub finish_step { | ||
| 70 | my ($self, $step, $parentstep, $counter) = @_; | ||
| 71 | |||
| 72 | # do nothing on a dry-run | ||
| 73 | return if ($self->{'opts'}{'n'}); | ||
| 74 | |||
| 75 | # maybe sleep if we're not pausing | ||
| 76 | if (!$step->{'pause'}) { | ||
| 77 | sleep($self->{'opts'}{'S'}) if ($self->{'opts'}{'S'}); | ||
| 78 | return; | ||
| 79 | } | ||
| 80 | |||
| 81 | # pause display | ||
| 82 | my $info = $self->getinput("---- PRESS ENTER TO CONTINUE (q=quit) ----"); | ||
| 83 | if ($info eq 'q') { | ||
| 84 | $self->output("Quitting...\n"); | ||
| 85 | exit; | ||
| 86 | } | ||
| 87 | } | ||
| 88 | |||
| 89 | sub document_step { | ||
| 90 | } | ||
| 91 | |||
| 92 | sub expand_parameters { | ||
| 93 | my ($self, $string) = @_; | ||
| 94 | |||
| 95 | return $string if ($self->{'opts'}{'n'}); | ||
| 96 | # ignore {} sets with a leading $ | ||
| 97 | $string =~ s/([^\$]){([^\}]+)}/$1$self->{'parameters'}{$2}/g; | ||
| 98 | return $string; | ||
| 99 | } | ||
| 100 | |||
| 101 | # also tries to clean up newline->spaces blocks | ||
| 102 | sub expand_text { | ||
| 103 | my ($self, $string) = @_; | ||
| 104 | |||
| 105 | $string = $self->expand_parameters($string); | ||
| 106 | $string =~ s/^\s*//; | ||
| 107 | $string =~ s/([^\n\r])\r*\n[ \t]+/$1 /gm; | ||
| 108 | $string =~ s/\r*\n\r*\n[ \t]+/\n\n/gm; | ||
| 109 | $string =~ s/\s*$//; | ||
| 110 | return $string; | ||
| 111 | } | ||
| 112 | |||
| 113 | sub test { | ||
| 114 | my ($self) = @_; | ||
| 115 | return 0; | ||
| 116 | } | ||
| 117 | |||
| 118 | sub WARN { | ||
| 119 | my ($self, $step, @args) = @_; | ||
| 120 | use Data::Dumper;; | ||
| 121 | print STDERR "WARNING: step: '$step->{'title'}'\n"; | ||
| 122 | print STDERR "WARNING: " . join("",@args) . "\n\n"; | ||
| 123 | return 1; | ||
| 124 | } | ||
| 125 | |||
| 126 | sub require_piece { | ||
| 127 | my ($self, $step, $parentstep, $counter, $nametop, $namebot) = @_; | ||
| 128 | return $self->WARN($step, "No '$nametop' element in this step") | ||
| 129 | if (!exists($step->{$nametop}) || | ||
| 130 | ref($step->{$nametop}) ne 'ARRAY' || | ||
| 131 | $#{$step->{$nametop}} == -1); | ||
| 132 | return 0 if (!$namebot); | ||
| 133 | return $self->WARN($step, "No '$namebot' element inside '${nametop}' in this step") | ||
| 134 | if (!exists($step->{$nametop}[0]{$namebot}) || | ||
| 135 | ref($step->{$nametop}[0]{$namebot}) ne 'ARRAY' || | ||
| 136 | $#{$step->{$nametop}[0]{$namebot}} == -1); | ||
| 137 | return 0; | ||
| 138 | } | ||
| 139 | |||
| 140 | sub require_attribute { | ||
| 141 | my ($self, $step, $parentstep, $counter, $nametop, $namebot) = @_; | ||
| 142 | return $self->WARN($step, "No '$nametop' attribute in this step") | ||
| 143 | if (!exists($step->{$nametop}) || | ||
| 144 | ref($step->{$nametop}) eq 'ARRAY'); | ||
| 145 | return 0; | ||
| 146 | } | ||
| 147 | |||
| 148 | 1; | ||
| 149 |