File Coverage

blib/lib/LyricFinder/Cache.pm

Criterion	Covered	Total	%
statement	12	84	14.2
branch	0	28	0.0
condition	0	6	0.0
subroutine	4	9	44.4
pod	4	4	100.0
total	20	131	15.2

package LyricFinder::Cache;

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

my $Source = 'Cache';

sub new
{
	my $class = shift;

	my $self = $class->SUPER::new($Source, @_);
	@{$self->{'_fetchers'}} = ($Source);

	bless $self, $class;   #BLESS IT!

	return $self;
}

sub site {
	my $self = shift;

	return 'none'  unless ($self->{'-cache'});
	return 'file://'.$self->{'-cache'};
}

# Allow user to specify a different user-agent:
sub fetch {
	my $self = shift;
	my ($artist, $song) = @_;

	$self->_debug("i:CACHE::fetch($artist, $song)!");
	# reset the error var, change it if an error occurs.
	$self->{'Error'} = 'Ok';
	$self->{'Url'} = '';

	unless ($artist && $song) {
		carp($self->{'Error'} = 'e:Cache.fetch() called without artist and song!');
		return;
	}

	unless ($self->{'-cache'}) {
		carp($self->{'Error'} = 'e:Cache.fetch() called without a cache directory specified!');
		return;
	}

	if ($self->{'-cache'} =~ /^\>/) {
		carp($self->{'Error'} = 'e:Cache.fetch() called but cache directory writeonly (">" specified)!');
		return;
	}

	$artist =~ s#\s*\/.*$##;  #ONLY USE 1ST ARTIST, IF MORE THAN ONE!

	# Their URLs look like e.g.:
	#https://www.musixmatch.com/lyrics/Artist-name/Title

	my $LOCALDIR = $self->{'-cache'};
	$LOCALDIR =~ s#^\<##;          #STRIP OFF ANY LEADING DIRECTIONAL INDICATOR.
	$LOCALDIR =~ s#\\#\/#g;        #DE-DOSIFY WINDOWS FNS.
	$LOCALDIR .= '/'  unless ($LOCALDIR =~ m#\/#);
	$LOCALDIR =~ s#^file\:\/\/##;  #CONVERT TO FILE IF URI

	unless (-d "$LOCALDIR") {
		carp($self->{'Error'} = 'e:Cache.fetch() called but cache directory not a valid directory');
		return;
	}

	$self->{'Url'} = $LOCALDIR . '/' . $artist . '/' . $song . '.lrc';
	if (-f $self->{'Url'} && open (IN, $self->{'Url'})) {
		my $lyrics = '';
		while () {
			$lyrics .= $_;
		}
		close IN;
		$lyrics = $self->_parse($lyrics);
		return $lyrics;
	} else {
		$self->{'Error'} = 'e:Cache - Lyrics not found';
		return;
	}
}

sub save {
	my ($self, $artist, $song, $lyrics) = @_;

	$self->_debug('i:CACHE::save('.$self->{'-cache'}.')!');
	return 0  if ($self->{'-cache'} =~ /^\

	my $LOCALDIR = $self->{'-cache'};
	$LOCALDIR =~ s#^\>##;
	$LOCALDIR =~ s#\\#\/#g;       #DE-DOSIFY WINDOWS FNS.
	$LOCALDIR .= '/'  unless ($LOCALDIR =~ m#\/$#);
	$LOCALDIR =~ s#^file\:\/\/##; #CONVERT TO FILE IF URI
	if (-d "$LOCALDIR") {
		(my $artistDir = $LOCALDIR . $artist) =~ s/([\&])/\\$1/g;
		mkdir "$artistDir"  unless (-d $artistDir);
		if (-d "$artistDir") {
			(my $songFid = $LOCALDIR . $artist . '/' . $song . '.lrc') =~ s/([\&])/\\$1/g;
			$self->_debug("------songFid=$songFid=");
			if (open OUT, ">$songFid")
			{
				print OUT $lyrics;
				$self->_debug("------WROTE IT!!!------\n");
				close OUT;
				return 1;
			}
			else
			{
				carp($self->{'Error'} = "e:$Source - Could not cache lyrics for ($artist, $song) to ($songFid) (could not open file: $!)!");
			}
		}
		else
		{
			carp($self->{'Error'} = "e:$Source - Could not cache lyrics for ($artist, $song) dir ($artistDir) still does not exist?!");
		}
	} else {
		carp($self->{'Error'} = "e:$Source - Could not cache lyrics for ($artist, $song): $LOCALDIR is not a directory!");
	}
	return 0;
}

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

	$self->_debug("i:CACHE::_parse()!\n");
	if ($text =~ /\w/) {
		return $self->_normalize_lyric_text($text);
	} else {
		carp($self->{'Error'} = "e:$Source - Failed to identify lyrics in cache.");
		return;
	}
}

1

__END__