[mythtv-users] add season and episode number to mythlink.pl
Andre Ross
andre.ross at sbcglobal.net
Sun Nov 18 22:44:34 UTC 2012
Hi
This is how I added Season/Episode to mythlink.pl I made a copy of
this script and added a few changes it works for my but looking for
feedback.
mythlink.pl is a Perl script (written by Chris Peterson) for creating human-readable symlinks to MythTV recordings.
http://www.mythtv.org/wiki/Mythlink.pl
This
is a code change (I call it a hack) that I added to this this great
script to allow me to pull Episode / Season Numbers and include them as
part of my symlinks.
Mythtv .024 and above now stores episode and season numbers in the database for tv shows.
If you want to change the metadata of recordings:
http://www.mythtv.org/wiki/Enhancing_Recordings_with_Metadata_Lookup
Episode # and season # should be filled by the xmltv grabber. But you can manually edit it.
Becuase I like to use Plex to access my tvshows when I travel I like my symlinks formated
ShowName/Season##/ShowName-S##E##-EpisodeName
And
I like to have each tv show to create a symlink after each recording so
I put this command in userjob #1 in mythtv and marked it to run after
each recording.
/home/user/mythlink.pl --link
"/var/lib/mythtv/videos/TVShows" --filename "%FILE%" --format "%T/Season
%qs2/%T-S%qs2E%qe2-%S" --separator "#"
This is the location I found the mythlink.pl Perl script (written by Chris Peterson)
http://www.cuymedia.com/mythtv-trunk/mythlink_8pl_source.html
My code changes are found in one section of the code and marked by and easy to find.
#Start of Hack
#End of Hack
I'm hoping someone with better coding skills will review and update my script.
FileName: mythlink.pl
#!/usr/bin/perl -w
#
# Creates symlinks to mythtv recordings using more-human-readable filenames.
# See --help for instructions.
#
# Automatically detects database settings from mysql.txt, and loads
# the mythtv recording directory from the database (code from nuvexport).
#
# @url $URL$
# @date $Date$
# @version $Revision$
# @author $Author$
# @license GPL
#
# Includes
use DBI;
use Getopt::Long;
use File::Path;
use File::Basename;
use File::Find;
use MythTV;
#use Data::Dumper;
# Some variables we'll use here
our ($dest, $format, $usage, $underscores, $live, $rename, $maxlength);
our ($chanid, $starttime, $filename);
our ($dformat, $dseparator, $dreplacement, $separator, $replacement);
our ($db_host, $db_user, $db_name, $db_pass, $video_dir, $verbose);
our ($hostname, $dbh, $sh, $q, $count, $base_dir);
# Default filename format
$dformat = '%T %- %Y-%m-%d, %g-%i %A %- %S';
# Default separator character
$dseparator = '-';
# Default replacement character
$dreplacement = '-';
# Provide default values for GetOptions
$format = $dformat;
$separator = $dseparator;
$replacement = $dreplacement;
$maxlength = -1;
# Load the cli options
GetOptions('link|destination|path:s' => \$dest,
'chanid=s' => \$chanid,
'starttime=s' => \$starttime,
'filename=s' => \$filename,
'format=s' => \$format,
'live' => \$live,
'separator=s' => \$separator,
'replacement=s' => \$replacement,
'rename' => \$rename,
'maxlength=i' => \$maxlength,
'usage|help' => \$usage,
'underscores' => \$underscores,
'verbose' => \$verbose
);
# Print usage
if ($usage) {
print <<EOF;
$0 usage:
options:
--link [destination directory]
--destination [destination directory]
--path [destination directory]
Specify the directory for the links. If no pathname is given, links will
be created in the show_names directory inside of the current mythtv data
directory on this machine. eg:
/var/video/show_names/
WARNING: ALL symlinks within the destination directory and its
subdirectories (recursive) will be removed.
--chanid chanid
Create a link only for the specified recording file. Use with --starttime
to specify a recording. This argument may be used with the event-driven
notification system's "Recording started" event or in a post-recording
user job.
--starttime starttime
Create a link only for the specified recording file. Use with --chanid
to specify a recording. This argument may be used with the event-driven
notification system's "Recording started" event or in a post-recording
user job.
--filename absolute_filename
Create a link only for the specified recording file. This argument may be
used with the event-driven notification system's "Recording started" event
or in a post-recording user job.
--live
Include live tv recordings.
default: do not link live tv recordings
--format
default: $dformat
\%T = Title (show name)
\%S = Subtitle (episode name)
\%R = Description
\%C = Category
\%U = RecGroup
\%hn = Hostname of the machine where the file resides
\%c = Channel: MythTV chanid
\%cn = Channel: channum
\%cc = Channel: callsign
\%cN = Channel: channel name
\%y = Recording start time: year, 2 digits
\%Y = Recording start time: year, 4 digits
\%n = Recording start time: month
\%m = Recording start time: month, leading zero
\%j = Recording start time: day of month
\%d = Recording start time: day of month, leading zero
\%g = Recording start time: 12-hour hour
\%G = Recording start time: 24-hour hour
\%h = Recording start time: 12-hour hour, with leading zero
\%H = Recording start time: 24-hour hour, with leading zero
\%i = Recording start time: minutes
\%s = Recording start time: seconds
\%a = Recording start time: am/pm
\%A = Recording start time: AM/PM
\%ey = Recording end time: year, 2 digits
\%eY = Recording end time: year, 4 digits
\%en = Recording end time: month
\%em = Recording end time: month, leading zero
\%ej = Recording end time: day of month
\%ed = Recording end time: day of month, leading zero
\%eg = Recording end time: 12-hour hour
\%eG = Recording end time: 24-hour hour
\%eh = Recording end time: 12-hour hour, with leading zero
\%eH = Recording end time: 24-hour hour, with leading zero
\%ei = Recording end time: minutes
\%es = Recording end time: seconds
\%ea = Recording end time: am/pm
\%eA = Recording end time: AM/PM
\%py = Program start time: year, 2 digits
\%pY = Program start time: year, 4 digits
\%pn = Program start time: month
\%pm = Program start time: month, leading zero
\%pj = Program start time: day of month
\%pd = Program start time: day of month, leading zero
\%pg = Program start time: 12-hour hour
\%pG = Program start time: 24-hour hour
\%ph = Program start time: 12-hour hour, with leading zero
\%pH = Program start time: 24-hour hour, with leading zero
\%pi = Program start time: minutes
\%ps = Program start time: seconds
\%pa = Program start time: am/pm
\%pA = Program start time: AM/PM
\%pey = Program end time: year, 2 digits
\%peY = Program end time: year, 4 digits
\%pen = Program end time: month
\%pem = Program end time: month, leading zero
\%pej = Program end time: day of month
\%ped = Program end time: day of month, leading zero
\%peg = Program end time: 12-hour hour
\%peG = Program end time: 24-hour hour
\%peh = Program end time: 12-hour hour, with leading zero
\%peH = Program end time: 24-hour hour, with leading zero
\%pei = Program end time: minutes
\%pes = Program end time: seconds
\%pea = Program end time: am/pm
\%peA = Program end time: AM/PM
\%oy = Original Airdate: year, 2 digits
\%oY = Original Airdate: year, 4 digits
\%on = Original Airdate: month
\%om = Original Airdate: month, leading zero
\%oj = Original Airdate: day of month
\%od = Original Airdate: day of month, leading zero
\%% = a literal % character
* The program start time is the time from the listings data and is not
affected by when the recording started. Therefore, using program start
(or end) times may result in duplicate names. In that case, the script
will append a "counter" value to the name.
* A suffix of .mpg or .nuv will be added where appropriate.
* To separate links into subdirectories, include the / format specifier
between the appropriate fields. For example, "\%T/\%S" would create
a directory for each title containing links for each recording named
by subtitle. You may use any number of subdirectories in your format
specifier.
--separator
The string used to separate sections of the link name. Specifying the
separator allows trailing separators to be removed from the link name and
multiple separators caused by missing data to be consolidated. Indicate the
separator character in the format string using either a literal character
or the \%- specifier.
default: '$dseparator'
--replacement
Characters in the link name which are not legal on some filesystems will
be replaced with the given character
illegal characters: \\ : * ? < > | "
default: '$dreplacement'
--underscores
Replace whitespace in filenames with underscore characters.
default: No underscores
--rename
Rename the recording files back to their default names. If you had
previously used mythrename.pl to rename files (rather than creating links
to the files), use this option to restore the file names to their default
format.
Renaming the recording files is no longer supported. Instead, use
http://www.mythtv.org/wiki/mythfs.py to create a FUSE file system that
represents recordings using human-readable file names or use mythlink.pl to
create links with human-readable names to the recording files.
--maxlength length
Ensure the link name is length or fewer characters. If the link name is
longer than length, truncate the name. Zero or any negative value for
length disables length checking.
Note that this option does not take into account the path length, so on a
file system used by applications with small path limitations (such as
Windows Explorer and Windows Command Prompt), you should specify a length
that takes into account characters used by the path to the dest directory.
default: Unlimited
--verbose
Print debug info.
default: No info printed to console
--help
--usage
Show this help text.
EOF
exit;
}
# Ensure --chanid and --starttime were specified together, if at all
if ((defined($chanid) or defined($starttime)) and
!(defined($chanid) and defined($starttime))) {
die "The arguments --chanid and --starttime must be used together.\n";
}
# Ensure --maxlength specifies a reasonable value (though filenames may
# still be useless at such short lengths)
if ($maxlength > 0 and $maxlength < 19) {
die "The --maxlength must be 20 or higher.\n";
}
# Check the separator and replacement characters for illegal characters
if ($separator =~ /(?:[\/\\:*?<>|"])/) {
die "The separator cannot contain any of the following characters: /\\:*?<>|\"\n";
}
elsif ($replacement =~ /(?:[\/\\:*?<>|"])/) {
die "The replacement cannot contain any of the following characters: /\\:*?<>|\"\n";
}
# Escape where necessary
our $safe_sep = $separator;
$safe_sep =~ s/([^\w\s])/\\$1/sg;
our $safe_rep = $replacement;
$safe_rep =~ s/([^\w\s])/\\$1/sg;
# Get the hostname of this machine
$hostname = `hostname`;
chomp($hostname);
# Connect to mythbackend
my $Myth = new MythTV();
# Connect to the database
$dbh = $Myth->{'dbh'};
END {
$sh->finish if ($sh);
}
my $sgroup = new MythTV::StorageGroup();
# Only if we're renaming files back to "default" names
if ($rename) {
do_rename();
}
# Get our base location
$base_dir = $sgroup->FindRecordingDir('show_names');
if ($base_dir eq '') {
$base_dir = $sgroup->GetFirstStorageDir();
}
# Link destination
# Double-check the destination
$dest ||= "$base_dir/show_names";
# Alert the user
vprint("Link destination directory: $dest");
# Create nonexistent paths
unless (-e $dest) {
mkpath($dest, 0, 0775) or die "Failed to create $dest: $!\n";
}
# Bad path
die "$dest is not a directory.\n" unless (-d $dest);
# Delete old links/directories unless linking only one recording
if (!defined($filename) and !defined($chanid)) {
# Delete any old links
find sub { if (-l $_) {
unlink $_ or die "Couldn't remove old symlink $_: $!\n";
}
}, $dest;
# Delete empty directories (should this be an option?)
# Let this fail silently for non-empty directories
finddepth sub { rmdir $_; }, $dest;
}
# Create symlinks for the files on this machine
my %rows = ();
if (defined($chanid)) {
%rows = $Myth->backend_rows('QUERY_RECORDING TIMESLOT '.
"$chanid $starttime");
}
else {
%rows = $Myth->backend_rows('QUERY_RECORDINGS Descending');
}
foreach my $row (@{$rows{'rows'}}) {
my $show = new MythTV::Recording(@$row);
# Skip LiveTV recordings?
next unless (defined($live) || $show->{'recgroup'} ne 'LiveTV');
# File doesn't exist locally
next unless (-e $show->{'local_path'});
# Check if this is the file to link if only linking one file
if (defined($filename)) {
next unless (($show->{'basename'} eq $filename) or
($show->{'local_path'} eq $filename));
}
elsif (defined($chanid)) {
next unless ($show->{'chanid'} eq $chanid);
my $recstartts = unix_to_myth_time($show->{'recstartts'});
# Check starttime in MythTV time format (yyyy-MM-ddThh:mm:ss)
if ($recstartts ne $starttime) {
# Check starttime in ISO time format (yyyy-MM-dd hh:mm:ss)
$recstartts =~ tr/T/ /;
if ($recstartts ne $starttime) {
# Check starttime in job queue time format (yyyyMMddhhmmss)
$recstartts =~ s/[\- :]//g;
next unless ($recstartts eq $starttime);
}
}
}
# Format the name
my $name = $show->format_name($format,$separator,$replacement,$dest,$underscores);
#######################################################
#
# find this statment and place hack after my $name =
#
# my $name = $show->format_name($format,$separator,$replacement,$dest,$underscores);
#
### hack to replace season numbers
# \%qs1 = Season: zero fill 1 digits
# \%qs2 = Season: zero fill 2 digits
# \%qs3 = Season: zero fill 3 digits
#
# \%qe1 = Episode: zero fill 1 digits
# \%qe2 = Episode: zero fill 2 digits
# \%qe3 = Episode: zero fill 3 digits
#
# \%qi1 = inetref:
#
# \%qv1 = schema_version:
#print "\n Name:" ;
#print $name;
#print "\n Separator:";
#print $dseparator;
#print "\n";
my $schema_version = '';
my $season = '0';
my $episode = '0';
my $inetref = '';
$schema_version = $Myth->{'schema_version'};
#check schema version
if ($schema_version > 1265) {
$season = $show->{'season'};
$episode = $show->{'episode'};
$inetref = $show->{'inetref'};
};
# replace season numbers
my $xx1 = '%qs1';
my $xx2 = sprintf "%01d",$season;
$name =~ s/$xx1/$xx2/g;
$xx1 = '%qs2';
$xx2 = sprintf "%02d",$season;
$name =~ s/$xx1/$xx2/g;
$xx1 = '%qs3';
$xx2 = sprintf "%03d",$season;
$name =~ s/$xx1/$xx2/g;
# replace episode numbers
$xx1 = '%qe1';
$xx2 = sprintf "%01d",$episode;
$name =~ s/$xx1/$xx2/g;
$xx1 = '%qe2';
$xx2 = sprintf "%02d",$episode;
$name =~ s/$xx1/$xx2/g;
$xx1 = '%qe3';
$xx2 = sprintf "%03d",$episode;
$name =~ s/$xx1/$xx2/g;
# replace inetref
$xx1 = '%qi1';
$xx2 = $inetref;
$name =~ s/$xx1/$xx2/g;
# replace schema_version
$xx1 = '%qv1';
$xx2 = $schema_version;
$name =~ s/$xx1/$xx2/g;
#
# end of hack
########################################################
# Get a shell-safe version of the filename (yes, I know it's not needed in this case, but I'm anal about such things)
my $safe_file = $show->{'local_path'};
$safe_file =~ s/'/'\\''/sg;
$safe_file = "'$safe_file'";
# Figure out the suffix
my ($suffix) = ($show->{'basename'} =~ /(\.\w+)$/);
# Check the link name's length
$name = cut_down_name($name, $suffix);
# Link destination
# Check for duplicates
if (($name) and -e "$dest/$name$suffix") {
if ((!defined($filename) and !defined($chanid)) or
(! -l "$dest/$name$suffix")) {
$count = 2;
$name = cut_down_name($name, ".$count$suffix");
while (($name) and -e "$dest/$name.$count$suffix") {
$count++;
$name = cut_down_name($name, ".$count$suffix");
}
$name .= ".$count" if (($name));
} else {
unlink "$dest/$name$suffix" or die "Couldn't remove ".
"old symlink $dest/$name$suffix: $!\n";
}
}
if (!($name)) {
vprint("Unable to represent recording; maxlength too small.");
next;
}
$name .= $suffix;
# Create the link
my $directory = dirname("$dest/$name");
unless (-e $directory) {
mkpath($directory, 0, 0775)
or die "Failed to create $directory: $!\n";
}
symlink $show->{'local_path'}, "$dest/$name"
or die "Can't create symlink $dest/$name: $!\n";
vprint("$dest/$name");
}
# Check the length of the link name
sub cut_down_name {
my $name = shift;
my $suffix = shift;
if ($maxlength > 0) {
my $charsavailable = $maxlength - length($suffix);
if ($charsavailable > 0) {
$name = substr($name, 0, $charsavailable);
}
else {
$name = '';
}
}
return $name;
}
# Print the message, but only if verbosity is enabled
sub vprint {
return unless (defined($verbose));
print join("\n", @_), "\n";
}
# Rename the file back to default format
sub do_rename {
$q = 'UPDATE recorded SET basename=? WHERE chanid=? AND starttime=FROM_UNIXTIME(?)';
$sh = $dbh->prepare($q);
my %rows = $Myth->backend_rows('QUERY_RECORDINGS Descending');
foreach my $row (@{$rows{'rows'}}) {
my $show = new MythTV::Recording(@$row);
# File doesn't exist locally
next unless (-e $show->{'local_path'});
# Format the name
my $name = $show->format_name('%c_%Y%m%d%H%i%s');
# Get a shell-safe version of the filename (yes, I know it's not needed in this case, but I'm anal about such things)
my $safe_file = $show->{'local_path'};
$safe_file =~ s/'/'\\''/sg;
$safe_file = "'$safe_file'";
# Figure out the suffix
my ($suffix) = ($show->{'basename'} =~ /(\.\w+)$/);
# Rename the file, but only if it's a real file
if ($show->{'basename'} ne $name.$suffix) {
# Check for duplicates
$video_dir = $sgroup->FindRecordingDir($show->{'basename'});
if (-e "$video_dir/$name$suffix") {
$count = 2;
while (-e "$video_dir/$name.$count$suffix") {
$count++;
}
$name .= ".$count";
}
$name .= $suffix;
# Update the database
my $rows = $sh->execute($name, $show->{'chanid'}, $show->{'recstartts'});
die "Couldn't update basename in database for ".$show->{'basename'}.": ($q)\n" unless ($rows == 1);
my $ret = rename $show->{'local_path'}, "$video_dir/$name";
# Rename failed -- Move the database back to how it was (man, do I miss transactions)
if (!$ret) {
$rows = $sh->execute($show->{'basename'}, $show->{'chanid'}, $show->{'recstartts'});
die "Couldn't restore original basename in database for
".$show->{'basename'}.": ($q)\n" unless ($rows == 1);
}
vprint($show->{'basename'}."\t-> $name");
# Rename previews
opendir DIR, $video_dir;
foreach my $thumb (grep /\.png$/, readdir DIR) {
next unless ($thumb =~ /^$show->{'basename'}((?:\.\d+)?(?:\.\d+x\d+(?:x\d+)?)?)\.png$/);
my $dim = $1;
$ret = rename "$video_dir/$thumb", "$video_dir/$name$dim.png";
# If the rename fails, try to delete the preview from the
# cache (it will automatically be re-created with the
# proper name, when necessary)
if (!$ret) {
unlink "$video_dir/$thumb"
or vprint("Unable to rename preview image: '$video_dir/$thumb'.");
}
}
closedir DIR;
}
}
exit 0;
}
More information about the mythtv-users
mailing list