File Coverage

blib/lib/LyricFinder/Lrclib.pm

Criterion	Covered	Total	%
statement	20	85	23.5
branch	0	30	0.0
condition	0	33	0.0
subroutine	7	10	70.0
pod	2	2	100.0
total	29	160	18.1

package LyricFinder::Lrclib;

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

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

my $Source = 'Lrclib';
my $Site   = 'https://lrclib.net';
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("Lrclib::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 = uri_escape_utf8($artist);
	$artist =~ s/\%20/\+/g;
	$artist =~ s/\%26/\&/g;
	$artist =~ s/\%28/\(/g;
	$artist =~ s/\%29/\)/g;
	$artist =~ s/\%3D/\=/g;
	my $song = $song_in;
	$song = uri_escape_utf8($song);
	$song =~ s/\%20/\+/g;
	$song =~ s/\%26/\&/g;
	$song =~ s/\%28/\(/g;
	$song =~ s/\%29/\)/g;
	$song =~ s/\%3D/\=/g;


	# Their URLs look like e.g.:
	# https://lrclib.net/api/get?artist_name=Borislav+Slavov&track_name=I+Want+to+Live
	$self->{'Url'} = $Site . "/api/get?artist_name=${artist}&track_name=$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;
}

# Internal use only functions:

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

	#NOTE: -synced: 'YES'(synced|plain), 'NO'(plain|bust), 'ONLY'(synced|bust), or 'OK'|''(plain|synced)!
	my $sync = (defined($self->{'-synced'}) && $self->{'-synced'}) ? $self->{'-synced'} : 'No';
	$sync = 'yES'  unless ($sync =~ /^(?:y|n|only|ok)/i);
	my $whichLyrics = ($sync !~ /^(?:NO|OK)/i) ? 'syncedLyrics' : 'plainLyrics';
	$self->_debug("Lrclib::_parse()!");
	my $lyrics;
	$html =~ s/\\\"/\x02QUOTE\x02/gs;  #PROTECT ESCAPED QUOTES FROM NEXT REGEX!:
	for my $i (0,1) {
		$lyrics = ($html =~ m/\,\"$whichLyrics\"\:\"([^\"]+)\"(?:\,\"|\})/s) ? $1 : undef;
		if (defined($lyrics) && length($lyrics) > 10)
		{
			my $text = '';
			# convert literal "\" followed by "r" or "n", etc. to "\r" or "\n" characters respectively:
			eval "\$text = \"$lyrics\";";
			$text =~ s/\x02QUOTE\x02/\"/gs;
			return $self->_normalize_lyric_text($self->_html2text($text));
		} elsif ($i || $sync =~ /^(?:NO|ONLY)/i) {
			carp($self->{'Error'} = "e:$Source - Failed to identify lyrics on result page.");
			return '';
		} else {
			$whichLyrics = ($sync =~ /^YES/i)
					? 'plainLyrics' : 'syncedLyrics';  #NO SYNCED LYRICS, TRY PLAIN-TEXT ONES:
		}
	}
}   # end of sub parse

1

__END__