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 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
|
package Pandoc::Release;
use 5.014;
use warnings;
our $VERSION = '0.9.2';
use HTTP::Tiny;
use JSON::PP;
use Cwd;
use File::Path qw(make_path remove_tree);
use File::Copy 'move';
use File::Temp 'tempdir';
use Pandoc;
use Pandoc::Version;
use parent 'Exporter';
our @EXPORT = qw(get list latest);
=head1 NAME
Pandoc::Release - get pandoc releases from GitHub
=cut
our $CLIENT = HTTP::Tiny->new( { verify_SSL => 1 } );
sub _api_request {
my ( $url, %opts ) = @_;
say $url if $opts{verbose};
my %headers =
$opts{token} ? ( Authorization => "token $opts{token}" ) : ();
my $res = $CLIENT->get( $url, { headers => \%headers } );
$res->{success} or die "failed to fetch $url";
$res->{content} = JSON::PP::decode_json( $res->{content} );
$res;
}
sub get {
shift if __PACKAGE__ eq ( $_[0] // '' ); # can also be used as method
my ( $version, %opts ) = @_;
warn "Pandoc release 1.17 had a bug, please don't use!\n"
if "$version" eq "1.17";
my $url = "https://api.github.com/repos/jgm/pandoc/releases/tags/$version";
bless _api_request( $url, %opts )->{content}, __PACKAGE__;
}
sub list {
shift if __PACKAGE__ eq ( $_[0] // '' ); # can also be used as method
my %opts = @_;
my $range = $opts{range};
my $limit = $opts{limit} // -1;
my $since = Pandoc::Version->new( $opts{since} // 0 );
my $url = "https://api.github.com/repos/jgm/pandoc/releases";
my @releases;
LOOP: while ($url) {
my $res = _api_request( $url, %opts );
foreach ( @{ $res->{content} } ) {
my $version = Pandoc::Version->new( $_->{tag_name} );
last LOOP unless $since < $version; # abort if possible
next if $version == '1.17'; # version had a bug
if ( !$range || $version->fulfills($range) ) {
push @releases, bless $_, __PACKAGE__;
last LOOP if --$limit == 0;
}
}
my $link = $res->{headers}{link} // '';
$link =~ /<([^>]+)>; rel="next"/ or last;
$url = $1;
}
@releases;
}
sub latest {
shift if __PACKAGE__ eq ( $_[0] // '' ); # can also be used as method
( list( @_, limit => 1 ) )[0];
}
sub download {
my ( $self, %opts ) = @_;
my $version = Pandoc::Version->new( $self->{tag_name} );
my $bin = $opts{bin} // pandoc_data_dir('bin');
if ($bin) {
make_path($bin);
-d $bin or die "missing directory $bin";
$bin = "$bin/pandoc-$version";
if ( -f $bin ) {
say "skipping existing $bin" if $opts{verbose};
my $pandoc = Pandoc->new($bin);
$pandoc = $pandoc->symlink( $opts{symlink}, %opts )
if exists $opts{symlink};
return $pandoc;
}
}
my $arch = $opts{arch} // `dpkg --print-architecture`;
chomp $arch;
my $dir = $opts{dir} // tempdir( CLEANUP => 1 );
my ($asset) = grep { $_->{name} =~ /-$arch\.deb$/ } @{ $self->{assets} };
my $url = ( $asset // {} )->{browser_download_url} or do {
say "release $self->{tag_name} contains no $arch Debian package"
if $opts{verbose};
return;
};
make_path($dir);
-d $dir or die "missing directory $dir";
my $deb = "$dir/" . $asset->{name};
say $deb if $CLIENT->mirror( $url, $deb )->{success} and $opts{verbose};
if ($bin) {
my $cmd =
"dpkg --fsys-tarfile '$deb'"
. "| tar -x ./usr/bin/pandoc -O > '$bin'"
. "&& chmod +x '$bin'";
system($cmd) and die "failed to extract pandoc from $deb:\n $cmd";
say $bin if $opts{verbose};
my $pandoc = Pandoc->new($bin);
$pandoc = $pandoc->symlink( $opts{symlink}, %opts )
if exists $opts{symlink};
return $pandoc;
}
else {
return $version;
}
}
1;
__END__
=head1 SYNOPSIS
From command line:
# print latest release name
perl -MPandoc::Release -E 'say latest->{name}'
# download latest release unless already in ~/.pandoc/bin
perl -MPandoc::Release -E 'latest->download'
# download specific release and create symlink ~/.pandoc/bin/pandoc
perl -MPandoc::Release -E 'get("2.7.3")->download->symlink'
In Perl code:
use Pandoc::Release;
my $release = get('2.1.3'); # get a specific release
my $latest = latest; # get a latest release
# get multiple releases
my @releases = list( since => '2.0', verbose => 1 );
foreach my $release (@releases) {
# print version number
say $release->{tag_name};
# download Debian package and executable
$release->download( dir => './deb', bin => './bin' );
}
# download executable and use as temporary Pandoc object:
my $pandoc = get('2.1.3)->download( bin => './bin' );
=head1 DESCRIPTION
This utility module fetches information about pandoc releases via GitHub API.
On Debian-bases systems, this module can update and switch locally installed
pandoc versions if you add directory C<~/.pandoc/bin> to your C<$PATH>.
See L<pandoc-version> for a command line script that makes use of this module.
=head1 FUNCTIONS
All functions are exported by default.
=head2 get( $version, %options )
Get a specific release by its version or die if the given version does not
exist. Returns data as returned by GitHub releases API:
L<https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name>.
=head2 list( %options )
Get a list of all pandoc releases, optionally C<since> some version or
within a version C<range> such as C<!=1.16, <=1.17> or C<==2.1.2>. See
L<CPAN::Meta::Spec/Version Ranges> for possible values. Option C<verbose> will
print URLs before each request. Option C<limit> limits the maximum number
of releases to be returned.
=head2 latest( %options )
Get the latest release, optionally C<since> some version or within a version
C<range>. Equivalent to method C<list> with option C<< limit => 1 >>.
=head1 METHODS
=head2 download( %options )
Download the Debian release file for some architecture (e.g. C<amd64>) Pandoc
executables is then extracted to directory C<bin> named by pandoc version
number (e.g. C<pandoc-2.1.2>). Skips downloading if an executable of this name
is already found there. Returns a L<Pandoc> instance if C<bin> is not false or
L<Pandoc::Version> otherwise. Additional options:
=over
=item dir
Where to download release files to. A temporary directory is used by default.
=item arch
System architecture, detected with C<dpkg --print-architecture> by default.
=item bin
Where to extract pandoc binary to. By default set to C<~/.pandoc/bin> on Unix
(see L<Pandoc> function C<pandoc_data_dir>). Extraction of executables can be
disabled by setting C<bin> to a false value.
=item symlink
Create a symlink to the executable. This is just a shortcut for calling function
C<symlink> of L<Pandoc>:
$release->download( verbose => $v )->symlink( $l, verbose => $v )
$release->download( verbose => $v, symlink => $l ) # equivalent
=back
=head1 COMMON OPTIONS
=over
=item verbose
Print what's going on (disabled by default).
=item token
L<GitHub token|https://github.com/settings/tokens> to avoid rate limiting.
=back
=head1 SEE ALSO
L<Pandoc::Version>
L<https://developer.github.com/v3/repos/releases/>
=cut
|