[app-musicexpo.git] / lib / App / MusicExpo.pm

package App::MusicExpo 0.001;
use v5.14;
use strict;
use warnings;

use Audio::FLAC::Header qw//;
use HTML::Entities qw/encode_entities/;
use HTML::Template::Compiled qw//;
use Memoize qw/memoize/;
use MP3::Tag qw//;
use URI::Escape qw/uri_escape/;

use DB_File qw//;
use File::Basename qw/fileparse/;
use Fcntl qw/O_RDWR O_CREAT/;
use Getopt::Long;
use Storable qw/thaw freeze/;

##################################################

my $default_template;

our $prefix='/music/';
our $cache='cache.db';
our $caching=1;
our $template='';

GetOptions (
  "template=s" => \$template,
  "prefix=s" => \$prefix,
  "cache=s" => \$cache,
  "caching!" => \$caching,
);


sub fix{
  utf8::decode($_[0]);
  encode_entities($_[0])
}

sub flacinfo{
  my $file=$_[0];
  my $flac=Audio::FLAC::Header->new($file);
  $file = $prefix . uri_escape scalar fileparse $file;

  freeze +{
	format => 'FLAC',
	title => fix ($flac->tags('TITLE') // '?'),
	artist => fix ($flac->tags('ARTIST') // '?'),
	year => fix ($flac->tags('DATE') // '?'),
	album => fix ($flac->tags('ALBUM') // '?'),
	tracknumber => fix ($flac->tags('TRACKNUMBER') // '?'),
	tracktotal => fix ($flac->tags('TRACKTOTAL') // '?'),
	genre => fix ($flac->tags('GENRE') // '?'),
	path => $file,
  }
}

sub mp3info{
  my $file=$_[0];
  my $mp3=MP3::Tag->new($file);
  $file = $prefix . uri_escape scalar fileparse $file;

  freeze +{
	format => 'MP3',
	title => fix ($mp3->title || '?'),
	artist => fix ($mp3->artist || '?'),
	year => fix ($mp3->year || '?'),
	album => fix ($mp3->album || '?'),
	tracknumber => fix ($mp3->track1 || '?'),
	tracktotal => fix ($mp3->track2 || '?'),
	genre => fix ($mp3->genre) || '?',
	path => $file,
  }
}

sub normalizer{
  "$_[0]|".(stat $_[0])[9]
}

sub run {
  tie my %cache, 'DB_File', $cache, O_RDWR|O_CREAT, 0644 if $caching;
  memoize 'flacinfo', NORMALIZER => \&normalizer, LIST_CACHE => 'MERGE', SCALAR_CACHE => [HASH => \%cache] if $caching;
  memoize 'mp3info' , NORMALIZER => \&normalizer, LIST_CACHE => 'MERGE', SCALAR_CACHE => [HASH => \%cache] if $caching;

  my @files;
  for my $file (@ARGV) {
	push @files, thaw flacinfo $file if $file =~ /.flac$/i;
	push @files, thaw mp3info $file if $file =~ /.mp3$/i;
  }

  my $ht=HTML::Template::Compiled->new( $template eq '' ? (scalarref => \$default_template) : (filename => $template));
  $ht->param(files=>[sort { $a->{title} cmp $b->{title} } @files]);
  print $ht->output;
}

$default_template = <<'HTML';
<!DOCTYPE html>
<title>Music</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/music.css">

<table border>
<thead>
<tr><th>Title<th>Artist<th>Album<th>Genre<th>Track<th>Year<th>Type
<tbody><tmpl_loop files>
<tr><td><a href="<tmpl_var path>"><tmpl_var title></a><td><tmpl_var artist><td><tmpl_var album><td><tmpl_var genre><td><tmpl_var tracknumber>/<tmpl_var tracktotal><td><tmpl_var year><td><tmpl_var format></tmpl_loop>
</table>
HTML

1;

__END__

=head1 NAME

App::MusicExpo - script which generates a HTML table of music tags

=head1 SYNOPSIS

  use App::MusicExpo;
  App::MusicExpo->run;

=head1 DESCRIPTION

App::MusicExpo creates a HTML table from a list of songs.

The default template looks like:

    | Title   | Artist  | Album           | Genre   | Track | Year | Type |
    |---------+---------+-----------------+---------+-------+------+------|
    | Cellule | Silence | L'autre endroit | Electro | 01/09 | 2005 | FLAC |

where the title is a download link.

=head1 OPTIONS

=over

=item B<--template> I<template>

Path to the HTML::Template::Compiled template used for generating the music table. If '' (empty), uses the default format. Is empty by default.

=item B<--prefix> I<prefix>

Prefix for download links. Defaults to '/music/'.

=item B<--cache> I<filename>

Path to the cache file. Created if it does not exist. Defaults to 'cache.db'

=item B<--caching>, B<--no-caching>

Enables or disables caching. Defaults to B<--caching>

=back

=head1 AUTHOR

Marius Gavrilescu, E<lt>marius@ieval.roE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2013 by Marius Gavrilescu

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.14.2 or,
at your option, any later version of Perl 5 you may have available.
Commit	Line	Data
21cd9240 MG	1	package App::MusicExpo 0.001;
21cd9240 MG	2	use v5.14;
75c564d8	3	use strict;
21cd9240 MG	4	use warnings;
	5
	6	use Audio::FLAC::Header qw//;
	7	use HTML::Entities qw/encode_entities/;
	8	use HTML::Template::Compiled qw//;
	9	use Memoize qw/memoize/;
	10	use MP3::Tag qw//;
	11	use URI::Escape qw/uri_escape/;
	12
	13	use DB_File qw//;
	14	use File::Basename qw/fileparse/;
	15	use Fcntl qw/O_RDWR O_CREAT/;
	16	use Getopt::Long;
	17	use Storable qw/thaw freeze/;
	18
	19	##################################################
	20
75c564d8 MG	21	my $default_template;
75c564d8 MG	22
21cd9240 MG	23	our $prefix='/music/';
	24	our $cache='cache.db';
	25	our $caching=1;
75c564d8	26	our $template='';
21cd9240 MG	27
	28	GetOptions (
	29	"template=s" => \$template,
	30	"prefix=s" => \$prefix,
	31	"cache=s" => \$cache,
	32	"caching!" => \$caching,
	33	);
	34
	35
	36	sub fix{
	37	utf8::decode($_[0]);
	38	encode_entities($_[0])
	39	}
	40
	41	sub flacinfo{
	42	my $file=$_[0];
	43	my $flac=Audio::FLAC::Header->new($file);
	44	$file = $prefix . uri_escape scalar fileparse $file;
	45
	46	freeze +{
	47	format => 'FLAC',
	48	title => fix ($flac->tags('TITLE') // '?'),
	49	artist => fix ($flac->tags('ARTIST') // '?'),
	50	year => fix ($flac->tags('DATE') // '?'),
	51	album => fix ($flac->tags('ALBUM') // '?'),
	52	tracknumber => fix ($flac->tags('TRACKNUMBER') // '?'),
	53	tracktotal => fix ($flac->tags('TRACKTOTAL') // '?'),
	54	genre => fix ($flac->tags('GENRE') // '?'),
	55	path => $file,
	56	}
	57	}
	58
	59	sub mp3info{
	60	my $file=$_[0];
	61	my $mp3=MP3::Tag->new($file);
	62	$file = $prefix . uri_escape scalar fileparse $file;
	63
	64	freeze +{
	65	format => 'MP3',
	66	title => fix ($mp3->title \|\| '?'),
	67	artist => fix ($mp3->artist \|\| '?'),
	68	year => fix ($mp3->year \|\| '?'),
	69	album => fix ($mp3->album \|\| '?'),
	70	tracknumber => fix ($mp3->track1 \|\| '?'),
	71	tracktotal => fix ($mp3->track2 \|\| '?'),
	72	genre => fix ($mp3->genre) \|\| '?',
	73	path => $file,
	74	}
	75	}
	76
	77	sub normalizer{
	78	"$_[0]\|".(stat $_[0])[9]
	79	}
	80
	81	sub run {
	82	tie my %cache, 'DB_File', $cache, O_RDWR\|O_CREAT, 0644 if $caching;
	83	memoize 'flacinfo', NORMALIZER => \&normalizer, LIST_CACHE => 'MERGE', SCALAR_CACHE => [HASH => \%cache] if $caching;
	84	memoize 'mp3info' , NORMALIZER => \&normalizer, LIST_CACHE => 'MERGE', SCALAR_CACHE => [HASH => \%cache] if $caching;
	85
	86	my @files;
	87	for my $file (@ARGV) {
	88	push @files, thaw flacinfo $file if $file =~ /.flac$/i;
	89	push @files, thaw mp3info $file if $file =~ /.mp3$/i;
	90	}
91
75c564d8	92	my $ht=HTML::Template::Compiled->new( $template eq '' ? (scalarref => \$default_template) : (filename => $template));
21cd9240 MG	93	$ht->param(files=>[sort { $a->{title} cmp $b->{title} } @files]);
	94	print $ht->output;
	95	}
	96
75c564d8 MG	97	$default_template = <<'HTML';
	98	<!DOCTYPE html>
	99	<title>Music</title>
	100	<meta charset="utf-8">
	101	<link rel="stylesheet" href="/music.css">
	102
	103	<table border>
	104	<thead>
	105	<tr><th>Title<th>Artist<th>Album<th>Genre<th>Track<th>Year<th>Type
	106	<tbody><tmpl_loop files>
	107	<tr><td><a href="<tmpl_var path>"><tmpl_var title></a><td><tmpl_var artist><td><tmpl_var album><td><tmpl_var genre><td><tmpl_var tracknumber>/<tmpl_var tracktotal><td><tmpl_var year><td><tmpl_var format></tmpl_loop>
	108	</table>
	109	HTML
	110
21cd9240 MG	111	1;
	112
	113	__END__
	114
	115	=head1 NAME
	116
	117	App::MusicExpo - script which generates a HTML table of music tags
	118
	119	=head1 SYNOPSIS
	120
	121	use App::MusicExpo;
	122	App::MusicExpo->run;
	123
	124	=head1 DESCRIPTION
	125
	126	App::MusicExpo creates a HTML table from a list of songs.
	127
	128	The default template looks like:
	129
	130	\| Title \| Artist \| Album \| Genre \| Track \| Year \| Type \|
	131	\|---------+---------+-----------------+---------+-------+------+------\|
	132	\| Cellule \| Silence \| L'autre endroit \| Electro \| 01/09 \| 2005 \| FLAC \|
	133
	134	where the title is a download link.
	135
	136	=head1 OPTIONS
	137
	138	=over
	139
	140	=item B<--template> I<template>
	141
75c564d8	142	Path to the HTML::Template::Compiled template used for generating the music table. If '' (empty), uses the default format. Is empty by default.
21cd9240 MG	143
	144	=item B<--prefix> I<prefix>
	145
	146	Prefix for download links. Defaults to '/music/'.
	147
	148	=item B<--cache> I<filename>
	149
	150	Path to the cache file. Created if it does not exist. Defaults to 'cache.db'
	151
	152	=item B<--caching>, B<--no-caching>
	153
	154	Enables or disables caching. Defaults to B<--caching>
	155
	156	=back
	157
	158	=head1 AUTHOR
	159
	160	Marius Gavrilescu, E<lt>marius@ieval.roE<gt>
	161
	162	=head1 COPYRIGHT AND LICENSE
	163
	164	Copyright (C) 2013 by Marius Gavrilescu
	165
	166	This library is free software; you can redistribute it and/or modify
	167	it under the same terms as Perl itself, either Perl version 5.14.2 or,
	168	at your option, any later version of Perl 5 you may have available.