File Coverage

blib/lib/LyricFinder/AZLyrics.pm

Criterion	Covered	Total	%
statement	20	69	28.9
branch	0	18	0.0
condition	0	24	0.0
subroutine	7	10	70.0
pod	2	2	100.0
total	29	123	23.5

package LyricFinder::AZLyrics;

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

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

my $Source = 'AZLyrics';
my $Site   = 'https://www.azlyrics.com';
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("AZLyrics::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/[^a-z0-9]//gi;
	(my $song = $song_in) =~ s/[^a-z0-9]//gi;

	# Their URLs look like e.g.:
	# https://www.azlyrics.com/lyrics/direstraits/heavyfuel
	$self->{'Url'} = $Site . '/lyrics/'
			. join('/', lc $artist, lc $song) . '.html';

	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;
}

# Internal use only functions:

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

	$self->_debug("AZLyrics::_parse()!");
	if (my ($goodbit) = $html =~
			m{our licensing agreement. Sorry about that. \-\-\>(.+?)\<\/div\>}msi)
	{
		# Scoop out any credits for these lyrics:
		while ($html =~ s{Thanks\s+to\s+(.+)}{}xi) {
			(my $creditlist = $1) =~ s/\s+for\b.+$//o;
			push @{$self->{'Credits'}}, split(/\,\s*/, $creditlist);
		}

		my $hs   = HTML::Strip->new();
		my $text = $hs->parse($goodbit);

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

1

__END__