| 1 |
=head1 NAME |
| 2 |
|
| 3 |
Canary::Stability - canary to check perl compatibility for schmorp's modules |
| 4 |
|
| 5 |
=head1 SYNOPSIS |
| 6 |
|
| 7 |
# in Makefile.PL |
| 8 |
use Canary::Stability DISTNAME => 2001, MINIMUM_PERL_VERSION; |
| 9 |
|
| 10 |
=head1 DESCRIPTION |
| 11 |
|
| 12 |
This module is used by Schmorp's modules during configuration stage to |
| 13 |
test the installed perl for compatibility with his modules. |
| 14 |
|
| 15 |
It's not, at this stage, meant as a tool for other module authors, |
| 16 |
although in principle nothing prevents them from subscribing to the same |
| 17 |
ideas. |
| 18 |
|
| 19 |
See the F<Makefile.PL> in L<Coro> or L<AnyEvent> for usage examples. |
| 20 |
|
| 21 |
=cut |
| 22 |
|
| 23 |
package Canary::Stability; |
| 24 |
|
| 25 |
BEGIN { |
| 26 |
$VERSION = 2012; |
| 27 |
} |
| 28 |
|
| 29 |
sub sgr { |
| 30 |
# we just assume ANSI almost everywhere |
| 31 |
# red 31, yellow 33, green 32 |
| 32 |
local $| = 1; |
| 33 |
|
| 34 |
$ENV{PERL_CANARY_STABILITY_COLOUR} ne 0 |
| 35 |
and ((-t STDOUT and length $ENV{TERM}) or $ENV{PERL_CANARY_STABILITY_COLOUR}) |
| 36 |
and print "\e[$_[0]m"; |
| 37 |
} |
| 38 |
|
| 39 |
sub import { |
| 40 |
my (undef, $distname, $minvers, $minperl) = @_; |
| 41 |
|
| 42 |
$ENV{PERL_CANARY_STABILITY_DISABLE} |
| 43 |
and return; |
| 44 |
|
| 45 |
$minperl ||= 5.008002; |
| 46 |
|
| 47 |
print <<EOF; |
| 48 |
|
| 49 |
*** |
| 50 |
*** Canary::Stability COMPATIBILITY AND SUPPORT CHECK |
| 51 |
*** ================================================= |
| 52 |
*** |
| 53 |
*** Hi! |
| 54 |
*** |
| 55 |
*** I do my best to provide predictable and reliable software. |
| 56 |
*** |
| 57 |
*** However, in recent releases, P5P (who maintain perl) have been |
| 58 |
*** introducing regressions that are sometimes subtle and at other times |
| 59 |
*** catastrophic, often for personal preferences with little or no concern |
| 60 |
*** for existing code, most notably CPAN. |
| 61 |
*** |
| 62 |
*** For this reason, it has become very hard for me to maintain the level |
| 63 |
*** of reliability and support I have committed myself to in the past, at |
| 64 |
*** least with some perl versions: I simply can't keep up working around new |
| 65 |
*** bugs or gratituous incompatibilities, and in turn you might suffer from |
| 66 |
*** unanticipated problems. |
| 67 |
*** |
| 68 |
*** Therefore I have introduced a support and compatibility check, the results |
| 69 |
*** of which follow below, together with a FAQ and some recommendations. |
| 70 |
*** |
| 71 |
*** This check is just to let you know that there might be a risk, so you can |
| 72 |
*** make judgement calls on how to proceed - it will not keep the module from |
| 73 |
*** installing or working. |
| 74 |
*** |
| 75 |
EOF |
| 76 |
|
| 77 |
if ($minvers > $VERSION) { |
| 78 |
sgr 33; |
| 79 |
print <<EOF; |
| 80 |
*** The stability canary says: (nothing, it died of old age). |
| 81 |
*** |
| 82 |
*** Your Canary::Stability module (used by $distname) is too old. |
| 83 |
*** This is not a fatal problem - while you might want to upgrade to version |
| 84 |
*** $minvers (currently installed version: $VERSION) to get better support |
| 85 |
*** status testing, you might also not want to care at all, and all will |
| 86 |
*** be well as long $distname works well enough for you, as the stability |
| 87 |
*** canary is only used when installing the distribution. |
| 88 |
EOF |
| 89 |
} elsif ($] < $minperl) { |
| 90 |
|
| 91 |
sgr 33; |
| 92 |
print <<EOF; |
| 93 |
*** The stability canary says: chirp (it seems concerned about something). |
| 94 |
*** |
| 95 |
*** Your perl version ($]) is older than the $distname distribution |
| 96 |
*** likes ($minperl). This is not a fatal problem - the module might work |
| 97 |
*** well with your version of perl, but it does mean the author likely |
| 98 |
*** won't do anything to make it work if it breaks. |
| 99 |
EOF |
| 100 |
} elsif (defined $Internals::StabilityBranchVersion) { |
| 101 |
# note to people studying this modules sources: |
| 102 |
# the above test is not considered a clean or stable way to |
| 103 |
# test for the stability branch. |
| 104 |
|
| 105 |
sgr 32; |
| 106 |
print <<EOF; |
| 107 |
*** The stability canary says: chirp! chirp! (it seems to be quite excited) |
| 108 |
*** |
| 109 |
*** It seems you are running schmorp's stability branch of perl. |
| 110 |
*** All should be well, and if it isn't, you should report this as a bug |
| 111 |
*** to the $distname author. |
| 112 |
EOF |
| 113 |
} elsif ($] < 5.021) { |
| 114 |
#sgr 32; |
| 115 |
print <<EOF; |
| 116 |
*** The stability canary says: chirp! chirp! (it seems to be quite happy) |
| 117 |
*** |
| 118 |
*** Your version of perl ($]) is quite supported by $distname, nothing |
| 119 |
*** else to be said, hope it comes in handy. |
| 120 |
EOF |
| 121 |
} else { |
| 122 |
sgr 31; |
| 123 |
print <<EOF; |
| 124 |
*** The stability canary says: (nothing, it was driven away by harsh weather) |
| 125 |
*** |
| 126 |
*** It seems you are running perl version $], likely the "official" or |
| 127 |
*** "standard" version. While there is nothing wrong with doing that, |
| 128 |
*** standard perl versions 5.022 and up are not supported by $distname. |
| 129 |
*** While this might be fatal, it might also be all right - if you run into |
| 130 |
*** problems, you might want to downgrade your perl or switch to the |
| 131 |
*** stability branch. |
| 132 |
*** |
| 133 |
*** If everything works fine, you can ignore this message. |
| 134 |
EOF |
| 135 |
sgr 0; |
| 136 |
print <<EOF; |
| 137 |
*** |
| 138 |
*** Stability canary mini-FAQ: |
| 139 |
*** |
| 140 |
*** Do I need to do anything? |
| 141 |
*** With luck, no. While some distributions are known to fail |
| 142 |
*** already, most should probably work. This message is here |
| 143 |
*** to alert you that your perl is not supported by $distname, |
| 144 |
*** and if things go wrong, you either need to downgrade, or |
| 145 |
*** sidegrade to the stability variant of your perl version, |
| 146 |
*** or simply live with the consequences. |
| 147 |
*** |
| 148 |
*** What is this canary thing? |
| 149 |
*** It's purpose is to check support status of $distname with |
| 150 |
*** respect to your perl version. |
| 151 |
*** |
| 152 |
*** What is this "stability branch"? |
| 153 |
*** It's a branch or fork of the official perl, by schmorp, to |
| 154 |
*** improve stability and compatibility with existing modules. |
| 155 |
*** |
| 156 |
*** How can I skip this prompt on automated installs? |
| 157 |
*** Set PERL_CANARY_STABILITY_NOPROMPT=1 in your environment. |
| 158 |
*** More info is in the Canary::Stability manpage. |
| 159 |
*** |
| 160 |
*** Long version of this FAQ: http://stableperl.schmorp.de/faq.html |
| 161 |
*** Stability Branch homepage: http://stableperl.schmorp.de/ |
| 162 |
*** |
| 163 |
|
| 164 |
EOF |
| 165 |
|
| 166 |
unless ($ENV{PERL_CANARY_STABILITY_NOPROMPT}) { |
| 167 |
require ExtUtils::MakeMaker; |
| 168 |
|
| 169 |
ExtUtils::MakeMaker::prompt ("Continue anyways? ", "y") =~ /^y/i |
| 170 |
or die "FATAL: User aborted configuration of $distname.\n"; |
| 171 |
} |
| 172 |
} |
| 173 |
|
| 174 |
sgr 0; |
| 175 |
} |
| 176 |
|
| 177 |
=head1 ENVIRONMENT VARIABLES |
| 178 |
|
| 179 |
=over 4 |
| 180 |
|
| 181 |
=item C<PERL_CANARY_STABILITY_NOPROMPT=1> |
| 182 |
|
| 183 |
Do not prompt the user on alert messages. |
| 184 |
|
| 185 |
=item C<PERL_CANARY_STABILITY_COLOUR=0> |
| 186 |
|
| 187 |
Disable use of colour. |
| 188 |
|
| 189 |
=item C<PERL_CANARY_STABILITY_COLOUR=1> |
| 190 |
|
| 191 |
Force use of colour. |
| 192 |
|
| 193 |
=item C<PERL_CANARY_STABILITY_DISABLE=1> |
| 194 |
|
| 195 |
Disable this modules functionality completely. |
| 196 |
|
| 197 |
=back |
| 198 |
|
| 199 |
=head1 AUTHOR |
| 200 |
|
| 201 |
Marc Lehmann <schmorp@schmorp.de> |
| 202 |
http://software.schmorp.de/pkg/Canary-Stability.html |
| 203 |
|
| 204 |
=cut |
| 205 |
|
| 206 |
1 |
| 207 |
|
