File Coverage

blib/lib/LyricFinder/ApiLyricsOvh.pm

Criterion	Covered	Total	%
statement	17	65	26.1
branch	0	18	0.0
condition	0	24	0.0
subroutine	6	9	66.6
pod	2	2	100.0
total	25	118	21.1

package LyricFinder::ApiLyricsOvh;

use strict;
use warnings;
use Carp;
use parent 'LyricFinder::_Class';

our $haveLyricsCache;
BEGIN {
	$haveLyricsCache = 0;
	eval "use LyricFinder::Cache; \$haveLyricsCache = 1; 1";
}

my $Source = 'ApiLyricsOvh';
my $Site   = 'https://api.lyrics.ovh';
my $DEBUG  = 0;

sub new
{
	my $class = shift;

	my $self = $class->SUPER::new($Source, @_);
	@{$self->{'_fetchers'}} = ($Source);
	unshift(@{$self->{'_fetchers'}}, 'Cache')  if ($haveLyricsCache
			&& $self->{'-cache'} && $self->{'-cache'} !~ /^\>/);
	bless $self, $class;   #BLESS IT!

	return $self;
}

sub fetch {
	my ($self, $artist_in, $song_in) = @_;

	$self->_debug("Letras::fetch($artist_in, $song_in)!");

	return ''  unless ($self->_check_inputs($artist_in, $song_in));
	return ''  if ($self->{'Error'} ne 'Ok');

	# first, see if we've got it cached:
	$self->_debug("i:haveCache=$haveLyricsCache= -cachedir=".$self->{'-cache'}."=");
	if ($haveLyricsCache && $self->{'-cache'} && $self->{'-cache'} !~ /^\>/) {
		my $cache = new LyricFinder::Cache(%{$self});
		if ($cache) {
			my $lyrics = $cache->fetch($artist_in, $song_in);
			if (defined($lyrics) && $lyrics =~ /\w/) {
				$self->_debug("..Got lyrics from cache.");
				$self->{'Source'} = 'Cache';
				$self->{'Site'} = $cache->site();
				$self->{'Url'} = $cache->url();

				return $lyrics;
			}
		}
	}

	$self->{'Site'} = $Site;

	(my $artist = $artist_in) =~ s#\s*\/.*$##;    #ONLY USE 1ST ARTIST, IF MORE THAN ONE!
	$artist =~ s/\s+/\%20/g;
	$artist =~ s/[^a-z0-9\%]//gi;

	(my $song = $song_in) =~ s/\s+/\%20/g;
	$song   =~ s/[^a-z0-9\%]//gi;

	# Their URLs look like e.g.:
	# https://api.lyrics.ovh/v1/Dire%20straits/heavy%sfuel%s
	$self->{'Url'} = "${Site}/v1/${artist}/$song";
	my $lyrics = $self->_web_fetch($artist_in, $song_in);
	if ($lyrics && $haveLyricsCache && $self->{'-cache'} && $self->{'-cache'} !~ /^\
		$self->_debug("=== WILL CACHE LYRICS! ===");
		# cache the fetched lyrics, if we can:
		my $cache = new LyricFinder::Cache(%{$self});
		$cache->save($artist_in, $song_in, $lyrics)  if ($cache);
	}
	return $lyrics;
}

sub _parse {
	my $self = shift;
	my $html = shift;

	$self->_debug("ApiLyricsOvh::_parse()!");
	if (my ($goodbit) = $html =~ m{\{\"lyrics\"\:\"([^\"]+)\"}msi)
	{
		my $text = '';
		# convert literal "\" followed by "r" or "n", etc. to "\r" or "\n" characters respectively:
		eval "\$text = \"$goodbit\";";

		# fix apparent site bug where they use "\n\n" where they appear to mean "\r\n" (excess double-lines):
		$text =~ s/\n\n/\n/gs;

		return $self->_normalize_lyric_text($self->_html2text($text));
	} else {
		carp($self->{'Error'} = "e:$Source - Failed to identify lyrics on result page.");
		return '';
	}
}

1

__END__