#!/usr/bin/env perl
#
# get_iplayer - Lists, Records and Streams BBC iPlayer TV and Radio programmes + other Programmes via 3rd-party plugins
#
# Copyright (C) 2008-2010 Phil Lewis
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
# Author: Phil Lewis
# Email: iplayer2 (at sign) linuxcentre.net
# Web: https://github.com/get-iplayer/get_iplayer/wiki
# License: GPLv3 (see LICENSE.txt)
#
#
package main;
my $version = 2.91;
my $version_text = "2.92-dev";
$version_text = sprintf("v%.2f", $version) unless $version_text;
#
# Help:
# ./get_iplayer --help | --longhelp
#
# Changelog:
# https://github.com/get-iplayer/get_iplayer/commits/master
#
# Example Usage and Examples:
# https://github.com/get-iplayer/get_iplayer/wiki/documentation
#
# Todo:
# * Fix non-uk detection - iphone auth?
# * Index/Record live radio streams w/schedule feeds to assist timing
# * Remove all rtsp/mplayer/lame/tee dross when realaudio streams become obselete (not quite yet)
# ** all global vars into a class???
# ** Cut down 'use' clauses in each class
# * stdout streaming with mms
# * Add podcast links to web pvr manager
# * Add PVR search src to recording history
# * Fix unicode / wide chars in rdf
#
# Known Issues:
# * CAVEAT: The filenames and modes in the history are comma-separated if there was a multimode download. For now it just uses the first one.
#
use Env qw[@PATH];
use Fcntl;
use File::Copy;
use File::Path;
use File::stat;
use File::Spec;
use Getopt::Long;
use HTML::Entities;
use HTTP::Cookies;
use HTTP::Headers;
use IO::Seekable;
use IO::Socket;
use LWP::ConnCache;
use LWP::UserAgent;
use POSIX qw(mkfifo);
use POSIX qw(:termios_h);
use strict;
#use warnings;
use Time::Local;
use Unicode::Normalize;
use URI;
use open qw(:utf8);
use Encode qw(:DEFAULT :fallback_all);
use PerlIO::encoding;
$PerlIO::encoding::fallback = XMLCREF;
use constant FB_EMPTY => sub { '' };
my %SIGORIG;
# Save default SIG actions
$SIGORIG{$_} = $SIG{$_} for keys %SIG;
$|=1;
# Hash of where plugin files were found so that the correct ones can be updated
my %plugin_files;
# Hash of all prog types => Programme class
# Add an entry here if another Programme class is added
my %prog_types = (
tv => 'Programme::tv',
radio => 'Programme::radio',
liveradio => 'Programme::liveradio',
livetv => 'Programme::livetv',
);
# Programme instance data
# $prog{$pid} = Programme->new (
# 'index' => ,
# 'name' => ,
# 'episode' => ,
# 'desc' => ,
# 'available' => ,
# 'duration' =>
# 'versions' =>
# 'thumbnail' =>
# 'channel =>
# 'categories' =>
# 'type' =>
# 'timeadded' =>
# 'version' =>
# 'filename' =>
# 'dir' =>
# 'fileprefix' =>
# 'ext' =>
#);
# Define general 'option names' => ( , , , , )
# : 0 for normal help, 1 for advanced help, 2 for basic help
# If you want the option to be hidden then don't specify , use ''
# Entries with keys starting with '_' are not parsed only displayed as help and in man pages.
my $opt_format = {
# Recording
attempts => [ 1, "attempts=n", 'Recording', '--attempts ', "Number of attempts to make or resume a failed connection. --attempts is applied per-stream, per-mode. TV modes typically have two streams available."],
checkduration => [ 1, "checkduration|check-duration!", 'Recording', '--check-duration', "Print message showing recorded duration, expected duration and difference between them."],
excludesupplier => [ 1, "excludesupplier|exclude-supplier=s", 'Recording', '--exclude-supplier ', "Comma-delimited list of media stream suppliers to skip. Possible values: akamai,limelight,level3,bidi"],
force => [ 1, "force|force-download!", 'Recording', '--force', "Ignore programme history (unsets --hide option also). Forces a script update if used with -u"],
get => [ 2, "get|record|g!", 'Recording', '--get, -g', "Start recording matching programmes. Search terms required unless --pid specified. Use --search=.* to force download of all available programmes."],
hash => [ 1, "hash!", 'Recording', '--hash', "Show recording progress as hashes"],
mediaselector => [ 1, "mediaselector|media-selector=s", 'Recording', '--mediaselector ', "Identifier of mediaselector API to use when searching for media streams. One of: 4,5 Default: 5"],
metadataonly => [ 1, "metadataonly|metadata-only!", 'Recording', '--metadata-only', "Create specified metadata info file without any recording or streaming (can also be used with thumbnail option)."],
mmsnothread => [ 1, "mmsnothread!", 'Recording', '--mmsnothread', "Disable parallel threaded recording for mms"],
modes => [ 0, "modes=s", 'Recording', '--modes ,,...', "Recording modes. See --tvmode and --radiomode for available modes and defaults. Shortcuts: default,good,better(=default),best. Use --modes=best to select highest quality available (incl. HD TV)."],
multimode => [ 1, "multimode!", 'Recording', '--multimode', "Allow the recording of more than one mode for the same programme - WARNING: will record all specified/default modes!!"],
noproxy => [ 1, "noproxy|no-proxy!", 'Recording', '--no-proxy', "Ignore --proxy setting in preferences"],
overwrite => [ 1, "overwrite|over-write!", 'Recording', '--overwrite', "Overwrite recordings if they already exist"],
partialproxy => [ 1, "partial-proxy!", 'Recording', '--partial-proxy', "Only uses web proxy where absolutely required (try this extra option if your proxy fails)"],
_url => [ 2, "", 'Recording', '--url ""', "Record the embedded media player in the specified URL. Use with --type=."],
pid => [ 2, "pid|url=s@", 'Recording', '--pid ', "Record an arbitrary pid that does not necessarily appear in the index."],
pidrecursive => [ 1, "pidrecursive|pid-recursive!", 'Recording', '--pid-recursive', "When used with --pid record all the embedded pids if the pid is a series or brand pid."],
proxy => [ 0, "proxy|p=s", 'Recording', '--proxy, -p ', "Web proxy URL e.g. 'http://USERNAME:PASSWORD\@SERVER:PORT' or 'http://SERVER:PORT'. Sets http_proxy environment variable for child processes, e.g., ffmpeg."],
raw => [ 0, "raw!", 'Recording', '--raw', "Don't transcode or change the recording/stream in any way (i.e. radio/realaudio, rtmp/flv)"],
start => [ 1, "start=s", 'Recording', '--start ', "Recording/streaming start offset (rtmp and realaudio only)"],
stop => [ 1, "stop=s", 'Recording', '--stop ', "Recording/streaming stop offset (can be used to limit live rtmp recording length) rtmp and realaudio only"],
suboffset => [ 1, "suboffset=n", 'Recording', '--suboffset ', "Offset the subtitle timestamps by the specified number of milliseconds"],
subtitles => [ 2, "subtitles|subs!", 'Recording', '--subtitles', "Download subtitles into srt/SubRip format if available and supported"],
subsfmt => [ 1, "subsfmt=s", 'Recording', '--subsfmt ', "Subtitles format. One of: default, compact. Default: 'default'"],
subsonly => [ 1, "subtitlesonly|subsonly|subtitles-only|subs-only!", 'Recording', '--subtitles-only', "Only download the subtitles, not the programme"],
subsraw => [ 1, "subsraw!", 'Recording', '--subsraw', "Additionally save the raw subtitles file"],
subsrequired => [ 1, "subsrequired|subs-required|subtitles-required!", 'Recording', '--subtitles-required', "Do not download TV programme if subtitles are not available."],
tagonly => [ 1, "tagonly|tag-only!", 'Recording', '--tag-only', "Only update the programme tag and not download the programme (can also be used with --history)"],
test => [ 1, "test|t!", 'Recording', '--test, -t', "Test only - no recording (will show programme type)"],
thumb => [ 1, "thumb|thumbnail!", 'Recording', '--thumb', "Download Thumbnail image if available"],
thumbonly => [ 1, "thumbonly|thumbnailonly|thumbnail-only|thumb-only!", 'Recording', '--thumbnail-only', "Only Download Thumbnail image if available, not the programme"],
# Search
before => [ 1, "before=n", 'Search', '--before', "Limit search to programmes added to the cache before N hours ago"],
category => [ 0, "category=s", 'Search', '--category ', "Narrow search to matched categories (regex or comma separated values)"],
channel => [ 0, "channel=s", 'Search', '--channel ', "Narrow search to matched channel(s) (regex or comma separated values)"],
exclude => [ 0, "exclude=s", 'Search', '--exclude ', "Narrow search to exclude matched programme names (regex or comma separated values)"],
excludecategory => [ 0, "xcat|exclude-category=s", 'Search', '--exclude-category ', "Narrow search to exclude matched categories (regex or comma separated values)"],
excludechannel => [ 0, "xchan|exclude-channel=s", 'Search', '--exclude-channel ', "Narrow search to exclude matched channel(s) (regex or comma separated values)"],
fields => [ 0, "fields=s", 'Search', '--fields ,,..', "Searches only in the specified comma separated fields"],
future => [ 1, "future!", 'Search', '--future', "Additionally search future programme schedule if it has been indexed (refresh cache with: --refresh --refresh-future)."],
long => [ 0, "long|l!", 'Search', '--long, -l', "Additionally search in programme descriptions and episode names (same as --fields=name,episode,desc )"],
search => [ 1, "search=s", 'Search', '--search ', "GetOpt compliant way of specifying search args"],
history => [ 1, "history!", 'Search', '--history', "Search/show recordings history"],
since => [ 0, "since=n", 'Search', '--since', "Limit search to programmes added to the cache in the last N hours"],
type => [ 2, "type=s", 'Search', '--type ', "Only search in these types of programmes: ".join(',', keys %prog_types).",all (tv is default)"],
versionlist => [ 1, "versionlist|versions|version-list=s", 'Search', '--versions ', "Version of programme to search or record. List is processed from left to right and first version found is downloaded. Example: '--versions signed,audiodescribed,default' will prefer signed and audiodescribed programmes if available. Default: 'default,signed,audiodescribed'"],
# Output
aactomp3 => [ 1, "aactomp3|mp3", 'Output', '--aactomp3', "Transcode AAC audio to MP3 with ffmpeg/avconv (CBR 128k unless --mp3vbr is specified). Applied only to radio programmes. (Synonyms: --mp3)"],
mp3vbr => [ 1, "mp3vbr=n", 'Output', '--mp3vbr', "Set LAME VBR mode to N (0 to 9) for AAC transcoding. 0 = target bitrate 245 Kbit/s, 9 = target bitrate 65 Kbit/s (requires --aactomp3). Applied only to radio programmes."],
avi => [ 1, "avi", 'Output', '--avi', "Output video in AVI container instead of MP4. There is no metadata tagging support for AVI output."],
command => [ 1, "c|command=s", 'Output', '--command, -c ', "Run user command after successful recording using args such as , etc"],
email => [ 1, "email=s", 'Output', '--email ', "Email HTML index of matching programmes to specified address"],
emailsmtp => [ 1, "emailsmtpserver|email-smtp=s", 'Output', '--email-smtp ', "SMTP server IP address to use to send email (default: localhost)"],
emailsender => [ 1, "emailsender|email-sender=s", 'Output', '--email-sender ', "Optional email sender address"],
emailsecurity => [ 1, "emailsecurity|email-security=s", 'Output', '--email-security ', "Email security TLS, SSL (default: none)"],
emailpassword => [ 1, "emailpassword|email-password=s", 'Output', '--email-password ', "Email password"],
emailport => [ 1, "emailport|email-port=s", 'Output', '--email-port ', "Email port number (default: appropriate port for --email-security)"],
emailuser => [ 1, "emailuser|email-user=s", 'Output', '--email-user ', "Email username"],
fatfilename => [ 1, "fatfilenames|fatfilename!", 'Output', '--fatfilename', "Remove FAT forbidden characters in file and directory names. Always applied on Windows. Overrides --punctuation."],
fileprefix => [ 1, "file-prefix|fileprefix=s", 'Output', '--file-prefix ', "The filename prefix (excluding dir and extension) using formatting fields. e.g. '--'"],
fxd => [ 1, "fxd=s", 'Output', '--fxd ', "Create Freevo FXD XML of matching programmes in specified file"],
hfsfilename => [ 1, "hfsfilenames|hfsfilename!", 'Output', '--hfsfilename', "Remove colons in file and directory names. Prevents OS X Finder displaying colon as forward slash. Always applied on OS X. Overrides --punctuation."],
html => [ 1, "html=s", 'Output', '--html ', "Create basic HTML index of matching programmes in specified file"],
isodate => [ 1, "isodate!", 'Output', '--isodate', "Use ISO8601 dates (YYYY-MM-DD) in filenames and subdirectory paths"],
keepall => [ 1, "keepall|keep-all!", 'Output', '--keep-all', "Keep whitespace, all possible punctuation and non-ASCII characters in file and directory names. Shortcut for: --whitespace --non-ascii --punctuation."],
metadata => [ 1, "metadata=s", 'Output', '--metadata ', "Create metadata info file after recording. Valid types are: xbmc (or kodi), xbmc_movie (or kodi_movie), freevo, generic"],
mkv => [ 1, "mkv", 'Output', '--mkv', "Output video in MKV container instead of MP4. There is no metadata tagging support for MKV output."],
mythtv => [ 1, "mythtv=s", 'Output', '--mythtv ', "Create Mythtv streams XML of matching programmes in specified file"],
nonascii => [ 1, "na|nonascii|non-ascii!", 'Output', '--non-ascii, --na', "Keep non-ASCII characters in file and directory names. Default behaviour is to remove all non-ASCII characters."],
nowrite => [ 1, "no-write|nowrite|n!", 'Output', '--nowrite, -n', "No writing of file to disk (use with -x to prevent a copy being stored on disk)"],
output => [ 2, "output|o=s", 'Output', '--output, -o ', "Recording output directory"],
player => [ 0, "player=s", 'Output', "--player \' \'", "Use specified command to directly play the stream"],
punctuation => [ 1, "symbols|pu|punct|punctuation!", 'Output', '--punctuation, --pu', "Keep punctuation characters and symbols in file and directory names, with ellipsis always replaced by underscore. Default behaviour is to remove all punctuation and symbols except underscore, hyphen and full stop. Overridden by --fatfilename and --hfsfilename."],
stdout => [ 1, "stdout|x", 'Output', '--stdout, -x', "Additionally stream to STDOUT (so you can pipe output to a player)"],
stream => [ 0, "stream!", 'Output', '--stream', "Stream to STDOUT (so you can pipe output to a player)"],
subdir => [ 1, "subdirs|subdir|s!", 'Output', '--subdir, -s', "Put Recorded files into Programme name subdirectory"],
subdirformat => [ 1, "subdirformat|subdirsformat|subdir-format=s", 'Output', '--subdir-format ', "The format to be used for the subdirectory naming using formatting fields. e.g. '-'"],
symlink => [ 1, "symlink|freevo=s", 'Output', '--symlink ', "Create symlink to once we have the header of the recording"],
thumbext => [ 1, "thumbext|thumb-ext=s", 'Output', '--thumb-ext ', "Thumbnail filename extension to use"],
thumbsizecache => [ 1, "thumbsizecache=n", 'Output', '--thumbsizecache ', "Default thumbnail size/index to use when building cache. index: 1-11 or width: 86,150,178,512,528,640,832,1024,1280,1600,1920"],
thumbsize => [ 1, "thumbsize|thumbsizemeta=n", 'Output', '--thumbsize ', "Default thumbnail size/index to use for the current recording and metadata. index: 1-11 or width: 86,150,178,512,528,640,832,1024,1280,1600,1920"],
whitespace => [ 1, "whitespace|ws|w!", 'Output', '--whitespace, -w', "Keep whitespace in file and directory names. Default behaviour is to replace whitespace with underscores."],
xmlchannels => [ 1, "xml-channels|fxd-channels!", 'Output', '--xml-channels', "Create freevo/Mythtv menu of channels -> programme names -> episodes"],
xmlnames => [ 1, "xml-names|fxd-names!", 'Output', '--xml-names', "Create freevo/Mythtv menu of programme names -> episodes"],
xmlalpha => [ 1, "xml-alpha|fxd-alpha!", 'Output', '--xml-alpha', "Create freevo/Mythtv menu sorted alphabetically by programme name"],
# Config
expiry => [ 1, "expiry|e=n", 'Config', '--expiry, -e ', "Cache expiry in seconds (default 4hrs)"],
refresh => [ 2, "refresh|flush|f!", 'Config', '--refresh, --flush, -f', "Refresh cache"],
limitmatches => [ 1, "limitmatches|limit-matches=n", 'Config', '--limit-matches ', "Limits the number of matching results for any search (and for every PVR search)"],
nopurge => [ 1, "no-purge|nopurge!", 'Config', '--nopurge', "Don't ask to delete programmes recorded over 30 days ago"],
packagemanager => [ 1, "packagemanager=s", 'Config', '--packagemanager ', "Tell the updater that we were installed using a package manager and don't update (use either: apt,rpm,deb,yum,disable)"],
pluginsupdate => [ 1, "pluginsupdate|plugins-update!", 'Config', '--plugins-update', "Update get_iplayer plugins to the latest versions. get_iplayer main script also will be updated if a newer version is available.)"],
prefsadd => [ 0, "addprefs|add-prefs|prefsadd|prefs-add!", 'Config', '--prefs-add', "Add/Change specified saved user or preset options"],
prefsdel => [ 0, "del-prefs|delprefs|prefsdel|prefs-del!", 'Config', '--prefs-del', "Remove specified saved user or preset options"],
prefsclear => [ 0, "clear-prefs|clearprefs|prefsclear|prefs-clear!", 'Config', '--prefs-clear', "Remove *ALL* saved user or preset options"],
prefsshow => [ 0, "showprefs|show-prefs|prefsshow|prefs-show!", 'Config', '--prefs-show', "Show saved user or preset options"],
preset => [ 1, "preset|z=s", 'Config', '--preset, -z ', "Use specified user options preset"],
presetlist => [ 1, "listpresets|list-presets|presetlist|preset-list!", 'Config', '--preset-list', "Show all valid presets"],
profiledir => [ 1, "profiledir|profile-dir=s", 'Config', '--profile-dir ', "Override the user profile directory/folder"],
refreshabortonerror => [ 1, "refreshabortonerror|refresh-abortonerror!", 'Config', '--refresh-abortonerror', "Abort cache refresh for programme type if data for any channel fails to download. Use --refresh-exclude to temporarily skip failing channels."],
refreshinclude => [ 1, "refreshinclude|refresh-include=s", 'Config', '--refresh-include ', "Include matched channel(s) when refreshing cache (regex or comma separated values)"],
refreshexclude => [ 1, "refreshexclude|refresh-exclude|ignorechannels=s", 'Config', '--refresh-exclude ', "Exclude matched channel(s) when refreshing cache (regex or comma separated values)"],
refreshexcludegroups => [ 1, "refreshexcludegroups|refresh-exclude-groups=s", 'Config', '--refresh-exclude-groups', "Exclude channel groups when refreshing radio or tv cache (comma-separated values). Valid values: 'national', 'regional', 'local'"],
refreshexcludegroupsradio => [ 1, "refreshexcludegroupsradio|refresh-exclude-groups-radio=s", 'Config', '--refresh-exclude-groups-radio', "Exclude channel groups when refreshing radio cache (comma-separated values). Valid values: 'national', 'regional', 'local'"],
refreshexcludegroupstv => [ 1, "refreshexcludegroupstv|refresh-exclude-groups-tv=s", 'Config', '--refresh-exclude-groups-tv', "Exclude channel groups when refreshing tv cache (comma-separated values). Valid values: 'national', 'regional', 'local'"],
refreshfeeds => [ 1, "refreshfeeds|refresh-feeds=s", 'Config', '--refresh-feeds ', "Alternate source for programme data. Valid values: 'ion','ion2','schedule'"],
refreshfeedsradio => [ 1, "refreshfeedsradio|refresh-feeds-radio=s", 'Config', '--refresh-feeds-radio ', "Alternate source for radio programme data. Valid values: 'ion','ion2','schedule'"],
refreshfeedstv => [ 1, "refreshfeedstv|refresh-feeds-tv=s", 'Config', '--refresh-feeds-tv ', "Alternate source for TV programme data. Valid values: 'ion','ion2','schedule'"],
refreshfuture => [ 1, "refreshfuture|refresh-future!", 'Config', '--refresh-future', "Obtain future programme schedule when refreshing cache (between 7-14 days)"],
refreshlimit => [ 1, "refreshlimit|refresh-limit=n", 'Config', '--refresh-limit ', "Number of days of programmes to cache. Only applied with --refresh-feeds=schedule. Makes cache updates VERY slow. Default: 7 Min: 1 Max: 30"],
refreshlimitradio => [ 1, "refreshlimitradio|refresh-limit-radio=n", 'Config', '--refresh-limit-radio ', "Number of days of radio programmes to cache. Only applied with --refresh-feeds=schedule. Makes cache updates VERY slow. Default: 7 Min: 1 Max: 30"],
refreshlimittv => [ 1, "refreshlimittv|refresh-limit-tv=n", 'Config', '--refresh-limit-tv ', "Number of days of TV programmes to cache. Only applied with --refresh-feeds=schedule. Makes cache updates VERY slow. Default: 7 Min: 1 Max: 30"],
skipdeleted => [ 1, "skipdeleted!", 'Config', "--skipdeleted", "Skip the download of metadata/thumbs/subs if the media file no longer exists. Use with --history & --metadataonly/subsonly/thumbonly."],
update => [ 2, "update|u!", 'Config', '--update, -u', "Update get_iplayer if a newer version is available. If so, plugins also will be updated if newer versions available."],
webrequest => [ 1, "webrequest=s", 'Config', '--webrequest ', 'Specify all options as a urlencoded string of "name=val&name=val&..."' ],
# Display
conditions => [ 1, "conditions!", 'Display', '--conditions', 'Shows GPLv3 conditions'],
debug => [ 1, "debug!", 'Display', '--debug', "Debug output"],
dumpoptions => [ 1, "dumpoptions|dumpopts|dump-options!", 'Display', '--dump-options', 'Dumps all options with their internal option key names'],
helpbasic => [ 2, "help-basic|usage|bh|hb|helpbasic|basichelp|basic-help!", 'Display', '--helpbasic, --usage', "Basic help text"],
help => [ 2, "help|h!", 'Display', '--help, -h', "Intermediate help text"],
helplong => [ 2, "help-long|advanced|long-help|longhelp|lh|hl|helplong!", 'Display', '--helplong', "Advanced help text"],
hide => [ 1, "hide!", 'Display', '--hide', "Hide previously recorded programmes"],
info => [ 2, "i|info!", 'Display', '--info, -i', "Show full programme metadata and availability of modes and subtitles (max 50 matches)"],
list => [ 1, "list=s", 'Display', '--list ', "Show a list of available categories/channels for the selected type and exit"],
listformat => [ 1, "listformat=s", 'Display', '--listformat ', "Display programme data based on a user-defined format string (such as , etc)"],
listplugins => [ 1, "listplugins!", 'Display', '--listplugins', "Display a list of currently available plugins or programme types"],
_long => [ 0, "", 'Display', '--long, -l', "Show long programme info"],
manpage => [ 1, "manpage=s", 'Display', '--manpage ', "Create man page based on current help text"],
nocopyright => [ 1, "nocopyright!", 'Display', '--nocopyright', "Don't display copyright header"],
page => [ 1, "page=n", 'Display', '--page ', "Page number to display for multipage output"],
pagesize => [ 1, "pagesize=n", 'Display', '--pagesize ', "Number of matches displayed on a page for multipage output"],
quiet => [ 1, "q|quiet!", 'Display', '--quiet, -q', "Reduce logging output"],
series => [ 1, "series!", 'Display', '--series', "Display Programme series names only with number of episodes"],
showcacheage => [ 1, "showcacheage|show-cache-age!", 'Display', '--show-cache-age', "Displays the age of the selected programme caches then exit"],
showoptions => [ 1, "showoptions|showopts|show-options!", 'Display', '--show-options', 'Shows options which are set and where they are defined'],
silent => [ 1, "silent!", 'Display', '--silent', "No logging output except PVR download report. Cannot be saved in preferences or PVR searches."],
sortmatches => [ 1, "sortmatches|sort=s", 'Display', '--sort ', "Field to use to sort displayed matches"],
sortreverse => [ 1, "sortreverse!", 'Display', '--sortreverse', "Reverse order of sorted matches"],
streaminfo => [ 1, "streaminfo!", 'Display', '--streaminfo', "Returns all of the media stream urls of the programme(s)"],
terse => [ 0, "terse!", 'Display', '--terse', "Only show terse programme info (does not affect searching)"],
tree => [ 0, "tree!", 'Display', '--tree', "Display Programme listings in a tree view"],
verbose => [ 1, "verbose|v!", 'Display', '--verbose, -v', "Verbose"],
showver => [ 1, "V!", 'Display', '-V', "Show get_iplayer version and exit."],
warranty => [ 1, "warranty!", 'Display', '--warranty', 'Displays warranty section of GPLv3'],
# External Program
atomicparsley => [ 1, "atomicparsley|atomic-parsley=s", 'External Program', '--atomicparsley ', "Location of AtomicParsley tagger binary"],
id3v2 => [ 1, "id3tag|id3v2=s", 'External Program', '--id3v2 ', "Location of id3v2 or id3tag binary"],
mplayer => [ 1, "mplayer=s", 'External Program', '--mplayer ', "Location of mplayer binary"],
# Tagging
noartwork => [ 1, "noartwork|no-artwork!", 'Tagging', '--no-artwork', "Do not embed thumbnail image in output file. All other metadata values will be written."],
notag => [ 1, "notag|no-tag!", 'Tagging', '--no-tag', "Do not tag downloaded programmes"],
tag_cnid => [ 1, "tagcnid|tag-cnid!", 'Tagging', '--tag-cnid', "Use AtomicParsley --cnID argument (if supported) to add catalog ID used for combining HD and SD versions in iTunes"],
tag_fulltitle => [ 1, "tagfulltitle|tag-fulltitle!", 'Tagging', '--tag-fulltitle', "Prepend album/show title to track title"],
tag_hdvideo => [ 1, "taghdvideo|tag-hdvideo!", 'Tagging', '--tag-hdvideo', "AtomicParsley accepts --hdvideo argument for HD video flag"],
tag_id3sync => [ 1, "tagid3sync|tag-id3sync!", 'Tagging', '--tag-id3sync', "Save ID3 tags for MP3 files in synchronised form. Provides workaround for corruption of thumbnail images in Windows. Has no effect unless using MP3::Tag Perl module."],
tag_isodate => [ 1, "tagisodate|tag-isodate!", 'Tagging', '--tag-isodate', "Use ISO8601 dates (YYYY-MM-DD) in album/show names and track titles"],
tag_longdesc => [ 1, "taglongdesc|tag-longdesc!", 'Tagging', '--tag-longdesc', "AtomicParsley accepts --longdesc argument for long description text"],
tag_longdescription => [ 1, "taglongdescription|tag-longdescription!", 'Tagging', '--tag-longdescription', "AtomicParsley accepts --longDescription argument for long description text"],
tag_longepisode => [ 1, "taglongepisode|tag-longepisode!", 'Tagging', '--tag-longepisode', "Use instead of for track title"],
tag_longtitle => [ 1, "taglongtitle|tag-longtitle!", 'Tagging', '--tag-longtitle', "Prepend (if available) to track title. Ignored with --tag-fulltitle."],
tag_podcast => [ 1, "tagpodcast|tag-podcast!", 'Tagging', '--tag-podcast', "Tag downloaded radio and tv programmes as iTunes podcasts (requires MP3::Tag module for AAC/MP3 files)"],
tag_podcast_radio => [ 1, "tagpodcastradio|tag-podcast-radio!", 'Tagging', '--tag-podcast-radio', "Tag only downloaded radio programmes as iTunes podcasts (requires MP3::Tag module for AAC/MP3 files)"],
tag_podcast_tv => [ 1, "tagpodcasttv|tag-podcast-tv!", 'Tagging', '--tag-podcast-tv', "Tag only downloaded tv programmes as iTunes podcasts"],
tag_shortname => [ 1, "tagshortname|tag-shortname!", 'Tagging', '--tag-shortname', "Use instead of for album/show title"],
tag_utf8 => [ 1, "tagutf8|tag-utf8!", 'Tagging', '--tag-utf8', "AtomicParsley accepts UTF-8 input"],
# Misc
encodingconsolein => [ 1, "encodingconsolein|encoding-console-in=s", 'Misc', '--encoding-console-in ', "Character encoding for standard input (currently unused). Encoding name must be known to Perl Encode module. Default (only if auto-detect fails): Linux/Unix/OSX = UTF-8, Windows = cp850"],
encodingconsoleout => [ 1, "encodingconsoleout|encoding-console-out=s", 'Misc', '--encoding-console-out ', "Character encoding used to encode search results and other output. Encoding name must be known to Perl Encode module. Default (only if auto-detect fails): Linux/Unix/OSX = UTF-8, Windows = cp850"],
encodinglocale => [ 1, "encodinglocale|encoding-locale=s", 'Misc', '--encoding-locale ', "Character encoding used to decode command-line arguments. Encoding name must be known to Perl Encode module. Default (only if auto-detect fails): Linux/Unix/OSX = UTF-8, Windows = cp1252"],
encodinglocalefs => [ 1, "encodinglocalefs|encoding-locale-fs=s", 'Misc', '--encoding-locale-fs ', "Character encoding used to encode file and directory names. Encoding name must be known to Perl Encode module. Default (only if auto-detect fails): Linux/Unix/OSX = UTF-8, Windows = cp1252"],
noscrapeversions => [ 1, "noscrapeversions|no-scrape-versions!", 'Misc', '--no-scrape-versions', "Do not scrape episode web pages as extra measure to find audiodescribed/signed versions (only applies with --playlist-metadata)."],
playlistmetadata => [ 1, "playlistmetadata|playlist-metadata!", 'Misc', '--playlist-metadata', "Force use of playlists (XML and JSON) for programme metadata instead of /programmes data endpoints."],
trimhistory => [ 1, "trimhistory|trim-history=s", 'Misc', '--trim-history <# days to retain>', "Remove download history entries older than number of days specified in option value. Cannot specify 0 - use 'all' to completely delete download history"],
};
# Pre-processed options instance
my $opt_pre = Options->new();
# Final options instance
my $opt = Options->new();
# Command line options instance
my $opt_cmdline = Options->new();
# Options file instance
my $opt_file = Options->new();
# Bind opt_format to Options class
Options->add_opt_format_object( $opt_format );
# Set Programme/Pvr/Streamer class global var refs to the Options instance
History->add_opt_object( $opt );
Programme->add_opt_object( $opt );
Pvr->add_opt_object( $opt );
Pvr->add_opt_file_object( $opt_file );
Pvr->add_opt_cmdline_object( $opt_cmdline );
Streamer->add_opt_object( $opt );
# Kludge: Create dummy Streamer, History and Programme instances (without a single instance, none of the bound options work)
History->new();
Programme->new();
Streamer->new();
# Print to STDERR/STDOUT if not quiet unless verbose or debug
sub logger(@) {
my $msg = shift || '';
# Make sure quiet can be overridden by verbose and debug options
if ( $opt->{verbose} || $opt->{debug} || ! $opt->{silent} ) {
# Only send messages to STDERR if pvr or stdout options are being used.
if ( $opt->{stdout} || $opt->{pvr} || $opt->{stderr} || $opt->{stream} ) {
print STDERR $msg;
} else {
print STDOUT $msg;
}
}
}
# fallback encodings
$opt->{encodinglocale} = $opt->{encodinglocalefs} = default_encodinglocale();
$opt->{encodingconsoleout} = $opt->{encodingconsolein} = default_encodingconsoleout();
# attempt to automatically determine encodings
eval {
require Encode::Locale;
};
if (!$@) {
# set encodings unless already set by PERL_UNICODE or perl -C
$opt->{encodinglocale} = $Encode::Locale::ENCODING_LOCALE unless (${^UNICODE} & 32);
$opt->{encodinglocalefs} = $Encode::Locale::ENCODING_LOCALE_FS unless (${^UNICODE} & 32);
$opt->{encodingconsoleout} = $Encode::Locale::ENCODING_CONSOLE_OUT unless (${^UNICODE} & 6);
$opt->{encodingconsolein} = $Encode::Locale::ENCODING_CONSOLE_IN unless (${^UNICODE} & 1);
}
# Pre-Parse the cmdline using the opt_format hash so that we know some of the options before we properly parse them later
# Parse options with passthru mode (i.e. ignore unknown options at this stage)
# need to save and restore @ARGV to allow later processing)
my @argv_save = @ARGV;
$opt_pre->parse( 1 );
@ARGV = @argv_save;
# set encodings ASAP
my @encoding_opts = ('encodinglocale', 'encodinglocalefs', 'encodingconsoleout', 'encodingconsolein');
foreach ( @encoding_opts ) {
$opt->{$_} = $opt_pre->{$_} if $opt_pre->{$_};
}
binmode(STDOUT, ":encoding($opt->{encodingconsoleout})");
binmode(STDERR, ":encoding($opt->{encodingconsoleout})");
binmode(STDIN, ":encoding($opt->{encodingconsolein})");
# decode @ARGV unless already decoded by PERL_UNICODE or perl -C
unless ( ${^UNICODE} & 32 ) {
@ARGV = map { decode($opt->{encodinglocale}, $_) } @ARGV;
}
# compose UTF-8 args if necessary
if ( $opt->{encodinglocale} =~ /UTF-?8/i ) {
@ARGV = map { NFKC($_) } @ARGV;
}
# Copy a few options over to opt so that logger works
$opt->{debug} = $opt->{verbose} = 1 if $opt_pre->{debug};
$opt->{verbose} = 1 if $opt_pre->{verbose};
$opt->{silent} = $opt->{quiet} = 1 if $opt_pre->{silent};
$opt->{quiet} = 1 if $opt_pre->{quiet};
$opt->{pvr} = 1 if $opt_pre->{pvr};
$opt->{stdout} = 1 if $opt_pre->{stdout} || $opt_pre->{stream};
# show version and exit
if ( $opt_pre->{showver} ) {
print STDERR Options->copyright_notice;
exit 0;
}
# This is where all profile data/caches/cookies etc goes
my $profile_dir;
# This is where system-wide default options are specified
my $optfile_system;
# Options directories specified by env vars
if ( defined $ENV{GETIPLAYERUSERPREFS} ) {
$profile_dir = $opt_pre->{profiledir} || $ENV{GETIPLAYERUSERPREFS};
# Otherwise look for windows style file locations
} elsif ( defined $ENV{USERPROFILE} && $^O eq "MSWin32" ) {
$profile_dir = $opt_pre->{profiledir} || $ENV{USERPROFILE}.'/.get_iplayer';
# Options on unix-like systems
} elsif ( defined $ENV{HOME} ) {
$profile_dir = $opt_pre->{profiledir} || $ENV{HOME}.'/.get_iplayer';
}
# System options file specified by env var
if ( defined $ENV{GETIPLAYERSYSPREFS} ) {
$optfile_system = $ENV{GETIPLAYERSYSPREFS};
# Otherwise look for windows style file locations
} elsif ( defined $ENV{ALLUSERSPROFILE} && $^O eq "MSWin32" ) {
$optfile_system = $ENV{ALLUSERSPROFILE}.'/get_iplayer/options';
# System options on unix-like systems
} else {
$optfile_system = '/etc/get_iplayer/options';
# Show warning if this deprecated location exists and is not a symlink
if ( -f '/var/lib/get_iplayer/options' && ! -l '/var/lib/get_iplayer/options' ) {
logger "WARNING: System-wide options file /var/lib/get_iplayer/options will be deprecated in future, please use /etc/get_iplayer/options instead\n";
}
}
# Make profile dir if it doesnt exist
mkpath $profile_dir if ! -d $profile_dir;
# get list of additional user plugins and load plugin
my $plugin_dir_system;
if ( defined $ENV{ALLUSERSPROFILE} && $^O eq "MSWin32" ) {
$plugin_dir_system = $ENV{ALLUSERSPROFILE}.'/get_iplayer/plugins';
} else {
$plugin_dir_system = '/usr/share/get_iplayer/plugins';
}
my $plugin_dir_user = "$profile_dir/plugins";
for my $plugin_dir ( ( $plugin_dir_user, $plugin_dir_system ) ) {
if ( opendir( DIR, $plugin_dir ) ) {
#logger "INFO: Checking for plugins in $plugin_dir\n";
my @plugin_file_list = grep /^.+\.plugin$/, readdir DIR;
closedir DIR;
for ( @plugin_file_list ) {
#logger "INFO: Got $_\n";
chomp();
$_ = "$plugin_dir/$_";
m{^.*\/(.+?).plugin$};
# keep in a hash for update
$plugin_files{$_} = $1.'.plugin';
# Skip if we have this plugin already
next if (! $1) || $prog_types{$1};
# Register the plugin
$prog_types{$1} = "Programme::$1";
#logger "INFO: Loading $_\n";
require $_;
# Kludge: Create dummy instance (without a single instance, none of the bound options work)
$prog_types{$1}->new();
}
}
}
# Set the personal options according to the specified preset
my $optfile_default = "${profile_dir}/options";
my $optfile_preset;
if ( $opt_pre->{preset} ) {
# create dir if it does not exist
mkpath "${profile_dir}/presets/" if ! -d "${profile_dir}/presets/";
# Sanitize preset file name
my $presetname = StringUtils::sanitize_path( $opt_pre->{preset}, 0, 1 );
$optfile_preset = "${profile_dir}/presets/${presetname}";
logger "INFO: Using user options preset '${presetname}'\n";
}
logger "DEBUG: User Preset Options File: $optfile_preset\n" if defined $optfile_preset && $opt->{debug};
# Parse cmdline opts definitions from each Programme class/subclass
Options->get_class_options( $_ ) for qw( Streamer Programme Pvr );
Options->get_class_options( progclass($_) ) for progclass();
Options->get_class_options( "Streamer::$_" ) for qw( rtmp hls shoutcast rtsp iphone mms 3gp http ddl );
# Parse the cmdline using the opt_format hash
Options->usage( 0 ) if not $opt_cmdline->parse();
# process --start and --stop if necessary
foreach ('start', 'stop') {
if ($opt_cmdline->{$_} && $opt_cmdline->{$_} =~ /(\d\d):(\d\d)(:(\d\d))?/) {
$opt_cmdline->{$_} = $1 * 3600 + $2 * 60 + $4;
}
}
# Parse options if we're not saving/adding/deleting options (system-wide options are overridden by personal options)
if ( ! ( $opt_pre->{prefsadd} || $opt_pre->{prefsdel} || $opt_pre->{prefsclear} ) ) {
# Load options from files into $opt_file
# system, Default, './.get_iplayer/options' and Preset options in that order should they exist
$opt_file->load( $opt, '/var/lib/get_iplayer/options', $optfile_system, $optfile_default, './.get_iplayer/options', $optfile_preset );
# Copy these loaded options into $opt
$opt->copy_set_options_from( $opt_file );
}
# Copy to $opt from opt_cmdline those options which are actually set
$opt->copy_set_options_from( $opt_cmdline );
# Update or show user opts file (or preset if defined) if required
if ( $opt_cmdline->{presetlist} ) {
$opt->preset_list( "${profile_dir}/presets/" );
exit 0;
} elsif ( $opt_cmdline->{prefsadd} ) {
$opt->add( $opt_cmdline, $optfile_preset || $optfile_default, @ARGV );
exit 0;
} elsif ( $opt_cmdline->{prefsdel} ) {
$opt->del( $opt_cmdline, $optfile_preset || $optfile_default, @ARGV );
exit 0;
} elsif ( $opt_cmdline->{prefsshow} ) {
$opt->show( $optfile_preset || $optfile_default );
exit 0;
} elsif ( $opt_cmdline->{prefsclear} ) {
$opt->clear( $optfile_preset || $optfile_default );
exit 0;
}
# List all valid programme type plugins (and built-ins)
if ( $opt->{listplugins} ) {
main::logger join(',', keys %prog_types)."\n";
exit 0;
}
# Show copyright notice
logger Options->copyright_notice if not $opt->{nocopyright};
# show encodings in use
if ( $opt->{verbose} ) {
logger "INFO: $_ = $opt->{$_}\n" for @encoding_opts;
logger "INFO: \${^UNICODE} = ${^UNICODE}\n" if $opt->{verbose};
}
# Display prefs dirs if required
main::logger "INFO: User prefs dir: $profile_dir\n" if $opt->{verbose};
main::logger "INFO: System options dir: $optfile_system\n" if $opt->{verbose};
# Display Usage
Options->usage( 2 ) if $opt_cmdline->{helpbasic};
Options->usage( 0 ) if $opt_cmdline->{help};
Options->usage( 1 ) if $opt_cmdline->{helplong};
# Dump all option keys and descriptions if required
Options->usage( 1, 0, 1 ) if $opt_pre->{dumpoptions};
# Generate man page
Options->usage( 1, $opt_cmdline->{manpage} ) if $opt_cmdline->{manpage};
# Display GPLv3 stuff
if ( $opt_cmdline->{warranty} || $opt_cmdline->{conditions}) {
# Get license from GNU
logger request_url_retry( create_ua( 'get_iplayer', 1 ), 'http://www.gnu.org/licenses/gpl-3.0.txt'."\n", 1);
exit 1;
}
# Force plugins update if no plugins found
if ( ! keys %plugin_files && ! $opt->{packagemanager}) {
logger "WARNING: Running the updater again to obtain plugins.\n";
$opt->{pluginsupdate} = 1;
}
# Update this script if required
update_script() if $opt->{update} || $opt->{pluginsupdate};
########## Global vars ###########
#my @cache_format = qw/index type name pid available episode versions duration desc channel categories thumbnail timeadded guidance web/;
my @history_format = qw/pid name episode type timeadded mode filename versions duration desc channel categories thumbnail guidance web episodenum seriesnum/;
# Ranges of numbers used in the indicies for each programme type
my $max_index = 0;
for ( progclass() ) {
# Set maximum index number
$max_index = progclass($_)->index_max if progclass($_)->index_max > $max_index;
}
# Setup signal handlers
$SIG{INT} = $SIG{PIPE} = \&cleanup;
# Other Non option-dependant vars
my $historyfile = "${profile_dir}/download_history";
my $cookiejar = "${profile_dir}/cookies.";
my $namedpipe = "${profile_dir}/namedpipe.$$";
my $lwp_request_timeout = 20;
my $info_limit = 40;
my $proxy_save;
# Option dependant var definitions
my $bin;
my $binopts;
my @search_args = @ARGV;
my $memcache = {};
########### Main processing ###########
# Use --webrequest to specify options in urlencoded format
if ( $opt->{webrequest} ) {
# parse GET args
my @webopts = split /[\&\?]/, $opt->{webrequest};
for (@webopts) {
# URL decode it (value should then be decoded as UTF-8)
$_ = decode($opt->{encodinglocale}, main::url_decode( $_ ), FB_EMPTY);
my ( $optname, $value );
# opt val pair
if ( m{^\s*([\w\-]+?)[\s=](.+)$} ) {
( $optname, $value ) = ( $1, $2 );
# flag only
} elsif ( m{^\s*([\w\-]+)$} ) {
( $optname, $value ) = ( $1, 1 );
}
# if the option is valid then add it
if ( defined $opt_format->{$optname} ) {
$opt_cmdline->{$optname} = $value;
logger "INFO: webrequest OPT: $optname=$value\n" if $opt->{verbose};
# Ignore invalid opts
} else {
logger "ERROR: Invalid webrequest OPT: $optname=$value\n" if $opt->{verbose};
}
}
# Copy to $opt from opt_cmdline those options which are actually set - allows pvr-add to work which only looks at cmdline args
$opt->copy_set_options_from( $opt_cmdline );
# Remove this option now we've processed it
delete $opt->{webrequest};
delete $opt_cmdline->{webrequest};
}
# Add --search option to @search_args if specified
if ( defined $opt->{search} ) {
push @search_args, $opt->{search};
# Remove this option now we've processed it
delete $opt->{search};
delete $opt_cmdline->{search};
}
# check if no search term(s) specified
my $no_search_args = $#search_args < 0;
# Assume search term is '.*' if nothing is specified - i.e. lists all programmes
push @search_args, '.*' if ! $search_args[0] && ! $opt->{pid};
# Auto-detect http:// url or :http:// in a search term and set it as a --pid option (disable if --fields is used).
if ( $search_args[0] =~ m{^(\w+:)?http://} && ( ! $opt->{pid} ) && ( ! $opt->{fields} ) ) {
$opt->{pid} = $search_args[0];
}
if ( $opt->{pid} ) {
my @search_pids;
if ( ref($opt->{pid}) eq 'ARRAY' ) {
push @search_pids, @{$opt->{pid}};
} else {
push @search_pids, $opt->{pid};
}
$opt->{pid} = join( ',', @search_pids );
$opt_cmdline->{pid} = $opt->{pid};
}
# PVR Lockfile location (keep global so that cleanup sub can unlink it)
my $lockfile;
$lockfile = $profile_dir.'/pvr_lock' if $opt->{pvr} || $opt->{pvrsingle} || $opt->{pvrscheduler};
# Delete cookies each session
unlink($cookiejar.'desktop');
unlink($cookiejar.'safari');
unlink($cookiejar.'coremedia');
# Create new PVR instance
# $pvr->{searchname}->{} = ;
my $pvr = Pvr->new();
# Set some class-wide values
$pvr->setvar('pvr_dir', "${profile_dir}/pvr/" );
my $retcode = 0;
# Trim history
if ( defined($opt->{trimhistory}) ) {
my $hist = History->new();
$hist->trim();
# PVR functions
} elsif ( $opt->{pvradd} ) {
if ( ! $opt->{pid} && $no_search_args ) {
main::logger "ERROR: Search term(s) or PID required for recording\n";
exit 1;
}
$pvr->add( $opt->{pvradd}, @search_args );
} elsif ( $opt->{pvrdel} ) {
$pvr->del( $opt->{pvrdel} );
} elsif ( $opt->{pvrdisable} ) {
$pvr->disable( $opt->{pvrdisable} );
} elsif ( $opt->{pvrenable} ) {
$pvr->enable( $opt->{pvrenable} );
} elsif ( $opt->{pvrlist} ) {
$pvr->display_list();
} elsif ( $opt->{pvrqueue} ) {
if ( ! $opt->{pid} && $no_search_args ) {
main::logger "ERROR: Search term(s) or PID required for recording\n";
exit 1;
}
$pvr->queue( @search_args );
} elsif ( $opt->{pvrscheduler} ) {
if ( $opt->{pvrscheduler} < 1800 ) {
main::logger "ERROR: PVR schedule duration must be at least 1800 seconds\n";
unlink $lockfile;
exit 5;
};
# PVR Lockfile detection (with 12 hrs stale lockfile check)
lockfile( 43200 ) if ! $opt->{test};
$pvr->run_scheduler();
} elsif ( $opt->{pvr} ) {
# PVR Lockfile detection (with 12 hrs stale lockfile check)
lockfile( 43200 ) if ! $opt->{test};
$retcode = $pvr->run( @search_args );
unlink $lockfile;
} elsif ( $opt->{pvrsingle} ) {
# PVR Lockfile detection (with 12 hrs stale lockfile check)
lockfile( 43200 ) if ! $opt->{test};
$retcode = $pvr->run( '^'.$opt->{pvrsingle}.'$' );
unlink $lockfile;
# Record prog specified by --pid option
} elsif ( $opt->{pid} ) {
my $hist = History->new();
my @pids = split( /,/, $opt->{pid} );
for ( @pids ) {
$opt->{pid} = $_;
$retcode += find_pid_matches( $hist );
}
# Show history
} elsif ( $opt->{history} ) {
my $hist = History->new();
$hist->list_progs( @search_args );
# Else just process command line args
} else {
if ( $opt->{get} && $no_search_args ) {
main::logger "ERROR: Search term(s) required for recording\n";
exit 1;
}
my $hist = History->new();
$retcode = download_matches( $hist, find_matches( $hist, @search_args ) );
purge_downloaded_files( $hist, 30 );
}
exit $retcode;
sub init_search {
if ( $opt->{keepall} ) {
$opt->{whitespace} = 1;
$opt->{nonascii} = 1;
$opt->{punctuation} = 1;
}
# Set --subtitles if --subsonly is used
if ( $opt->{subsonly} ) {
$opt->{subtitles} = 1;
}
# Set --thumbnail if --thumbonly is used
if ( $opt->{thumbonly} ) {
$opt->{thumb} = 1;
}
# Ensure lowercase types
$opt->{type} = lc( $opt->{type} );
# Expand 'all' type to comma separated list all prog types
$opt->{type} = join( ',', progclass() ) if $opt->{type} =~ /(all|any)/i;
# --stream is the same as --stdout --nowrite
if ( $opt->{stream} ) {
$opt->{nowrite} = 1;
$opt->{stdout} = 1;
delete $opt->{stream};
}
# Force nowrite if metadata/subs/thumb-only
if ( $opt->{metadataonly} || $opt->{subsonly} || $opt->{thumbonly} || $opt->{tagonly} ) {
$opt->{nowrite} = 1;
}
# List all options and where they are set from then exit
if ( $opt_cmdline->{showoptions} ) {
# Show all options andf where set from
$opt_file->display('Options from Files');
$opt_cmdline->display('Options from Command Line');
$opt->display('Options Used');
logger "Search Args: ".join(' ', @search_args)."\n\n";
}
# Web proxy
if ( $opt->{noproxy} ) {
delete $opt->{proxy};
} else {
(my $proxy = $opt->{proxy}) =~ s/^prepend://i;
$opt->{proxy} = $ENV{HTTP_PROXY} || $ENV{http_proxy} if not $opt->{proxy};
logger "INFO: Using Proxy $opt->{proxy}\n" if $opt->{proxy};
$ENV{http_proxy} = $proxy if $proxy;
}
# Set --get && --nowrite if --metadataonly is used
if ( $opt->{metadataonly} ) {
if ( ! $opt->{metadata} ) {
main::logger "ERROR: Please specify metadata type using --metadata=\n";
exit 2;
}
}
# Sanity check some conflicting options
if ( $opt->{nowrite} && ! $opt->{stdout} ) {
if ( ! ( $opt->{metadataonly} || $opt->{subsonly} || $opt->{thumbonly} || $opt->{tagonly} ) ) {
logger "ERROR: Cannot record to nowhere\n";
exit 1;
}
}
# hash of prog types specified
my $type = {};
$type->{$_} = 1 for split /,/, $opt->{type};
# Default to type=tv if no type option is set
$type->{tv} = 1 if keys %{ $type } == 0;
# Sanity check valid --type specified
for (keys %{ $type }) {
if ( not progclass($_) ) {
logger "ERROR: Invalid type '$_' specified. Valid types are: ".( join ',', progclass() )."\n";
exit 3;
}
}
# exit if only showing options
exit 0 if ( $opt_cmdline->{showoptions} );
# Display the ages of the selected caches in seconds
if ( $opt->{showcacheage} ) {
for ( keys %{ $type } ) {
my $cachefile = "${profile_dir}/${_}.cache";
main::logger "INFO: $_ cache age: ".( time() - stat($cachefile)->mtime )." secs\n" if -f $cachefile;
}
exit 0;
}
# Show options
$opt->display('Current options') if $opt->{verbose};
# $prog->{pid}->object hash
my $prog = {};
# obtain prog object given index. e.g. $index_prog->{$index_no}->{element};
my $index_prog = {};
logger "INFO: Search args: '".(join "','", @search_args)."'\n" if $opt->{verbose};
# External Binaries
$bin->{mplayer} = $opt->{mplayer} || 'mplayer';
delete $binopts->{mplayer};
push @{ $binopts->{mplayer} }, '-nolirc';
if ( $opt->{debug} ) {
push @{ $binopts->{mplayer} }, '-v';
} elsif ( $opt->{verbose} ) {
push @{ $binopts->{mplayer} }, '-v';
} elsif ( $opt->{quiet} || $opt->{silent} ) {
push @{ $binopts->{mplayer} }, '-really-quiet';
}
$bin->{ffmpeg} = $opt->{ffmpeg} || 'avconv';
if (! main::exists_in_path('ffmpeg') ) {
$bin->{ffmpeg} = 'ffmpeg';
}
delete $binopts->{ffmpeg};
push @{ $binopts->{ffmpeg} }, ();
if ( ! $opt->{ffmpegobsolete} ) {
if ( $opt->{debug} ) {
push @{ $binopts->{ffmpeg} }, ('-loglevel', 'debug');
} elsif ( $opt->{verbose} ) {
push @{ $binopts->{ffmpeg} }, ('-loglevel', 'verbose');
} elsif ( $opt->{quiet} || $opt->{silent} ) {
push @{ $binopts->{ffmpeg} }, ('-loglevel', 'quiet');
}
}
$bin->{lame} = $opt->{lame} || 'lame';
delete $binopts->{lame};
$binopts->{lame} = '-f';
$binopts->{lame} .= ' --quiet ' if $opt->{quiet} || $opt->{silent} ;
$bin->{vlc} = $opt->{vlc} || 'cvlc';
delete $binopts->{vlc};
push @{ $binopts->{vlc} }, '-vv' if $opt->{debug};
$bin->{id3v2} = $opt->{id3v2} || 'id3v2';
$bin->{atomicparsley} = $opt->{atomicparsley} || 'AtomicParsley';
$bin->{tee} = 'tee';
$bin->{rtmpdump} = $opt->{rtmpdump} || 'rtmpdump';
if (! main::exists_in_path('rtmpdump') ) {
$bin->{rtmpdump} = 'rtmpdump';
}
delete $binopts->{rtmpdump};
push @{ $binopts->{rtmpdump} }, ( '--timeout', 10 );
if ( $opt->{debug} ) {
push @{ $binopts->{rtmpdump} }, '--debug';
} elsif ( $opt->{verbose} ) {
push @{ $binopts->{rtmpdump} }, '--verbose';
} elsif ( $opt->{quiet} || $opt->{silent} ) {
push @{ $binopts->{rtmpdump} }, '--quiet';
}
# quote binaries which allows for spaces in the path (only required if used via a shell)
for ( $bin->{lame}, $bin->{tee} ) {
s!^(.+)$!"$1"!g;
}
# Redirect STDOUT to player command if one is specified
if ( $opt->{player} && $opt->{nowrite} && $opt->{stdout} ) {
open (STDOUT, "| $opt->{player}") || die "ERROR: Cannot open player command\n";
STDOUT->autoflush(1);
binmode STDOUT;
}
return ( $type, $prog, $index_prog );
}
sub find_pid_matches {
my $hist = shift;
my @search_args = @_;
my ( $type, $prog, $index_prog ) = init_search( @search_args );
# Get prog by arbitrary ':' or just '' (using the specified types)(then exit)
my @try_types;
my $pid;
# If $opt->{pid} is in the form of ':' and is a valid type
if ( $opt->{pid} =~ m{^(.+?)\:(.+?)$} && progclass(lc($1)) ) {
my $prog_type;
( $prog_type, $pid )= ( lc($1), $2 );
# Only try to recording using this prog type
@try_types = ($prog_type);
# $opt->{pid} is in the form of ''
} else {
$pid = $opt->{pid};
@try_types = (keys %{ $type });
}
logger "INFO: Will try prog types: ".(join ',', @try_types)."\n" if $opt->{verbose};
return 0 if ( ! ( $opt->{multimode} || $opt->{metadataonly} || $opt->{info} || $opt->{thumbonly} || $opt->{tagonly} || $opt->{subsonly} ) ) && $hist->check( $pid );
# Maybe we don't want to populate caches - this slows down --pid recordings ...
# Populate cache with all specified prog types (strange perl bug?? - @try_types is empty after these calls if done in a $_ 'for' loop!!)
# only get links and possibly refresh caches if > 1 type is specified
# else only load cached data from file if it exists.
my $load_from_file_only;
$load_from_file_only = 1 if $#try_types == 0;
for my $t ( @try_types ) {
get_links( $prog, $index_prog, $t, $load_from_file_only );
}
# Simply record pid if we find it in the caches
if ( $prog->{$pid}->{pid} ) {
return download_pid_in_cache( $hist, $prog->{$pid} );
}
my $totalretcode = 0;
my $quit_attempt = 0;
my %done_pids;
for my $prog_type ( @try_types ) {
last if $quit_attempt;
# See if the specified pid has other episode pids embedded - results in another list of pids.
my $dummy = progclass($prog_type)->new( 'pid' => $pid, 'type' => $prog_type );
my @pids = $dummy->get_pids_recursive();
# Try to get pid using each speficied prog type
# process all pids in @pids
for my $pid ( @pids ) {
# skip this pid if we have already completed it
next if $done_pids{$pid};
main::logger "INFO: Trying pid: $pid using type: $prog_type\n";
my $retcode;
if ( not $prog->{$pid}->{pid} ) {
$retcode = download_pid_not_in_cache( $hist, $pid, $prog_type );
# don't try again for other types because it was recorded successfully
$done_pids{$pid} = 1 if ! $retcode;
} else {
$retcode = download_pid_in_cache( $hist, $prog->{$pid} );
# if it's in the cache then there is no need to try this pid for other types
$done_pids{$pid} = 1;
}
$totalretcode += $retcode;
}
}
# return zero on success of all pid recordings (used for PVR queue)
return $totalretcode;
}
sub download_pid_not_in_cache {
my $hist = shift;
my $pid = shift;
my $prog_type = shift;
my $retcode;
# Force prog type and create new prog instance if it doesn't exist
my $this;
logger "INFO: Trying to stream pid using type $prog_type\n";
logger "INFO: pid not found in $prog_type cache\n";
$this = progclass($prog_type)->new( 'pid' => $pid, 'type' => $prog_type );
# if only one type is specified then we can clean up the pid which might actually be a url
#if ( $#try_types == 0 ) {
logger "INFO: Cleaning pid Old: '$this->{pid}', " if $opt->{verbose};
$this->clean_pid;
logger " New: '$this->{pid}'\n" if $opt->{verbose};
#}
# Display pid match for recording
if ( $opt->{history} ) {
$hist->list_progs( 'pid:'.$pid );
} else {
list_progs( { $this->{type} => 1 }, $this );
}
# Don't do a pid recording if metadataonly or thumbonly were specified
if ( !( $opt->{metadataonly} || $opt->{thumbonly} || $opt->{subsonly} || $opt->{info} ) ) {
return $this->download_retry_loop( $hist );
}
}
sub download_pid_in_cache {
my $hist = shift;
my $this = shift;
my $retcode;
# Prune future scheduled match if not specified
if ( (! $opt->{future}) && Programme::get_time_string( $this->{available} ) > time() ) {
# If the prog object exists with pid in history delete it from the prog list
logger "INFO: Ignoring Future Prog: '$this->{index}: $this->{name} - $this->{episode} - $this->{available}'\n" if $opt->{verbose};
# Don't attempt to download
return 1;
}
logger "INFO Trying to stream pid using type $this->{type}\n";
logger "INFO: pid found in cache\n";
# Display pid match for recording
if ( $opt->{history} ) {
$hist->list_progs( 'pid:'.$this->{pid} );
} else {
list_progs( { $this->{type} => 1 }, $this );
}
# Don't do a pid recording if metadataonly or thumbonly were specified
if ( !( $opt->{metadataonly} || $opt->{thumbonly} || $opt->{subsonly} || $opt->{info} ) ) {
$retcode = $this->download_retry_loop( $hist );
}
return $retcode;
}
# Use the specified options to process the matches in specified array
# Usage: find_matches( $pids_history_ref, @search_args )
# Returns: array of objects to be downloaded
# or: number of failed/remaining programmes to record using the match (excluding previously recorded progs) if --pid is specified
sub find_matches {
my $hist = shift;
my @search_args = @_;
my ( $type, $prog, $index_prog ) = init_search( @search_args );
# We don't actually need to get the links first for the specifiied type(s) if we have only index number specified (and not --list)
my %got_cache;
my $need_get_links = 0;
if ( (! $opt->{list} ) ) {
for ( @search_args ) {
if ( (! /^[\d]+$/) || $_ > $max_index || $_ < 1 ) {
logger "DEBUG: arg '$_' is not a programme index number - load specified caches\n" if $opt->{debug};
$need_get_links = 1;
last;
}
}
}
# Pre-populate caches if --list option used or there was a non-index specified
if ( $need_get_links || $opt->{list} ) {
# Get stream links from web site or from cache (also populates all hashes) specified in --type option
for my $t ( keys %{ $type } ) {
get_links( $prog, $index_prog, $t );
$got_cache{ $t } = 1;
}
}
# Parse remaining args
my @match_list;
my @index_search_args;
for ( @search_args ) {
chomp();
# If Numerical value < $max_index and the object exists from loaded prog types
if ( /^[\d]+$/ && $_ <= $max_index ) {
if ( defined $index_prog->{$_} ) {
logger "INFO: Search term '$_' is an Index value\n" if $opt->{verbose};
push @match_list, $index_prog->{$_};
} else {
# Add to another list to search in other prog types
push @index_search_args, $_;
}
# If PID then find matching programmes with 'pid:'
} elsif ( m{^\s*pid:(.+?)\s*$}i ) {
if ( defined $prog->{$1} ) {
logger "INFO: Search term '$1' is a pid\n" if $opt->{verbose};
push @match_list, $prog->{$1};
} else {
logger "INFO: Search term '$1' is a non-existent pid, use --pid instead and/or specify the correct programme type\n";
}
# Else assume this is a programme name regex
} else {
logger "INFO: Search term '$_' is a substring\n" if $opt->{verbose};
push @match_list, get_regex_matches( $prog, $_ );
}
}
# List elements (i.e. 'channel' 'categories') if required and exit
if ( $opt->{list} ) {
list_unique_element_counts( $type, $opt->{list}, @match_list );
exit 0;
}
# Go get the cached data for other programme types if the index numbers require it
for my $index ( @index_search_args ) {
# see if this index number falls into a valid range for a prog type
for my $prog_type ( progclass() ) {
if ( $index >= progclass($prog_type)->index_min && $index <= progclass($prog_type)->index_max && ( ! $got_cache{$prog_type} ) ) {
logger "DEBUG: Looking for index $index in $prog_type type\n" if $opt->{debug};
# Get extra required programme caches
logger "INFO: Additionally getting cached programme data for $prog_type\n" if $opt->{verbose};
# Add new prog types to the type list
$type->{$prog_type} = 1;
# Get $prog_type stream links
get_links( $prog, $index_prog, $prog_type );
$got_cache{$prog_type} = 1;
}
}
# Now check again if the index number exists in the cache before adding this prog to the match list
if ( defined $index_prog->{$index}->{pid} ) {
push @match_list, $index_prog->{$index} if defined $index_prog->{$index}->{pid};
} else {
logger "WARNING: Unmatched programme index '$index' specified - ignoring\n";
}
}
# De-dup matches and retain order
@match_list = main::make_array_unique_ordered( @match_list );
# Prune out pids already recorded if opt{hide} is specified (cannot hide for multimode)
if ( $opt->{hide} && ( not $opt->{force} ) && ( not $opt->{multimode} ) ) {
my @pruned;
for my $this (@match_list) {
# If the prog object exists with pid in history delete it from the prog list
if ( $hist->check( $this->{pid}, undef, 1 ) ) {
logger "DEBUG: Ignoring Prog: '$this->{index}: $this->{name} - $this->{episode}'\n" if $opt->{debug};
} else {
push @pruned, $this;
}
}
@match_list = @pruned;
}
# Prune future scheduled matches if not specified
if ( ! $opt->{future} ) {
my $now = time();
my @pruned;
for my $this (@match_list) {
# If the prog object exists with pid in history delete it from the prog list
my $available = Programme::get_time_string( $this->{available} );
if ( $available && $available > $now ) {
logger "DEBUG: Ignoring Future Prog: '$this->{index}: $this->{name} - $this->{episode} - $this->{available}'\n" if $opt->{debug};
} else {
push @pruned, $this;
}
}
@match_list = @pruned;
}
# Truncate the array of matches if --limit-matches is specified
if ( $opt->{limitmatches} && $#match_list > $opt->{limitmatches} - 1 ) {
$#match_list = $opt->{limitmatches} - 1;
main::logger "WARNING: The list of matching results was limited to $opt->{limitmatches} by --limit-matches\n";
}
# Display list for recording
list_progs( $type, @match_list );
# Write HTML and XML files if required (with search options applied)
create_html_file( @match_list ) if $opt->{html};
create_html_email( (join ' ', @search_args), @match_list ) if $opt->{email};
create_xml( $opt->{fxd}, @match_list ) if $opt->{fxd};
create_xml( $opt->{mythtv}, @match_list ) if $opt->{mythtv};
return @match_list;
}
sub download_matches {
my $hist = shift;
my @match_list = @_;
# Do the recordings based on list of index numbers if required
my $failcount = 0;
if ( $opt->{get} || $opt->{stdout} ) {
for my $this (@match_list) {
$failcount += $this->download_retry_loop( $hist );
}
}
return $failcount;
}
# Usage: list_progs( \%type, @prog_refs )
# Lists progs given an array of index numbers
sub list_progs {
my $typeref = shift;
# Use a rogue value if undefined
my $number_of_types = keys %{$typeref} || 2;
my $ua = create_ua( 'desktop', 1 );
my %names;
my ( @matches ) = ( @_ );
# Setup user agent for a persistent connection to get programme metadata
if ( $opt->{info} ) {
# Truncate array if were lisiting info and > $info_limit entries are requested - be nice to the beeb!
if ( $#matches >= $info_limit ) {
$#matches = $info_limit - 1;
logger "WARNING: Only processing the first $info_limit matches\n";
}
}
# Sort array by specified field
if ( $opt->{sortmatches} ) {
# disable tree mode
delete $opt->{tree};
# Lookup table for numeric search fields
my %sorttype = (
index => 1,
duration => 1,
timeadded => 1,
);
my $sort_prog;
for my $this ( @matches ) {
# field needs to be made to be unique by adding '|pid'
$sort_prog->{ "$this->{ $opt->{sortmatches} }|$this->{pid}" } = $this;
}
@matches = ();
# Numeric search
if ( defined $sorttype{ $opt->{sortmatches} } ) {
for my $key ( sort {$a <=> $b} keys %{ $sort_prog } ) {
push @matches, $sort_prog->{$key};
}
# alphanumeric search
} else {
for my $key ( sort {lc $a cmp lc $b} keys %{ $sort_prog } ) {
push @matches, $sort_prog->{$key};
}
}
}
# Reverse sort?
if ( $opt->{sortreverse} ) {
my @tmp = reverse @matches;
@matches = @tmp;
}
# Determine number of episodes for each name
my %episodes;
my $episode_width;
if ( $opt->{series} ) {
for my $this (@matches) {
$episodes{ $this->{name} }++;
$episode_width = length( $this->{name} ) if length( $this->{name} ) > $episode_width;
}
}
# Sort display order by field (won't work in tree mode)
# Calculate page sizes etc if required
my $items = $#matches+1;
my ( $pages, $page, $pagesize, $first, $last );
if ( ! $opt->{page} ) {
logger "Matches:\n" if $#matches >= 0;
} else {
$pagesize = $opt->{pagesize} || 25;
# Calc first and last programme numbers
$first = $pagesize * ( $opt->{page} - 1 );
$last = $first + $pagesize;
# How many pages
$pages = int( $items / $pagesize ) + 1;
# If we request a page that is too high
$opt->{page} = $pages if $page > $pages;
logger "Matches (Page $opt->{page}/${pages}".()."):\n" if $#matches >= 0;
}
# loop through all programmes in match
for ( my $count=0; $count < $items; $count++ ) {
my $this = $matches[$count];
# Only display if the prog name is set
if ( ( ! $opt->{page} ) || ( $opt->{page} && $count >= $first && $count < $last ) ) {
if ( $this->{name} || ! ( $opt->{series} || $opt->{tree} ) ) {
# Tree mode
if ( $opt->{tree} ) {
if (! defined $names{ $this->{name} }) {
$this->list_entry( '', 0, $number_of_types );
$names{ $this->{name} } = 1;
} else {
$this->list_entry( '', 1, $number_of_types );
}
# Series mode
} elsif ( $opt->{series} ) {
if (! defined $names{ $this->{name} }) {
$this->list_entry( '', 0, $number_of_types, $episodes{ $this->{name} }, $episode_width );
$names{ $this->{name} } = 1;
}
# Normal mode
} else {
$this->list_entry( '', 0, $number_of_types ) if ( $this->{name} );
}
}
}
# Get info, create metadata, subtitles, tag and/or thumbnail file (i.e. don't stream/record)
if ( $opt->{info} || $opt->{metadataonly} || $opt->{thumbonly} || $opt->{subsonly} || $opt->{tagonly} || $opt->{streaminfo} ) {
$this->get_metadata_general();
if ( $this->get_metadata( $ua ) ) {
main::logger "ERROR: Could not get programme metadata\n" if $opt->{verbose};
next;
}
# Search versions for versionlist versions
my @versions = $this->generate_version_list;
# Use first version in list if a version list is not specified
$this->{version} = $versions[0] || 'default';
$this->generate_filenames( $ua, $this->file_prefix_format() );
# info
$this->display_metadata( sort keys %{ $this } ) if $opt->{info};
# subs (only for tv)
if ( $opt->{subsonly} && $this->{type} eq 'tv') {
$this->create_dir();
$this->download_subtitles( $ua, "$this->{dir}/$this->{fileprefix}.srt" );
}
# metadata
if ( $opt->{metadataonly} ) {
$this->create_dir();
$this->create_metadata_file;
}
# thumbnail
if ( $opt->{thumbonly} && $this->{thumbnail} ) {
$this->create_dir();
$this->download_thumbnail();
}
# tag
if ( $opt->{tagonly} && ! $opt->{notag} ) {
# this probably needs to be initialised earlier - needed for tagging
$bin->{atomicparsley} = $opt->{atomicparsley} || 'AtomicParsley';
$this->create_dir();
$this->tag_file;
}
# streaminfo
if ( $opt->{streaminfo} ) {
main::display_stream_info( $this, $this->{verpids}->{$this->{version}}, $this->{version} );
}
# remove offending metadata
delete $this->{filename};
delete $this->{filepart};
delete $this->{ext};
}
}
logger "\nINFO: ".($#matches + 1)." Matching Programmes\n" if ( $opt->{pvr} && $#matches >= 0 ) || ! $opt->{pvr};
}
# Returns matching programme objects using supplied regex
# Usage: get_regex_matches ( \%prog, $regex )
sub get_regex_matches {
my $prog = shift;
my $download_regex = shift;
my %download_hash;
my ( $channel_regex, $category_regex, $versions_regex, $channel_exclude_regex, $category_exclude_regex, $exclude_regex );
if ( $opt->{channel} ) {
$channel_regex = '('.(join '|', ( split /,/, $opt->{channel} ) ).')';
} else {
$channel_regex = '.*';
}
if ( $opt->{category} ) {
$category_regex = '('.(join '|', ( split /,/, $opt->{category} ) ).')';
} else {
$category_regex = '.*';
}
if ( $opt->{versionlist} ) {
$versions_regex = '('.(join '|', ( split /,/, $opt->{versionlist} ) ).')';
} else {
$versions_regex = '.*';
}
if ( $opt->{excludechannel} ) {
$channel_exclude_regex = '('.(join '|', ( split /,/, $opt->{excludechannel} ) ).')';
} else {
$channel_exclude_regex = '^ROGUE$';
}
if ( $opt->{excludecategory} ) {
$category_exclude_regex = '('.(join '|', ( split /,/, $opt->{excludecategory} ) ).')';
} else {
$category_exclude_regex = '^ROGUE$';
}
if ( $opt->{exclude} ) {
$exclude_regex = '('.(join '|', ( split /,/, $opt->{exclude} ) ).')';
} else {
$exclude_regex = '^ROGUE$';
}
my $since = $opt->{since} || 999999;
my $before = $opt->{before} || -999999;
my $now = time();
if ( $opt->{verbose} ) {
main::logger "DEBUG: Search download_regex = $download_regex\n";
main::logger "DEBUG: Search channel_regex = $channel_regex\n";
main::logger "DEBUG: Search category_regex = $category_regex\n";
main::logger "DEBUG: Search versions_regex = $versions_regex\n";
main::logger "DEBUG: Search exclude_regex = $exclude_regex\n";
main::logger "DEBUG: Search channel_exclude_regex = $channel_exclude_regex\n";
main::logger "DEBUG: Search category_exclude_regex = $category_exclude_regex\n";
main::logger "DEBUG: Search since = $since\n";
main::logger "DEBUG: Search before = $before\n";
}
# Determine fields to search
my @searchfields;
# User-defined fields list
if ( $opt->{fields} ) {
@searchfields = split /\s*,\s*/, lc( $opt->{fields} );
# Also search long descriptions and episode data if -l is specified
} elsif ( $opt->{long} ) {
@searchfields = ( 'name', 'episode', 'desc' );
# Default to name search only
} else {
@searchfields = ( 'name' );
}
# Loop through each prog object
for my $this ( values %{ $prog } ) {
# Only include programmes matching channels and category regexes
if ( $this->{channel} =~ /$channel_regex/i
&& $this->{categories} =~ /$category_regex/i
&& ( ( not defined $this->{versions} ) || $this->{versions} =~ /$versions_regex/i )
&& $this->{channel} !~ /$channel_exclude_regex/i
&& $this->{categories} !~ /$category_exclude_regex/i
&& ( ( not defined $this->{timeadded} ) || $this->{timeadded} >= $now - ($since * 3600) )
&& ( ( not defined $this->{timeadded} ) || $this->{timeadded} < $now - ($before * 3600) )
) {
# Add included matches
my @compund_fields;
push @compund_fields, $this->{$_} for @searchfields;
$download_hash{ $this->{index} } = $this if (join ' ', @compund_fields) =~ /$download_regex/i;
}
}
# Remove excluded matches
for my $field ( @searchfields ) {
for my $index ( keys %download_hash ) {
my $this = $download_hash{$index};
delete $download_hash{$index} if $this->{ $field } =~ /$exclude_regex/i;
}
}
my @match_list;
# Add all matching prog objects to array
for my $index ( sort {$a <=> $b} keys %download_hash ) {
push @match_list, $download_hash{$index};
}
return @match_list;
}
# Usage: sort_index( \%prog, \%index_prog, [$prog_type], [sortfield] )
# Populates the index if the prog hash as well as creating the %index_prog hash
# Should be run after any number of get_links methods
sub sort_index {
my $prog = shift;
my $index_prog = shift;
my $prog_type = shift;
my $sortfield = shift || 'name';
my $counter = 1;
my @sort_key;
# Add index field based on alphabetical sorting by $sortfield
# Start index counter at 'min' for this prog type
$counter = progclass($prog_type)->index_min if defined $prog_type;
# Create unique array of '<$sortfield|pid>' for this prog type
for my $pid ( keys %{$prog} ) {
# skip prog not of correct type and type is defined
next if defined $prog_type && $prog->{$pid}->{type} ne $prog_type;
push @sort_key, "$prog->{$pid}->{$sortfield}|$pid";
}
# Sort by $sortfield and index
for (sort @sort_key) {
# Extract pid
my $pid = (split /\|/)[1];
# Insert prog instance var of the index number
$prog->{$pid}->{index} = $counter;
# Add the object reference into %index_prog hash
$index_prog->{ $counter } = $prog->{$pid};
# Increment the index counter for this prog type
$counter++;
}
return 0;
}
sub make_array_unique_ordered {
# De-dup array and retain order (don't ask!)
my ( @array ) = ( @_ );
my %seen = ();
my @unique = grep { ! $seen{ $_ }++ } @array;
return @unique;
}
# User Agents
# Uses global $ua_cache
my $ua_cache = {};
sub user_agent {
my $id = shift || 'desktop';
# Create user agents lists
my $user_agent = {
update => [ "get_iplayer updater (v${version} - $^O - $^V)" ],
get_iplayer => [ "get_iplayer/$version $^O/$^V" ],
desktop => [
'Mozilla/5.0 (Windows NT 5.1) AppleWebKit/537.17 (KHTML, like Gecko) Chrome/24.0.1312.56 Safari/537.17',
'Mozilla/5.0 (Windows NT 6.1; rv:12.0) Gecko/20100101 Firefox/12.0',
'Opera/9.80 (Windows NT 5.1) Presto/2.12.388 Version/12.12',
'Mozilla/5.0 (Windows NT 7.1; rv:2.0) Gecko/20100101 Firefox/4.0 Opera 12.12',
'Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.0) Opera 12.12',
'Mozilla/5.0 (Windows NT 5.1; rv:18.0) Gecko/20100101 Firefox/18.0',
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_6_8) AppleWebKit/537.13+ (KHTML, like Gecko) Version/5.1.7 Safari/534.57.2',
'Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.1; WOW64; Trident/6.0)',
'Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 7.1; Trident/5.0)',
'Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; WOW64; Trident/5.0; .NET CLR 3.5.30729; .NET CLR 3.0.30729; .NET CLR 2.0.50727; Media Center PC 6.0)',
],
safari => [
'Mozilla/5.0 (iPhone; U; CPU iPhone OS 2_0 like Mac OS X; en-us) AppleWebKit/525.18.1 (KHTML, like Gecko) Version/3.1.1 Mobile/5A345 Safari/525.20',
'Mozilla/5.0 (iPhone; U; CPU iPhone OS 2_0_1 like Mac OS X; en-us) AppleWebKit/525.18.1 (KHTML, like Gecko) Version/3.1.1 Mobile/5B108 Safari/525.20',
'Mozilla/5.0 (iPhone; U; CPU iPhone OS 3_0 like Mac OS X; en-us) AppleWebKit/528.18 (KHTML, like Gecko) Version/4.0 Mobile/7A341 Safari/528.16',
'Mozilla/5.0 (iPhone; U; CPU iPhone OS 3_0_1 like Mac OS X; en-us) AppleWebKit/528.18 (KHTML, like Gecko) Version/4.0 Mobile/7A400 Safari/528.16',
'Mozilla/5.0 (iPhone; U; CPU iPhone OS 3_1_2 like Mac OS X; en-us) AppleWebKit/528.18 (KHTML, like Gecko) Version/4.0 Mobile/7D11 Safari/528.16',
'Mozilla/5.0 (iPhone; U; CPU iPhone OS 3_1_3 like Mac OS X; en-us) AppleWebKit/528.18 (KHTML, like Gecko) Version/4.0 Mobile/7E18 Safari/528.16',
],
coremedia => [
'Apple iPhone v1.1.4 CoreMedia v1.0.0.4A102',
'Apple iPhone v1.1.5 CoreMedia v1.0.0.4B1',
'Apple iPhone OS v2.0 CoreMedia v1.0.0.5A347',
'Apple iPhone OS v2.0.1 CoreMedia v1.0.0.5B108',
'Apple iPhone OS v2.1 CoreMedia v1.0.0.5F136',
'Apple iPhone OS v2.1 CoreMedia v1.0.0.5F137',
'Apple iPhone OS v2.1.1 CoreMedia v1.0.0.5F138',
'Apple iPhone OS v2.2 CoreMedia v1.0.0.5G77',
'Apple iPhone OS v2.2 CoreMedia v1.0.0.5G77a',
'Apple iPhone OS v2.2.1 CoreMedia v1.0.0.5H11',
'Apple iPhone OS v3.0 CoreMedia v1.0.0.7A341',
'Apple iPhone OS v3.1.2 CoreMedia v1.0.0.7D11',
],
};
# Remember the ua string for the entire session
my $uas = $ua_cache->{$id};
if ( ! $uas ) {
# Randomize strings
my @ualist = @{ $user_agent->{$id} };
$uas = $ualist[rand @ualist];
my $code = sprintf( "%03d", int(rand(1000)) );
$uas =~ s//$code/g;
$ua_cache->{$id} = $uas;
}
logger "DEBUG: Using $id user-agent string: '$uas'\n" if $opt->{debug};
return $uas || '';
}
# Returns classname for prog type or if not specified, an array of all prog types
sub progclass {
my $prog_type = shift;
if ( $prog_type ) {
return $prog_types{$prog_type};
} elsif ( not defined $prog_type ) {
return keys %prog_types;
} else {
main::logger "ERROR: Programe Type '$prog_type' does not exist. Try using --refresh\n";
exit 3;
}
}
# Returns classname for prog type or if not specified, an array of all prog types
sub is_prog_type {
my $prog_type = shift;
return 1 if defined $prog_types{$prog_type};
return 0;
}
# Feed Info:
# # aod index
# http://www.bbc.co.uk/radio/aod/index_noframes.shtml
# # schedule feeds
# http://www.bbc.co.uk/bbcthree/programmes/schedules.xml
# # These need drill-down to get episodes:
# # TV schedules by date
# http://www.bbc.co.uk/iplayer/widget/schedule/service/cbeebies/date/20080704
# # TV schedules in JSON, Yaml or XML
# http://www.bbc.co.uk//programmes/schedules.(json|yaml|xml)
# # prog schedules by channel / date
# http://www.bbc.co.uk//programmes/schedules/(this_week|next_week|last_week|yesterday|today|tomorrow).(json|yaml|xml)
# http://www.bbc.co.uk//programmes/schedules///[/ataglance].(json|yaml|xml)
# http://www.bbc.co.uk//programmes/schedules//.(json|yaml|xml)
# # TV index on programmes tv
# http://www.bbc.co.uk/tv/programmes/a-z/by/*/player
# # TV + Radio
# http://www.bbc.co.uk/programmes/a-z/by/*/player
# # All TV (limit has effect of limiting to 2.? times number entries kB??)
# # seems that only around 50% of progs are available here compared to programmes site:
# http://feeds.bbc.co.uk/iplayer/categories/tv/list/limit/200
# # Search feed
# http://feeds.bbc.co.uk/iplayer///list
# # All Radio
# http://feeds.bbc.co.uk/iplayer/categories/radio/list/limit/999
# # New:
# # iCal feeds see: http://www.bbc.co.uk/blogs/radiolabs/2008/07/some_ical_views_onto_programme.shtml
# http://bbc.co.uk/programmes/b0079cmw/episodes/player.ics
# # Other data
# http://www.bbc.co.uk/cbbc/programmes/genres/childrens/player
# http://www.bbc.co.uk/programmes/genres/childrens/schedules/upcoming.ics
#
# Usage: get_links( \%prog, \%index_prog, , )
# Globals: $memcache
sub get_links {
my $prog = shift;
my $index_prog = shift;
my $prog_type = shift;
my $only_load_from_cache = shift;
# Define cache file format (this is overridden by the header line of the cache file)
my @cache_format = qw/index type name pid available episode seriesnum episodenum versions duration desc channel categories thumbnail timeadded guidance web/;
my $now = time();
my $cachefile = "${profile_dir}/${prog_type}.cache";
# Read cache into $pid_old and $index_prog_old hashes if cache exists
my $prog_old = {};
my $index_prog_old = {};
# By pass re-sorting and get straight from memcache if possible
if ( keys %{ $memcache->{$prog_type} } && -f $cachefile && ! $opt->{refresh} ) {
for my $pid ( keys %{ $memcache->{$prog_type} } ) {
# Create new prog instance
$prog->{$pid} = progclass( lc($memcache->{$prog_type}->{$pid}->{type}) )->new( 'pid' => $pid );
# Deep-copy of elements in memcache prog instance to %prog
$prog->{$pid}->{$_} = $memcache->{$prog_type}->{$pid}->{$_} for @cache_format;
# Copy object reference into index_prog hash
$index_prog->{ $prog->{$pid}->{index} } = $prog->{$pid};
}
logger "INFO: Got (quick) ".(keys %{ $memcache->{$prog_type} })." memcache entries for $prog_type\n" if $opt->{verbose};
return 0;
}
# Open cache file (need to verify we can even read this)
if ( -f $cachefile && open(CACHE, "< $cachefile") ) {
my @cache_format_old = @cache_format;
# Get file format and contents less any comments
while () {
chomp();
# Get cache format if specified
if ( /^\#(.+?\|){3,}/ ) {
@cache_format_old = split /[\#\|]/;
shift @cache_format_old;
logger "INFO: Cache format from existing $prog_type cache file: ".(join ',', @cache_format_old)."\n" if $opt->{debug};
next;
}
# Ignore comments
next if /^[\#\s]/;
# Populate %prog_old from cache
# Get cache line
my @record = split /\|/;
my $record_entries;
# Update fields in %prog_old hash for $pid
$record_entries->{$_} = shift @record for @cache_format_old;
$prog_old->{ $record_entries->{pid} } = $record_entries;
# Copy pid into index_prog_old hash
$index_prog_old->{ $record_entries->{index} } = $record_entries->{pid};
}
close (CACHE);
logger "INFO: Got ".(keys %{ $prog_old })." file cache entries for $prog_type\n" if $opt->{verbose};
# Else no mem or file cache
} else {
logger "INFO: No file cache exists for $prog_type\n" if $opt->{verbose};
}
# Do we need to refresh the cache ?
# if a cache file doesn't exist/corrupted/empty, refresh option is specified or original file is older than $cache_sec then download new data
my $cache_secs = $opt->{expiry} || main::progclass( $prog_type )->expiry() || 14400;
main::logger "DEBUG: Cache expiry time for $prog_type is ${cache_secs} secs - refresh in ".( stat($cachefile)->mtime + $cache_secs - $now )." secs\n" if $opt->{debug} && -f $cachefile && ! $opt->{refresh};
if ( (! $only_load_from_cache) &&
( (! keys %{ $prog_old } ) || (! -f $cachefile) || $opt->{refresh} || ($now >= ( stat($cachefile)->mtime + $cache_secs )) )
) {
# Get links for specific type of programme class into %prog
if ( progclass( $prog_type )->get_links( $prog, $prog_type ) != 0 ) {
# failed - leave cache unchanged
main::logger "ERROR: Errors encountered when retrieving $prog_type programmes - skipping\n";
return 0;
}
# Sort index for this prog type from cache file
# sorts and references %prog objects into %index_prog
sort_index( $prog, $index_prog, $prog_type );
# Open cache file for writing
unlink $cachefile;
my $now = time();
if ( open(CACHE, "> $cachefile") ) {
print CACHE "#".(join '|', @cache_format)."\n";
# loop through all progs just obtained through get_links above (in numerical index order)
for my $index ( sort {$a <=> $b} keys %{$index_prog} ) {
# prog object
my $this = $index_prog->{ $index };
# Only write entries for correct prog type
if ( $this->{type} eq $prog_type ) {
# Merge old and new data to retain timestamps
# if the entry was in old cache then retain timestamp from old entry
if ( $prog_old->{ $this->{pid} }->{timeadded} ) {
$this->{timeadded} = $prog_old->{ $this->{pid} }->{timeadded};
# Else this is a new entry
} else {
$this->{timeadded} = $now;
$this->list_entry( 'Added: ' ) unless $opt->{quiet};
}
# Write each field into cache line
print CACHE $this->{$_}.'|' for @cache_format;
print CACHE "\n";
}
}
close (CACHE);
} else {
logger "WARNING: Couldn't open cache file '$cachefile' for writing\n";
}
# Copy new progs into memcache
for my $index ( keys %{ $index_prog } ) {
my $pid = $index_prog->{ $index }->{pid};
# Update fields in memcache from %prog hash for $pid
$memcache->{$prog_type}->{$pid}->{$_} = $index_prog->{$index}->{$_} for @cache_format;
}
# purge pids in memcache that aren't in %prog
for my $pid ( keys %{ $memcache->{$prog_type} } ) {
if ( ! defined $prog->{$pid} ) {
delete $memcache->{$prog_type}->{$pid};
main::logger "DEBUG: Removed PID $pid from memcache\n" if $opt->{debug};
}
}
# Else copy data from existing cache file into new prog instances and memcache
} else {
for my $pid ( keys %{ $prog_old } ) {
# Create new prog instance
$prog->{$pid} = progclass( lc($prog_old->{$pid}->{type}) )->new( 'pid' => $pid );
# Deep-copy the data from %prog_old into %prog and $memcache->{$prog_type}
for (@cache_format) {
$prog->{$pid}->{$_} = $prog_old->{$pid}->{$_};
# Update fields in memcache from %prog_old hash for $pid
$memcache->{$prog_type}->{$pid}->{$_} = $prog_old->{$pid}->{$_};
}
}
# Add prog objects to %index_prog hash
$index_prog->{$_} = $prog->{ $index_prog_old->{$_} } for keys %{ $index_prog_old };
}
return 0;
}
# Generic
# Returns an offset timestamp given an srt begin or end timestamp and offset in ms
sub subtitle_offset {
my ( $timestamp, $offset ) = @_;
my ( $hr, $min, $sec, $ms ) = split /[:,\.]/, $timestamp;
# split into hrs, mins, secs, ms
my $ts = $ms + $sec*1000 + $min*60*1000 + $hr*60*60*1000 + $offset;
$hr = int( $ts/(60*60*1000) );
$ts -= $hr*60*60*1000;
$min = int( $ts/(60*1000) );
$ts -= $min*60*1000;
$sec = int( $ts/1000 );
$ts -= $sec*1000;
$ms = $ts;
return sprintf( '%02d:%02d:%02d,%03d', $hr, $min, $sec, $ms );
}
# Generic
sub display_stream_info {
my ($prog, $verpid, $version) = (@_);
# default version is 'default'
$version = 'default' if not defined $verpid;
# Get stream data if not defined
if ( not defined $prog->{streams}->{$version} ) {
logger "INFO: Getting media stream metadata for $prog->{name} - $prog->{episode}, $verpid ($version)\n" if $prog->{pid};
$prog->{streams}->{$version} = $prog->get_stream_data( $verpid );
}
for my $prog_type ( sort keys %{ $prog->{streams}->{$version} } ) {
logger "stream: $prog_type\n";
for my $entry ( sort keys %{ $prog->{streams}->{$version}->{$prog_type} } ) {
logger sprintf("%-11s %s\n", $entry.':', $prog->{streams}->{$version}->{$prog_type}->{$entry} );
}
logger "\n";
}
return 0;
}
sub proxy_disable {
my $ua = shift;
$ua->proxy( ['http'] => undef );
$proxy_save = $opt->{proxy};
delete $opt->{proxy};
main::logger "INFO: Disabled proxy: $proxy_save\n" if $opt->{verbose};
}
sub proxy_enable {
my $ua = shift;
$ua->proxy( ['http'] => $opt->{proxy} ) if $opt->{proxy} && $opt->{proxy} !~ /^prepend:/;
$opt->{proxy} = $proxy_save;
main::logger "INFO: Restored proxy to $opt->{proxy}\n" if $opt->{verbose};
}
# Generic
# Usage download_block($file, $url_2, $ua, $start, $end, $file_len, $fh);
# ensure filehandle $fh is open in append mode
# or, $content = download_block(undef, $url_2, $ua, $start, $end, $file_len);
# Called in 4 ways:
# 1) write to real file => download_block($file, $url_2, $ua, $start, $end, $file_len, $fh);
# 2) write to real file + STDOUT => download_block($file, $url_2, $ua, $start, $end, $file_len, $fh); + $opt->{stdout}==true
# 3) write to STDOUT only => download_block($file, $url_2, $ua, $start, $end, $file_len, $fh); + $opt->{stdout}==true + $opt->{nowrite}==false
# 4) write to memory (and return data) => download_block(undef, $url_2, $ua, $start, $end, $file_len, undef);
# 4) write to memory (and return data) => download_block(undef, $url_2, $ua, $start, $end);
sub download_block {
my ($file, $url, $ua, $start, $end, $file_len, $fh) = @_;
my $orig_length;
my $buffer;
my $lastpercent = 0;
my $now = time();
# If this is an 'append to file' mode call
if ( defined $file && $fh && (!$opt->{nowrite}) ) {
# Stage 3b: Record File
$orig_length = tell $fh;
logger "INFO: Appending to $file\n" if $opt->{verbose};
}
# Setup request headers
my $h = new HTTP::Headers(
'User-Agent' => main::user_agent( 'coremedia' ),
'Accept' => '*/*',
'Range' => "bytes=${start}-${end}",
);
# Use url prepend if required
if ( defined $opt->{proxy} && $opt->{proxy} =~ /^prepend:/ ) {
$url = $opt->{proxy}.main::url_encode( $url );
$url =~ s/^prepend://g;
}
my $req = HTTP::Request->new ('GET', $url, $h);
# Set time to use for download rate calculation
# Define callback sub that gets called during download request
# This sub actually writes to the open output file and reports on progress
my $callback = sub {
my ($data, $res, undef) = @_;
# Don't write the output to the file if there is no content-length header
return 0 if ( ! $res->header("Content-Length") );
# If we don't know file length in advanced then set to size reported reported from server upon download
$file_len = $res->header("Content-Length") + $start if ! defined $file_len;
# Write output
print $fh $data if ! $opt->{nowrite};
print STDOUT $data if $opt->{stdout};
# return if streaming to stdout - no need for progress
return if $opt->{stdout} && $opt->{nowrite};
return if $opt->{quiet} || $opt->{silent};
# current file size
my $size = tell $fh;
# Download percent
my $percent = 100.0 * $size / $file_len;
# Don't update display if we haven't dowloaded at least another 0.1%
if ( not $opt->{hash} ) {
return if ($percent - $lastpercent) < 0.1;
} else {
return if ($percent - $lastpercent) < 1;
}
$lastpercent = $percent;
if ( $opt->{hash} ) {
logger '#';
} else {
# download rates in bytes per second and time remaining
my $rate_bps;
my $rate;
my $time;
my $timecalled = time();
if ($timecalled - $now < 1) {
$rate = '-----kbps';
$time = '--:--:--';
} else {
$rate_bps = ($size - $orig_length) / ($timecalled - $now);
$rate = sprintf("%5.0fkbps", (8.0 / 1024.0) * $rate_bps);
$time = sprintf("%02d:%02d:%02d", ( gmtime( ($file_len - $size) / $rate_bps ) )[2,1,0] );
}
logger sprintf "%8.2fMB / %.2fMB %s %5.1f%%, %s remaining \r",
$size / 1024.0 / 1024.0,
$file_len / 1024.0 / 1024.0,
$rate,
$percent,
$time,
;
}
};
my $callback_memory = sub {
my ($data, $res, undef) = @_;
# append output to buffer
$buffer .= $data;
return if $opt->{quiet} || $opt->{silent};
# current buffer size
my $size = length($buffer);
# download rates in bytes per second
my $timecalled = time();
my $rate_bps;
my $rate;
my $time;
my $percent;
# If we can get Content_length then display full progress
if ($res->header("Content-Length")) {
$file_len = $res->header("Content-Length") if ! defined $file_len;
# Download percent
$percent = 100.0 * $size / $file_len;
if ( not $opt->{hash} ) {
return if ($percent - $lastpercent) < 0.1;
} else {
return if ($percent - $lastpercent) < 1;
}
$lastpercent = $percent;
if ( $opt->{hash} ) {
logger '#';
} else {
# Block length
$file_len = $res->header("Content-Length");
if ($timecalled - $now < 0.1) {
$rate = '-----kbps';
$time = '--:--:--';
} else {
$rate_bps = $size / ($timecalled - $now);
$rate = sprintf("%5.0fkbps", (8.0 / 1024.0) * $rate_bps );
$time = sprintf("%02d:%02d:%02d", ( gmtime( ($file_len - $size) / $rate_bps ) )[2,1,0] );
}
# time remaining
logger sprintf "%8.2fMB / %.2fMB %s %5.1f%%, %s remaining \r",
$size / 1024.0 / 1024.0,
$file_len / 1024.0 / 1024.0,
$rate,
$percent,
$time,
;
}
# Just used simple for if we cannot determine content length
} else {
if ($timecalled - $now < 0.1) {
$rate = '-----kbps';
} else {
$rate = sprintf("%5.0fkbps", (8.0 / 1024.0) * $size / ($timecalled - $now) );
}
logger sprintf "%8.2fMB %s \r", $size / 1024.0 / 1024.0, $rate;
}
};
# send request
logger "\nINFO: Downloading range ${start}-${end}\n" if $opt->{verbose};
logger "\r \r" if not $opt->{hash};
my $res;
# If $fh undefined then get block to memory (fh always defined for stdout or file d/load)
if (defined $fh) {
logger "DEBUG: writing stream to stdout, Range: $start - $end of $url\n" if $opt->{verbose} && $opt->{stdout};
logger "DEBUG: writing stream to $file, Range: $start - $end of $url\n" if $opt->{verbose} && !$opt->{nowrite};
$res = $ua->request($req, $callback);
if ( (! $res->is_success) || (! $res->header("Content-Length")) ) {
logger "ERROR: Failed to Download block\n\n";
return 5;
}
logger "INFO: Content-Length = ".$res->header("Content-Length")." \n" if $opt->{verbose};
return 0;
# Memory Block
} else {
logger "DEBUG: writing stream to memory, Range: $start - $end of $url\n" if $opt->{debug};
$res = $ua->request($req, $callback_memory);
if ( (! $res->is_success) ) {
logger "ERROR: Failed to Download block\n\n";
return '';
} else {
return $buffer;
}
}
}
# Generic
# create_ua( |'', [] )
# cookie mode: 0: retain cookies
# 1: no cookies
# 2: retain cookies but discard if site requires it
sub create_ua {
my $id = shift || '';
my $nocookiejar = shift || 0;
# Use either the key from the function arg if it exists or a random ua string
my $agent = main::user_agent( $id ) || main::user_agent( 'desktop' );
my $ua = LWP::UserAgent->new;
$ua->timeout( $lwp_request_timeout );
$ua->proxy( ['http'] => $opt->{proxy} ) if $opt->{proxy} && $opt->{proxy} !~ /^prepend:/;
$ua->agent( $agent );
# Using this slows down stco parsing!!
#$ua->default_header( 'Accept-Encoding', 'gzip,deflate' );
$ua->conn_cache(LWP::ConnCache->new());
#$ua->conn_cache->total_capacity(50);
$ua->cookie_jar( HTTP::Cookies->new( file => $cookiejar.$id, autosave => 1, ignore_discard => 1 ) ) if not $nocookiejar;
$ua->cookie_jar( HTTP::Cookies->new( file => $cookiejar.$id, autosave => 1 ) ) if $nocookiejar == 2;
main::logger "DEBUG: Using ".($nocookiejar ? "NoCookies " : "cookies.$id " )."user-agent '$agent'\n" if $opt->{debug};
return $ua;
};
# Generic
# Converts a string of chars to it's HEX representation
sub get_hex {
my $buf = shift || '';
my $ret = '';
for (my $i=0; $i{verbose};
return $ret;
}
# Generic
# version of unix tee
# Usage tee ($infile, $outfile)
# If $outfile is undef then just cat file to STDOUT
sub tee {
my ( $infile, $outfile ) = @_;
# Open $outfile for writing, $infile for reading
if ( $outfile) {
if ( ! open( OUT, "> $outfile" ) ) {
logger "ERROR: Could not open $outfile for writing\n";
return 1;
} else {
logger "INFO: Opened $outfile for writing\n" if $opt->{verbose};
}
}
if ( ! open( IN, "< $infile" ) ) {
logger "ERROR: Could not open $infile for reading\n";
return 2;
} else {
logger "INFO: Opened $infile for reading\n" if $opt->{verbose};
}
# Read and redirect IN
while ( ) {
print $_;
print OUT $_ if $outfile;
}
# Close output file
close OUT if $outfile;
close IN;
return 0;
}
# Generic
# Usage: $fh = open_file_append($filename);
sub open_file_append {
local *FH;
my $file = shift;
# Just in case we actually write to the file - make this /dev/null
$file = File::Spec->devnull() if $opt->{nowrite};
if ($file) {
if ( ! open(FH, ">>:raw", $file) ) {
logger "ERROR: Cannot write or append to $file\n\n";
exit 1;
}
}
# Fix for binary - needed for Windows
binmode FH;
return *FH;
}
# Generic
# Updates and overwrites this script - makes backup as .old
# Update logic:
# If the get_iplayer script is unwritable then quit - makes it harder for deb/rpm installed scripts to be overwritten
# If any available plugins in $plugin_dir_system are not writable then abort
# If all available plugins in $plugin_dir_system are writable then:
# if any available plugins in $plugin_dir_user are not writable then abort
# if all available plugins in $plugin_dir_user are writable then:
# update script
# update matching plugins in $plugin_dir_system
# update matching plugins in $plugin_dir_user
# warn of any plugins that are not in $plugin_dir_system or $plugin_dir_user and not available
sub update_script {
my $version_url = 'http://www.infradead.org/get_iplayer/VERSION-get_iplayer';
my $update_url = 'http://www.infradead.org/get_iplayer/';
my $changelog_url = 'http://www.infradead.org/get_iplayer/CHANGELOG-get_iplayer';
my $latest_ver;
# Get version URL
my $script_file = $0;
my $script_url;
my %plugin_url;
my $ua = create_ua( 'update', 1 );
# Are we flagged as installed using a pkg manager?
if ( $opt->{packagemanager} ) {
if ( $opt->{packagemanager} =~ /installer/i ) {
logger "ERROR: get_iplayer should only be updated using the Windows installer: http://www.infradead.org/get_iplayer_win/get_iplayer_setup_latest.exe\n";
} elsif ( $opt->{packagemanager} =~ /disable/i ) {
logger "ERROR: get_iplayer should only be updated using your local package management system. Please refer to your system documentation.\n";
} else {
logger "ERROR: get_iplayer was installed using the '$opt->{packagemanager}' package manager. Please refer to the package manager documentation.\n";
}
exit 1;
}
# Force update if no plugins dir
if ( ! -d "$profile_dir/plugins" ) {
mkpath "$profile_dir/plugins";
if ( ! -d "$profile_dir/plugins" ) {
logger "ERROR: Cannot create '$profile_dir/plugins' - no plugins will be downloaded.\n";
return 1;
}
$opt->{pluginsupdate} = 1;
}
logger "INFO: Current version is ".(sprintf '%.2f', $version)."\n";
logger "INFO: Checking for latest version from www.infradead.org\n";
if ( $latest_ver = request_url_retry($ua, $version_url, 3 ) ) {
chomp($latest_ver);
# Compare version numbers
if ( $latest_ver > $version || $opt->{force} || $opt->{pluginsupdate} ) {
# reformat version number
$latest_ver = sprintf('%.2f', $latest_ver);
logger "INFO: Newer version $latest_ver available\n" if $latest_ver > $version;
# Get the manifest of files to be updated
my $base_url = "${update_url}/${latest_ver}";
my $res;
if ( not $res = request_url_retry($ua, "${update_url}/MANIFEST.v${latest_ver}", 3 ) ) {
logger "ERROR: Failed to obtain update file manifest - Update aborted\n";
exit 3;
}
# get a list of plugins etc from the manifest
for ( split /\n/, $res ) {
chomp();
my ( $type, $url) = split /\s/;
if ( $type eq 'bin' ) {
$script_url = $url;
} elsif ( $type eq 'plugins' ) {
my $filename = $url;
$filename =~ s|^.+/(.+?)$|$1|g;
$plugin_url{$filename} = $url;
}
}
# Now decide whether to update based on write permissions
# %plugin_files: contains hash of current full_path_to_plugin_file -> plugin_filename
# %plugin_url: contains a hash of plugin_filename -> update_url for available plugins from the update site
# If any available plugins in $plugin_dir_system are not writable then abort
# if any available plugins in $plugin_dir_user are not writable then abort
# loop through each currently installed plugin
for my $path ( keys %plugin_files ) {
my $file = $plugin_files{$path};
# If this in the list of available plugins
if ( $plugin_url{$file} ) {
if ( ! -w $path ) {
logger "ERROR: Cannot write plugin $path - aborting update\n";
exit 1;
}
# warn of any plugins that are not in $plugin_dir_system or $plugin_dir_user and not available
} else {
logger "WARNING: Plugin $path is not managed - not updating this plugin\n";
}
}
# All available plugins in all plugin dirs are writable:
# update script if required
if ( $latest_ver > $version || $opt->{force} ) {
# If the get_iplayer script is unwritable then quit - makes it harder for deb/rpm installed scripts to be overwritten
if ( ! -w $script_file ) {
logger "ERROR: $script_file is not writable - aborting update (maybe a package manager was used to install get_iplayer?)\n";
exit 1;
}
logger "INFO: Updating $script_file (from $version to $latest_ver)\n";
update_file( $ua, $script_url, $script_file ) if ! $opt->{test};
}
for my $path ( keys %plugin_files ) {
my $file = $plugin_files{$path};
# If there is an update available for this plugin file...
if ( $plugin_url{$file} ) {
logger "INFO: Updating $path\n";
# update matching plugin
update_file( $ua, $plugin_url{$file}, $path ) if ! $opt->{test};
}
}
# Install plugins which are currently not installed
for my $file ( keys %plugin_url ) {
# Not found in either system or user plugins dir
if ( ( ! -f "$plugin_dir_system/$file" ) && ( ! -f "$plugin_dir_user/$file" ) ) {
logger "INFO: Found new plugin $file\n";
# Is the system plugin dir writable?
if ( -d $plugin_dir_system && -w $plugin_dir_system ) {
logger "INFO: Installing $file in $plugin_dir_system\n";
update_file( $ua, $plugin_url{$file}, "$plugin_dir_system/$file" ) if ! $opt->{test};
} elsif ( -d $plugin_dir_user && -w $plugin_dir_user ) {
logger "INFO: Installing $file in $plugin_dir_user\n";
update_file( $ua, $plugin_url{$file}, "$plugin_dir_user/$file" ) if ! $opt->{test};
} else {
logger "INFO: Cannot install $file, plugin dirs are not writable\n";
}
}
}
# Show changelog since last version if this is an upgrade
if ( $version < $latest_ver ) {
logger "INFO: Change Log: ${changelog_url}\n";
my $changelog = request_url_retry($ua, $changelog_url, 3 );
my $current_ver = sprintf('%.2f', $version);
$changelog =~ s|^(.*)Version\s+$current_ver.+$|$1|s;
logger "INFO: Changes since version $current_ver:\n\n$changelog\n";
}
} else {
logger "INFO: No update is necessary (latest version = $latest_ver)\n";
}
} else {
logger "ERROR: Failed to connect to update site - Update aborted\n";
exit 2;
}
exit 0;
}
# Updates a file:
# Usage: update_file( , , )
sub update_file {
my $ua = shift;
my $url = shift;
my $dest_file = shift;
my $res;
# Download the file
if ( not $res = request_url_retry($ua, $url, 3) ) {
logger "ERROR: Could not download update for ${dest_file} - Update aborted\n";
exit 1;
}
# If the download was successful then copy over this file and make executable after making a backup of this script
if ( -f $dest_file ) {
if ( ! copy($dest_file, $dest_file.'.old') ) {
logger "ERROR: Could not create backup file ${dest_file}.old - Update aborted\n";
exit 1;
}
}
# Check if file is writable
if ( not open( FILE, "> $dest_file" ) ) {
logger "ERROR: $dest_file is not writable by the current user - Update aborted\n";
exit 1;
}
# Windows needs this
binmode FILE;
# Write contents to file
print FILE $res;
close FILE;
chmod 0755, $dest_file;
logger "INFO: Downloaded $dest_file\n";
}
# Usage: create_xml( @prog_objects )
# Creates the Freevo FXD or MythTV Streams meta data (and pre-downloads graphics - todo)
sub create_xml {
my $xmlfile = shift;
if ( ! open(XML, "> $xmlfile") ) {
logger "ERROR: Couldn't open xml file $xmlfile for writing\n";
return 1;
}
print XML "\n";
print XML "\n" if $opt->{fxd};
print XML "\n" if $opt->{mythtv};
if ( $opt->{xmlnames} ) {
# containers sorted by prog names
print XML "\t\n" if $opt->{fxd};
my %program_index;
my %program_count;
# create hash of programme_name -> index
for my $this (@_) {
$program_index{ $this->{name} } = $_;
$program_count{ $this->{name} }++;
}
for my $name ( sort keys %program_index ) {
print XML "\t\t"\'' )." ($program_count{$name})\">\n" if $opt->{fxd};
print XML "\t\n" if $opt->{mythtv};
print XML "\t\t".encode_entities( $name, '&<>"\'' )." \n" if $opt->{mythtv};
for my $this (@_) {
my $pid = $this->{pid};
# loop through and find matches for each progname
if ( $this->{name} eq $name ) {
my $episode = encode_entities( $this->{episode}, '&<>"\'' );
my $desc = encode_entities( $this->{desc}, '&<>"\'' );
my $title = "${episode}";
$title .= " ($this->{available})" if $this->{available} !~ /^(unknown|)$/i;
if ( $opt->{fxd} ) {
print XML "\t\t\t\n";
print XML "\t\t\t\t\n";
print XML "\t\t\t\t\t${pid}.mov \n";
print XML "\t\t\t\t \n";
print XML "\t\t\t\t\n";
print XML "\t\t\t\t\t${desc} \n";
print XML "\t\t\t\t \n";
print XML "\t\t\t \n";
} elsif ( $opt->{mythtv} ) {
print XML "\t\t\n";
print XML "\t\t\t${title} \n";
print XML "\t\t\t$this->{type} \n";
print XML "\t\t\t$this->{index} \n";
print XML "\t\t\t${pid}.mov \n";
print XML "\t\t\t \n";
print XML "\t\t\t${desc} \n";
print XML "\t\t\t$this->{thumbnail} \n";
print XML "\t\t \n";
}
}
}
print XML "\t\t \n" if $opt->{fxd};
print XML "\t\n" if $opt->{mythtv};
}
print XML "\t \n" if $opt->{fxd};
}
if ( $opt->{xmlchannels} ) {
# containers for prog names sorted by channel
print XML "\t\n" if $opt->{fxd};
my %program_index;
my %program_count;
my %channels;
# create hash of unique channel names and hash of programme_name -> index
for my $this (@_) {
$program_index{ $this->{name} } = $_;
$program_count{ $this->{name} }++;
push @{ $channels{ $this->{channel} } }, $this->{name};
}
for my $channel ( sort keys %channels ) {
print XML "\t\t"\'' )."\">\n" if $opt->{fxd};
print XML
"\t\n".
"\t\t".encode_entities( $channel, '&<>"\'' )." \n".
"\t\tBBC \n".
"\t\t\n" if $opt->{mythtv};
for my $name ( sort keys %program_index ) {
# Do we have any of this prog $name on this $channel?
my $match;
for ( @{ $channels{$channel} } ) {
$match = 1 if $_ eq $name;
}
if ( $match ) {
print XML "\t\t\t"\'' )." ($program_count{$name})\">\n" if $opt->{fxd};
#print XML "\t\t\n" if $opt->{mythtv};
for my $this (@_) {
# loop through and find matches for each progname for this channel
my $pid = $this->{pid};
if ( $this->{channel} eq $channel && $this->{name} eq $name ) {
my $episode = encode_entities( $this->{episode}, '&<>"\'' );
my $desc = encode_entities( $this->{desc}, '&<>"\'' );
my $title = "${episode} ($this->{available})";
if ( $opt->{fxd} ) {
print XML
"\t\t\t\t\n".
"\t\t\t\t\t\n".
"\t\t\t\t\t\t${pid}.mov \n".
"\t\t\t\t\t \n".
"\t\t\t\t\t\n".
"\t\t\t\t\t\t${desc} \n".
"\t\t\t\t\t \n".
"\t\t\t\t \n";
} elsif ( $opt->{mythtv} ) {
print XML
"\t\t\t\n".
"\t\t\t\t".encode_entities( $name, '&<>"\'' )." \n".
"\t\t\t\t$this->{index} \n".
"\t\t\t\t$this->{type} \n".
"\t\t\t\t${pid}.mov \n".
"\t\t\t\t$this->{thumbnail} \n".
"\t\t\t\t${episode} \n".
"\t\t\t\t${desc} \n".
"\t\t\t \n";
}
}
}
print XML "\t\t\t \n" if $opt->{fxd};
}
}
print XML "\t\t \n" if $opt->{fxd};
print XML "\t\t\n\t\n" if $opt->{mythtv};
}
print XML "\t \n" if $opt->{fxd};
}
if ( $opt->{xmlalpha} ) {
my %table = (
'A-C' => '[abc]',
'D-F' => '[def]',
'G-I' => '[ghi]',
'J-L' => '[jkl]',
'M-N' => '[mn]',
'O-P' => '[op]',
'Q-R' => '[qr]',
'S-T' => '[st]',
'U-V' => '[uv]',
'W-Z' => '[wxyz]',
'0-9' => '[\d]',
);
print XML "\t\n";
for my $folder (sort keys %table) {
print XML "\t\t\n";
for my $this (@_) {
my $pid = $this->{pid};
my $name = encode_entities( $this->{name}, '&<>"\'' );
my $episode = encode_entities( $this->{episode}, '&<>"\'' );
my $desc = encode_entities( $this->{desc}, '&<>"\'' );
my $title = "${name} - ${episode} ($this->{available})";
my $regex = $table{$folder};
if ( $name =~ /^$regex/i ) {
if ( $opt->{fxd} ) {
print XML
"\t\t\t\n".
"\t\t\t\t\n".
"\t\t\t\t\t${pid}.mov \n".
"\t\t\t\t \n".
"\t\t\t\t\n".
"\t\t\t\t\t${desc} \n".
"\t\t\t\t \n".
"\t\t\t \n";
} elsif ( $opt->{mythtv} ) {
print XML
"\t\t\t\n".
"\t\t\t\t${title} \n".
"\t\t\t\t$this->{index} \n".
"\t\t\t\t$this->{type} \n".
"\t\t\t\t${pid}.mov \n".
"\t\t\t\t$this->{thumbnail} \n".
"\t\t\t\t${episode} \n".
"\t\t\t\t${desc} \n".
"\t\t\t \n";
}
}
}
print XML "\t\t \n";
}
print XML "\t \n";
}
print XML ' ' if $opt->{fxd};
print XML '' if $opt->{mythtv};
close XML;
}
# Usage: create_html_file( @prog_objects )
sub create_html_file {
# Create local web page
if ( open(HTML, "> $opt->{html}") ) {
print HTML create_html( @_ );
close (HTML);
} else {
logger "WARNING: Couldn't open html file $opt->{html} for writing\n";
}
}
# Usage: create_email( @prog_objects )
# References: http://sial.org/howto/perl/Net-SMTP/, http://cpansearch.perl.org/src/RJBS/Email-Send-2.198/lib/Email/Send/SMTP.pm
# Credit: Network Ned, andy networkned.co.uk, http://networkned.co.uk
sub create_html_email {
# Check if we have Net::SMTP::TLS::ButMaintained/Net::SMTP::TLS/Net::SMTP::SSL/Net::SMTP installed
my $smtpclass;
if ( $opt->{emailsecurity} eq "TLS" ) {
# prefer Net::SMTP::TLS::ButMaintained if installed
$smtpclass = 'Net::SMTP::TLS::ButMaintained';
eval "use $smtpclass";
if ($@) {
$smtpclass = 'Net::SMTP::TLS';
}
} elsif ( $opt->{emailsecurity} eq "SSL" ) {
$smtpclass = 'Net::SMTP::SSL';
eval "use Authen::SASL";
if ($@) {
main::logger "WARNING: Authen::SASL Perl module is required for --email-security=$opt->{emailsecurity}.\n";
return 0;
}
} else {
$smtpclass = 'Net::SMTP';
}
eval "use $smtpclass";
if ($@) {
main::logger "WARNING: Please download and run latest installer or install the $smtpclass Perl module to use --email-security=$opt->{emailsecurity}.\n";
return 0;
};
my $search_args = shift;
my $recipient = $opt->{email};
my $sender = $opt->{emailsender} || 'get_iplayer <>';
my $smtphost = $opt->{emailsmtp} || 'localhost';
my $password = $opt->{emailpassword};
my $user = $opt->{emailuser};
my $port = $opt->{emailport};
if ( ! $port ) {
$port = ( $opt->{emailsecurity} eq "SSL" ) ? 465
: ( $opt->{emailsecurity} eq "TLS" ) ? 587 : 25;
}
my @mail_failure;
my @subject;
# Set the subject using the currently set cmdline options
push @subject, "get_iplayer Search Results for: $search_args ( ";
for my $optkey ( grep !/^email.*/, sort keys %{ $opt_cmdline } ) {
push @subject, "$optkey='$opt_cmdline->{$optkey}' " if $opt_cmdline->{$optkey};
}
push @subject, " )";
my $message = "MIME-Version: 1.0\n"
."Content-Type: text/html\n"
."From: $sender\n"
."To: $recipient\n"
."Subject: @subject\n\n\n"
.create_html( @_ )."\n";
main::logger "DEBUG: Email message to $recipient:\n$message\n\n" if $opt->{debug};
my $smtp;
if ( $opt->{emailsecurity} ne 'TLS' ) {
$smtp = $smtpclass->new($smtphost, Port => $port);
} else {
eval {
$smtp = $smtpclass->new(
$smtphost,
Port => $port,
User => $user,
Password=> $password
);
};
}
if ( ! $smtp ) {
main::logger "ERROR: Could not find or connect to specified SMTP server\n";
return 1;
};
if ( $opt->{emailsecurity} ne 'TLS' && $user ) {
if ( ! $smtp->auth($user, $password) ) {
main::logger "ERROR: Could not authenticate to specified SMTP server\n";
return 1;
}
}
if ( $opt->{emailsecurity} ne 'TLS' ) {
$smtp->mail( $sender ) || push @mail_failure, "MAIL FROM: $sender";
$smtp->to( $recipient ) || push @mail_failure, "RCPT TO: $recipient";
$smtp->data() || push @mail_failure, 'DATA';
$smtp->datasend( $message ) || push @mail_failure, 'Message Data';
$smtp->dataend() || push @mail_failure, 'End of DATA';
$smtp->quit() || push @mail_failure, 'QUIT';
} else {
# ::TLS has no useful return value, but will croak on failure.
eval { $smtp->mail( $sender ) };
push @mail_failure, "MAIL FROM: $sender" if $@;
eval { $smtp->to( $recipient ) };
push @mail_failure, "RCPT TO: $recipient" if $@;
eval { $smtp->data() };
push @mail_failure, 'DATA' if $@;
eval { $smtp->datasend( $message ) };
push @mail_failure, 'Message Data' if $@;
eval { $smtp->dataend() };
push @mail_failure, 'End of DATA' if $@;
eval { $smtp->quit() };
push @mail_failure, 'QUIT' if $@;
}
if ( @mail_failure ) {
main::logger "ERROR: Sending of email failed with $mail_failure[0]\n";
}
return 0;
}
# Usage: create_html( @prog_objects )
sub create_html {
my @html;
my %name_channel;
# Create local web page
push @html, '';
for my $this ( @_ ) {
# Skip if pid isn't in index
my $pid = $this->{pid} || next;
# Skip if already recorded and --hide option is specified
if (! defined $name_channel{ "$this->{name}|$this->{channel}" }) {
push @html, $this->list_entry_html();
} else {
push @html, $this->list_entry_html( 1 );
}
$name_channel{ "$this->{name}|$this->{channel}" } = 1;
}
push @html, '
';
return join "\n", @html;
}
# Generic
# Gets the contents of a URL and retries if it fails, returns '' if no page could be retrieved
# Usage = request_url_retry(, , , , [], <1=mustproxy> );
sub request_url_retry {
my %OPTS = @LWP::Protocol::http::EXTRA_SOCK_OPTS;
$OPTS{SendTE} = 0;
@LWP::Protocol::http::EXTRA_SOCK_OPTS = %OPTS;
my ($ua, $url, $retries, $succeedmsg, $failmsg, $mustproxy) = @_;
my $res;
# Use url prepend if required
if ( defined $opt->{proxy} && $opt->{proxy} =~ /^prepend:/ ) {
$url = $opt->{proxy}.main::url_encode( $url );
$url =~ s/^prepend://g;
}
# Malformed URL check
if ( $url !~ m{^\s*http\:\/\/}i ) {
logger "ERROR: Malformed URL: '$url'\n";
return '';
}
# Disable proxy unless mustproxy is flagged
main::proxy_disable($ua) if $opt->{partialproxy} && ! $mustproxy;
my $i;
logger "INFO: Getting page $url\n" if $opt->{verbose};
for ($i = 0; $i < $retries; $i++) {
$res = $ua->request( HTTP::Request->new( GET => $url ) );
if ( ! $res->is_success ) {
logger $failmsg;
} else {
logger $succeedmsg;
last;
}
}
# Re-enable proxy unless mustproxy is flagged
main::proxy_enable($ua) if $opt->{partialproxy} && ! $mustproxy;
# Return empty string if we failed
return '' if $i == $retries;
# Only return decoded content if gzip is used - otherwise this severely slows down stco scanning! Perl bug?
main::logger "DEBUG: ".($res->header('Content-Encoding') || 'No')." Encoding used on $url\n" if $opt->{debug};
# this appears to be obsolete
# return $res->decoded_content if defined $res->header('Content-Encoding') && $res->header('Content-Encoding') eq 'gzip';
# return $res->content;
return $res->decoded_content;
}
# Generic
# Checks if a particular program exists (or program.exe) in the $ENV{PATH} or if it has a path already check for existence of file
sub exists_in_path {
my $name = shift;
my $bin = $bin->{$name};
# Strip quotes around binary if any just for checking
$bin =~ s/^"(.+)"$/$1/g;
# If this has a path specified, does file exist
return 1 if $bin =~ /[\/\\]/ && (-x ${bin} || -x "${bin}.exe");
# Search PATH
for (@PATH) {
return 1 if -x "${_}/${bin}" || -x "${_}/${bin}.exe";
}
return 0;
}
# Generic
# Checks history for files that are over 30 days old and asks user if they should be deleted
# "$prog->{pid}|$prog->{name}|$prog->{episode}|$prog->{type}|".time()."|$prog->{mode}|$prog->{filename}\n";
sub purge_downloaded_files {
my $hist = shift;
my @delete;
my @proglist;
my $days = shift;
# Return if disabled or running in a typically non-interactive mode
return 0 if $opt->{nopurge} || $opt->{stdout} || $opt->{nowrite} || $opt->{quiet} || $opt->{silent};
for my $pid ( $hist->get_pids() ) {
my $record = $hist->get_record( $pid );
if ( $record->{timeadded} < (time() - $days*86400) && $record->{filename} && -f $record->{filename} ) {
# Calculate the seconds difference between epoch_now and epoch_datestring and convert back into array_time
my @t = gmtime( time() - $record->{timeadded} );
push @proglist, "$record->{name} - $record->{episode}, Recorded: $t[7] days $t[2] hours ago";
push @delete, $record->{filename};
}
}
if ( @delete ) {
main::logger "\nThese programmes should be deleted:\n";
main::logger "-----------------------------------\n";
main::logger join "\n", @proglist;
main::logger "\n-----------------------------------\n";
main::logger "Do you wish to delete them now (Yes/No) ?\n";
my $answer = ;
if ($answer =~ /^yes$/i ) {
for ( @delete ) {
main::logger "INFO: Deleting $_\n";
unlink $_;
}
main::logger "Programmes deleted\n";
} else {
main::logger "No Programmes deleted\n";
}
}
return 0;
}
# Returns url decoded string
sub url_decode {
my $str = shift;
$str =~ s/\%([A-Fa-f0-9]{2})/pack('C', hex($1))/seg;
return $str;
}
# Returns url encoded string
sub url_encode {
my $str = shift;
$str =~ s/([^A-Za-z0-9])/sprintf("%%%02X", ord($1))/seg;
return $str;
}
# list_unique_element_counts( \%type, $element_name, @matchlist);
# Show channels for currently specified types in @matchlist - an array of progs
sub list_unique_element_counts {
my $typeref = shift;
my $element_name = shift;
my @match_list = @_;
my %elements;
logger "INFO: ".(join ',', keys %{ $typeref })." $element_name List:\n" if $opt->{verbose};
# Get list to count from matching progs
for my $prog ( @match_list ) {
my @element;
# Need to separate the categories
if ($element_name eq 'categories') {
@element = split /,/, $prog->{$element_name};
} else {
$element[0] = $prog->{$element_name};
}
for my $element (@element) {
$elements{ $element }++;
}
}
# display element + prog count
logger "$_ ($elements{$_})\n" for sort keys %elements;
return 0;
}
# Invokes command in @args as a system call (hopefully) without using a shell
# Can also redirect all stdout and stderr to either: STDOUT, STDERR or unchanged
# Usage: run_cmd( , @args )
# Returns: exit code
sub run_cmd {
my $mode = shift;
my @cmd = ( @_ );
my $rtn;
my $USE_SYSTEM = 0;
#my $system_suffix;
local *DEVNULL;
my $log_str;
my @log_cmd = @cmd;
if ( $#log_cmd > 0 ) {
$log_str = (join ' ', map {s/\"/\\\"/g; "\"$_\"";} @log_cmd)
} else {
$log_str = $log_cmd[0]
}
main::logger "\n\nINFO: Command: $log_str\n\n" if $opt->{verbose};
# Define what to do with STDOUT and STDERR of the child process
my $fh_child_out = ">&STDOUT";
my $fh_child_err = ">&STDERR";
$mode = 'QUIET' if ( $opt->{quiet} || $opt->{silent} ) && ! ($opt->{stdout} || $opt->{debug} || $opt->{verbose});
if ( $mode eq 'STDOUT' ) {
$fh_child_out = $fh_child_err = ">&STDOUT";
#$system_suffix = '2>&1';
} elsif ( $mode eq 'STDERR' ) {
$fh_child_out = $fh_child_err = ">&STDERR";
#$system_suffix = '1>&2';
} elsif ( $mode eq 'QUIET' ) {
open(DEVNULL, ">", File::Spec->devnull()) || die "ERROR: Cannot open null device\n";
$fh_child_out = $fh_child_err = ">&DEVNULL";
}
# Check if we have IPC::Open3 otherwise fallback on system()
eval "use IPC::Open3";
# use system(); - probably only likely in win32
if ($@) {
main::logger "WARNING: Please download and run latest installer - 'IPC::Open3' is not available\n";
#push @cmd, $system_suffix;
my $rtn = system( @cmd );
# use system() regardless
} elsif ( $USE_SYSTEM ) {
#push @cmd, $system_suffix;
my $rtn = system( @cmd );
# Use open3()
} else {
my $procid;
# Don't create zombies - unfortunately causes open3 to return -1 exit code regardless!
##### local $SIG{CHLD} = 'IGNORE';
# Setup signal handler for SIGTERM/INT/KILL - kill, kill, killlllll
$SIG{TERM} = $SIG{PIPE} = $SIG{INT} = sub {
my $signal = shift;
main::logger "\nINFO: Cleaning up (signal = $signal), killing PID=$procid:";
for my $sig ( qw/INT TERM KILL/ ) {
# Kill process with SIGs (try to allow proper handling of kill by child process)
if ( $opt->{verbose} ) {
main::logger "\nINFO: $$ killing cmd PID=$procid with SIG${sig}";
} else {
main::logger '.';
}
kill $sig, $procid;
sleep 1;
if ( ! kill 0, $procid ) {
main::logger "\nINFO: $$ killed cmd PID=$procid\n";
last;
}
sleep 1;
}
main::logger "\n";
exit 0;
};
# Don't use NULL for the 1st arg of open3 otherwise we end up with a messed up STDIN once it returns
$procid = open3( 0, $fh_child_out, $fh_child_err, @cmd );
# Wait for child to complete
waitpid( $procid, 0 );
$rtn = $?;
# Restore old signal handlers
$SIG{TERM} = $SIGORIG{TERM};
$SIG{PIPE} = $SIGORIG{PIPE};
$SIG{INT} = $SIGORIG{INT};
#$SIG{CHLD} = $SIGORIG{CHLD};
}
close(DEVNULL);
# Interpret return code and force return code 2 upon error
my $return = $rtn >> 8;
if ( $rtn == -1 ) {
main::logger "ERROR: Command failed to execute: $!\n" if $opt->{verbose};
$return = 2 if ! $return;
} elsif ( $rtn & 128 ) {
main::logger "WARNING: Command executed but coredumped\n" if $opt->{verbose};
$return = 2 if ! $return;
} elsif ( $rtn & 127 ) {
main::logger sprintf "WARNING: Command executed but died with signal %d\n", $rtn & 127 if $opt->{verbose};
$return = 2 if ! $return;
}
main::logger sprintf "INFO: Command exit code %d (raw code = %d)\n", $return, $rtn if $return || $opt->{verbose};
return $return;
}
# Generic
# Escape chars in string for shell use
sub StringUtils::esc_chars {
# will change, for example, a!!a to a\!\!a
$_[0] =~ s/([;<>\*\|&\$!#\(\)\[\]\{\}:'"])/\\$1/g;
}
sub StringUtils::clean_utf8_and_whitespace {
# Remove non utf8
$_[0] =~ s/[^\x{21}-\x{7E}\s\t\n\r]//g;
# Strip beginning/end/extra whitespace
$_[0] =~ s/\s+/ /g;
$_[0] =~ s/(^\s+|\s+$)//g;
}
# Remove diacritical marks
sub StringUtils::remove_marks {
my $string = shift;
$string = NFKD($string);
$string =~ s/\pM//g;
return $string;
}
# Convert unwanted punctuation to ASCII
sub StringUtils::convert_punctuation {
my $string = shift;
# die smart quotes die
$string =~ s/[\x{0060}\x{00B4}\x{2018}\x{2019}\x{201A}\x{2039}\x{203A}]/'/g;
$string =~ s/[\x{201C}\x{201D}\x{201E}]/"/g;
$string =~ s/[\x{2013}\x{2014}]/-/g;
$string =~ s/[\x{2026}]/.../g;
return $string;
}
# Generic
# Make a filename/path sane
sub StringUtils::sanitize_path {
my $string = shift;
my $is_path = shift || 0;
my $force_default = shift || 0;
my $default_bad = '[^a-zA-Z0-9_\-\.\/\s]';
my $punct_bad = '[!"#$%&\'()*+,:;<=>?@[\]^`{|}~]';
my $fat_bad = '["*:<>?|]';
my $hfs_bad = '[:]';
# Replace forward slashes with _ if not path
$string =~ s/\//_/g unless $is_path;
# Replace backslashes with _ if not Windows path
$string =~ s/\\/_/g unless $^O eq "MSWin32" && $is_path;
# ASCII-fy some punctuation
$string = StringUtils::convert_punctuation($string);
# Replace ellipsis with _
$string =~ s/\.{3}/_/g;
# Truncate duplicate colon/semi-colon/comma
$string =~ s/([:;,])(\1)+/$1/g;
# Add whitespace behind colon/semi-colon/comma if not present
$string =~ s/([:;,])(\S)/$1 $2/g;
# Remove extra/leading/trailing whitespace
$string =~ s/\s+/ /g;
$string =~ s/(^\s+|\s+$)//g;
# Replace whitespace with _ unless --whitespace
$string =~ s/\s/_/g unless $opt->{whitespace};
# Truncate multiple replacement chars
$string =~ s/_+/_/g;
# Remove non-ASCII chars unless --nonascii or force default
if ( $force_default || ! $opt->{nonascii} ) {
$string = StringUtils::remove_marks($string);
$string =~ s/[^\x{20}-\x{7e}]//g;
}
# Remove most punctuation chars unless --punctuation or force default
if ( $force_default || ! $opt->{punctuation} ) {
$string =~ s/$punct_bad//g
}
# Remove FAT-unfriendly chars if --fatfilename or Windows and not force default
if ( ! $force_default && ( $opt->{fatfilename} || $^O eq "MSWin32" ) ) {
$string =~ s/$fat_bad//g;
}
# Remove HFS-unfriendly chars if --hfsfilename or OS X and not force default
if ( ! $force_default && ( $opt->{hfsfilename} || $^O eq "darwin" ) ) {
$string =~ s/$hfs_bad//g;
}
return $string;
}
# Generic
# Signal handler to clean up after a ctrl-c or kill
sub cleanup {
my $signal = shift;
logger "\nINFO: Cleaning up $0 (got signal $signal)\n"; # if $opt->{verbose};
unlink $namedpipe;
unlink $lockfile;
# Execute default signal handler
$SIGORIG{$signal}->() if ref($SIGORIG{$signal}) eq 'CODE';
exit 1;
}
# Uses: global $lockfile
# Lock file detection ()
# Global $lockfile
sub lockfile {
my $stale_time = shift || 86400;
my $now = time();
# if lockfile exists then quit as we are already running
if ( -T $lockfile ) {
if ( ! open (LOCKFILE, $lockfile) ) {
main::logger "ERROR: Cannot read lockfile '$lockfile'\n";
exit 1;
}
my @lines = ;
close LOCKFILE;
# If the process is still running and the lockfile is newer than $stale_time seconds
if ( kill(0,$lines[0]) > 0 && $now < ( stat($lockfile)->mtime + $stale_time ) ) {
main::logger "ERROR: Quitting - process is already running ($lockfile)\n";
# redefine cleanup sub so that it doesn't delete $lockfile
$lockfile = '';
exit 0;
} else {
main::logger "INFO: Removing stale lockfile\n" if $opt->{verbose};
unlink ${lockfile};
}
}
# write our PID into this lockfile
if (! open (LOCKFILE, "> $lockfile") ) {
main::logger "ERROR: Cannot write to lockfile '${lockfile}'\n";
exit 1;
}
print LOCKFILE $$;
close LOCKFILE;
return 0;
}
sub expand_list {
my $list = shift;
my $search = shift;
my $replace = shift;
my @elements = split /,/, $list;
for (@elements) {
$_ = $replace if $_ eq $search;
}
return join ',', @elements;
}
sub get_playlist_url {
my $ua = shift;
my $url = shift;
my $filter = shift;
# Don't recurse more than 5 times
my $depth = 5;
# Resolve the MMS url if it is an http ref
while ( $url =~ /^http/i && $depth ) {
my $content = main::request_url_retry($ua, $url, 2, '', '');
# Reference list
if ( $content =~ m{\[reference\]}i ) {
my @urls;
# [Reference]
# Ref1=http://wm.bbc.co.uk/wms/england/radioberkshire/aod/andrewpeach_thu.wma?MSWMExt=.asf
# Ref2=http://wm.bbc.co.uk/wms/england/radioberkshire/aod/andrewpeach_thu.wma?MSWMExt=.asf
for ( split /ref\d*=/i, $content ) {
#main::logger "DEBUG: LINE: $_\n" if $opt->{debug};
s/[\s]//g;
# Rename http:// to mms:// - don't really know why but this seems to be necessary with such playlists
s|http://|mms://|g;
push @urls, $_ if m{^(http|mms|rtsp)://};
main::logger "DEBUG: Got Reference URL: $_\n" if $opt->{debug};
}
# use first URL for now??
$url = $urls[0];
# ASX XML based playlist
} elsif ( $content =~ m{
# http://www.bbc.co.uk/
# BBC support
# BBC
# (c) British Broadcasting Corporation
#
#
#
#
#
#
#
# BBC
#
#
for ( split /{debug};
# Ignore anything except mms or http from this playlist
push @urls, $1 if m{ref\s+href=\"((http|$filter)://.+?)\"}i;
}
for ( @urls ) {
main::logger "DEBUG: Got ASX URL: $_\n" if $opt->{debug};
}
# use first URL for now??
$url = $urls[0];
# RAM format urls
} elsif ( $content =~ m{rtsp://}i ) {
my @urls;
for ( split /[\n\r\s]/i, $content ) {
main::logger "DEBUG: LINE: $_\n" if $opt->{debug};
# Ignore anything except $filter or http from this playlist
push @urls, $1 if m{((http|$filter)://.+?)[\n\r\s]?$}i;
}
for ( @urls ) {
main::logger "DEBUG: Got RAM URL: $_\n" if $opt->{debug};
}
# use first URL for now??
$url = $urls[0];
} else {
chomp( $url = $content );
}
$depth--;
}
return $url;
}
# Converts any number words (or numbers) 0 - 99 to a number
sub convert_words_to_number {
my $text = shift;
$text = lc($text);
my $number = 0;
# Regex for mnemonic numbers
my %lookup_0_19 = qw(
zero 0
one 1
two 2
three 3
four 4
five 5
six 6
seven 7
eight 8
nine 9
ten 10
eleven 11
twelve 12
thirteen 13
fourteen 14
fifteen 15
sixteen 16
seventeen 17
eighteen 18
nineteen 19
);
my %lookup_tens = qw(
twenty 20
thirty 30
forty 40
fifty 50
sixty 60
seventy 70
eighty 80
ninety 90
);
my $regex_units = '(zero|one|two|three|four|five|six|seven|eight|nine)';
my $regex_ten_to_nineteen = '(ten|eleven|twelve|thirteen|fourteen|fifteen|sixteen|seventeen|eighteen|nineteen)';
my $regex_tens = '(twenty|thirty|forty|fifty|sixty|seventy|eighty|ninety)';
my $regex_numbers = '(\d+|'.$regex_units.'|'.$regex_ten_to_nineteen.'|'.$regex_tens.'((\s+|\-|)'.$regex_units.')?)';
#print "REGEX: $regex_numbers\n";
#my $text = 'seventy two'
$number += $text if $text =~ /^\d+$/;
my $regex = $regex_numbers.'$';
if ( $text =~ /$regex/ ) {
# trailing zero -> nineteen
$regex = '('.$regex_units.'|'.$regex_ten_to_nineteen.')$';
$number += $lookup_0_19{ $1 } if $text =~ /($regex)/;
# leading tens
$regex = '^('.$regex_tens.')(\s+|\-|_||$)';
$number += $lookup_tens{ $1 } if $text =~ /$regex/;
}
return $number;
}
# Returns a regex string that matches all number words (or numbers) 0 - 99
sub regex_numbers {
my $regex_units = '(zero|one|two|three|four|five|six|seven|eight|nine)';
my $regex_ten_to_nineteen = '(ten|eleven|twelve|thirteen|fourteen|fifteen|sixteen|seventeen|eighteen|nineteen)';
my $regex_tens = '(twenty|thirty|forty|fifty|sixty|seventy|eighty|ninety)';
return '(\d+|'.$regex_units.'|'.$regex_ten_to_nineteen.'|'.$regex_tens.'((\s+|\-|)'.$regex_units.')?)';
}
sub default_encodinglocale {
return 'UTF-8' if (${^UNICODE} & 32);
return ($^O eq "MSWin32" ? 'cp1252' : 'UTF-8');
}
sub default_encodingconsoleout {
return 'UTF-8' if (${^UNICODE} & 6);
return ($^O eq "MSWin32" ? 'cp850' : 'UTF-8');
}
sub encode_fs {
my $string = shift;
return $string if $opt->{encodinglocalefs} =~ /UTF-?8/i;
return encode($opt->{encodinglocalefs}, $string, FB_EMPTY);
}
############## OO ################
############## Options default class ################
package Options;
use Env qw[@PATH];
use Fcntl;
use File::Copy;
use File::Path;
use File::stat;
use Getopt::Long;
use strict;
# Class vars
# Global options
my $opt_format_ref;
# Constructor
# Usage: $opt = Options->new( 'optname' => 'testing 123', 'myopt2' => 'myval2', );
sub new {
my $type = shift;
my %params = @_;
my $self = {};
for (keys %params) {
$self->{$_} = $params{$_};
}
bless $self, $type;
}
# Use to bind a new options ref to the class global $opt_format_ref var
sub add_opt_format_object {
my $self = shift;
$Options::opt_format_ref = shift;
}
# Parse cmdline opts using supplied hash
# If passthru flag is set then no error will result if there are unrecognised options etc
# Usage: $opt_cmdline->parse( [passthru] );
sub parse {
my $this = shift;
my $pass_thru = shift;
my $opt_format_ref = $Options::opt_format_ref;
# Build hash for passing to GetOptions module
my %get_opts;
for my $name ( grep !/^_/, keys %{$opt_format_ref} ) {
my $format = @{ $opt_format_ref->{$name} }[1];
$get_opts{ $format } = \$this->{$name};
}
# Allow bundling of single char options
Getopt::Long::Configure("bundling");
if ( $pass_thru ) {
Getopt::Long::Configure("pass_through");
} else {
Getopt::Long::Configure("no_pass_through");
}
# cmdline opts take precedence
# get options
return GetOptions(%get_opts);
}
sub copyright_notice {
shift;
my $text = "get_iplayer $version_text, ";
$text .= <<'EOF';
Copyright (C) 2008-2010 Phil Lewis
This program comes with ABSOLUTELY NO WARRANTY; for details use --warranty.
This is free software, and you are welcome to redistribute it under certain
conditions; use --conditions for details.
EOF
return $text;
}
# Usage: $opt_cmdline->usage( , , );
sub usage {
my $this = shift;
# Help levels: 0:Intermediate, 1:Advanced, 2:Basic
my $helplevel = shift;
my $manpage = shift;
my $dumpopts = shift;
my $opt_format_ref = $Options::opt_format_ref;
my %section_name;
my %name_syntax;
my %name_desc;
my @usage;
my @man;
my @dump;
push @man,
'.TH GET_IPLAYER "1" "December 2014" "Phil Lewis" "get_iplayer Manual"',
'.SH NAME', 'get_iplayer - Stream Recording tool and PVR for BBC iPlayer, BBC Podcasts and more',
'.SH SYNOPSIS',
'\fBget_iplayer\fR [] [ ...]',
'.PP',
'\fBget_iplayer\fR \fB--get\fR [] ...',
'.br',
'\fBget_iplayer\fR \fB--type\fR= []',
'.PP',
'\fBget_iplayer\fR [\fB--type\fR= ]',
'.PP',
'\fBget_iplayer\fR \fB--stream\fR [] | mplayer \fB-cache\fR 3072 -',
'.PP',
'\fBget_iplayer\fR \fB--stream\fR [] \fB--type\fR= | mplayer \fB-cache\fR 3072 -',
'.PP',
'\fBget_iplayer\fR \fB--stream\fR [] \fB--type\fR=livetv,liveradio \fB--player\fR="mplayer -cache 128 -"',
'.PP',
'\fBget_iplayer\fR \fB--refresh\fR',
'.SH DESCRIPTION',
'\fBget_iplayer\fR lists, searches and records BBC iPlayer TV/Radio, BBC Podcast programmes. Other 3rd-Party plugins may be available.',
'.PP',
'\fBget_iplayer\fR has three modes: recording a complete programme for later playback, streaming a programme',
'directly to a playback application, such as mplayer; and as a Personal Video Recorder (PVR), subscribing to',
'search terms and recording programmes automatically. It can also stream or record live BBC iPlayer output',
'.PP',
'If given no arguments, \fBget_iplayer\fR updates and displays the list of currently available programmes.',
'Each available programme has a numerical identifier, \fBpid\fR.',
'\fBget_iplayer\fR utilises the \fBrtmpdump\fR tool to record BBC iPlayer programmes from RTMP flash streams at various qualities.',
'.PP',
'In PVR mode, \fBget_iplayer\fR can be called from cron to record programmes to a schedule.',
'.SH "OPTIONS"' if $manpage;
push @usage, 'Usage ( Also see https://github.com/get-iplayer/get_iplayer/wiki/documentation ):';
push @usage, ' List All Programmes: get_iplayer [--type=]';
push @usage, ' Search Programmes: get_iplayer ';
push @usage, ' Record Programmes by Search: get_iplayer --get';
push @usage, ' Record Programmes by Index: get_iplayer --get';
push @usage, ' Record Programmes by URL: get_iplayer [--type=] ""';
push @usage, ' Record Programmes by PID: get_iplayer [--type=] --pid=';
push @usage, ' Stream Programme to Player: get_iplayer --stream | mplayer -cache 3072 -' if $helplevel == 1;
push @usage, ' Stream BBC Embedded Media URL: get_iplayer --stream --type= "" | mplayer -cache 128 -' if $helplevel != 2;
push @usage, ' Stream Live iPlayer Programme: get_iplayer --stream --type=livetv,liveradio --player="mplayer -cache 128 -"' if $helplevel != 2;
push @usage, '';
push @usage, ' Update get_iplayer cache: get_iplayer --refresh [--force]';
push @usage, '';
push @usage, ' Basic Help: get_iplayer --basic-help' if $helplevel != 2;
push @usage, ' Intermediate Help: get_iplayer --help' if $helplevel == 2;
push @usage, ' Advanced Help: get_iplayer --long-help' if $helplevel != 1;
for my $name (keys %{$opt_format_ref} ) {
next if not $opt_format_ref->{$name};
my ( $helpmask, $format, $section, $syntax, $desc ) = @{ $opt_format_ref->{$name} };
# Skip advanced options if not req'd
next if $helpmask == 1 && $helplevel != 1;
# Skip internediate options if not req'd
next if $helpmask != 2 && $helplevel == 2;
push @{$section_name{$section}}, $name if $syntax;
$name_syntax{$name} = $syntax;
$name_desc{$name} = $desc;
}
# Build the help usage text
# Each section
for my $section ( 'Search', 'Display', 'Recording', 'Download', 'Output', 'PVR', 'Config', 'External Program', 'Tagging', 'Misc' ) {
next if not defined $section_name{$section};
my @lines;
my @manlines;
my @dumplines;
#Runs the PVR using all saved PVR searches (intended to be run every hour from cron etc)
push @man, ".SS \"$section Options:\"" if $manpage;
push @dump, '', "$section Options:" if $dumpopts;
push @usage, '', "$section Options:";
# Each name in this section array
for my $name ( sort @{ $section_name{$section} } ) {
push @manlines, '.TP'."\n".'\fB'.$name_syntax{$name}."\n".$name_desc{$name} if $manpage;
my $dumpname = $name;
$dumpname =~ s/^_//g;
push @dumplines, sprintf(" %-30s %-32s %s", $dumpname, $name_syntax{$name}, $name_desc{$name} ) if $dumpopts;
push @lines, sprintf(" %-32s %s", $name_syntax{$name}, $name_desc{$name} );
}
push @usage, sort @lines;
push @man, sort @manlines;
push @dump, sort @dumplines;
}
# Create manpage
if ( $manpage ) {
push @man,
'.SH AUTHOR',
'get_iplayer was written by Phil Lewis and is now maintained by the contributors at http://www.infradead.org/get_iplayer/html/get_iplayer.html',
'.PP',
'This manual page was originally written by Jonathan Wiltshire for the Debian project (but may be used by others).',
'.SH COPYRIGHT NOTICE';
push @man, Options->copyright_notice;
# Escape '-'
s/\-/\\-/g for @man;
# Open manpage file and write contents
if (! open (MAN, "> $manpage") ) {
main::logger "ERROR: Cannot write to manpage file '$manpage'\n";
exit 1;
}
print MAN join "\n", @man, "\n";
close MAN;
main::logger "INFO: Wrote manpage file '$manpage'\n";
exit 0;
# Print options dump and quit
} elsif ( $dumpopts ) {
main::logger join "\n", @dump, "\n";
# Print usage and quit
} else {
main::logger join "\n", @usage, "\n";
}
exit 0;
}
# Add all the options into supplied hash from specified class
# Usage: Options->get_class_options( 'Programme:tv' );
sub get_class_options {
shift;
my $classname = shift;
my $opt_format_ref = $Options::opt_format_ref;
# If the method exists...
eval { $classname->opt_format() };
if ( ! $@ ) {
my %tmpopt = %{ $classname->opt_format() };
for my $thisopt ( keys %tmpopt ) {
$opt_format_ref->{$thisopt} = $tmpopt{$thisopt};
}
}
}
# Copies values in one instance to another only if they are set with a value/defined
# Usage: $opt->copy_set_options_from( $opt_cmdline );
sub copy_set_options_from {
my $this_to = shift;
my $this_from = shift;
# Merge cmdline options into $opt instance (only those options defined)
for ( keys %{$this_from} ) {
$this_to->{$_} = $this_from->{$_} if defined $this_from->{$_};
}
}
# specify regex of options that cannot be saved
sub excludeopts {
return '^(encoding|silent|help|debug|get|pvr|prefs|preset|warranty|conditions)';
}
# List all available presets in the specified dir
sub preset_list {
my $opt = shift;
my $dir = shift;
main::logger "INFO: Valid presets: ";
if ( opendir( DIR, "${profile_dir}/presets/" ) ) {
my @preset_list = grep !/(^\.|~$)/, readdir DIR;
closedir DIR;
main::logger join ',', @preset_list;
}
main::logger "\n";
}
# Clears all option entries for a particular preset (i.e. deletes the file)
sub clear {
my $opt = shift;
my $prefsfile = shift;
$opt->show( $prefsfile );
unlink $prefsfile;
main::logger "INFO: Removed all above options from $prefsfile\n";
}
# $opt->add( $opt_cmdline, $optfile, @search_args )
# Add/change cmdline-only options to file
sub add {
my $opt = shift;
my $this_cmdline = shift;
my $optfile = shift;
my @search_args = @_;
# Load opts file
my $entry = get( $opt, $optfile );
# Add search args to opts
if ( defined $this_cmdline->{search} ) {
push @search_args, $this_cmdline->{search};
}
$this_cmdline->{search} = '('.(join '|', @search_args).')' if @search_args;
# Merge all cmdline opts into $entry except for these
my $regex = $opt->excludeopts;
for ( grep !/$regex/, keys %{ $this_cmdline } ) {
# if this option is on the cmdline
if ( defined $this_cmdline->{$_} ) {
main::logger "INFO: Changed option '$_' from '$entry->{$_}' to '$this_cmdline->{$_}'\n" if defined $entry->{$_} && $this_cmdline->{$_} ne $entry->{$_};
main::logger "INFO: Added option '$_' = '$this_cmdline->{$_}'\n" if not defined $entry->{$_};
$entry->{$_} = $this_cmdline->{$_};
}
}
# Save opts file
put( $opt, $entry, $optfile );
}
# $opt->add( $opt_cmdline, $optfile )
# Add/change cmdline-only options to file
sub del {
my $opt = shift;
my $this_cmdline = shift;
my $optfile = shift;
my @search_args = @_;
return 0 if ! -f $optfile;
# Load opts file
my $entry = get( $opt, $optfile );
# Add search args to opts
$this_cmdline->{search} = '('.(join '|', @search_args).')' if @search_args;
# Merge all cmdline opts into $entry except for these
my $regex = $opt->excludeopts;
for ( grep !/$regex/, keys %{ $this_cmdline } ) {
main::logger "INFO: Deleted option '$_' = '$entry->{$_}'\n" if defined $this_cmdline->{$_} && defined $entry->{$_};
delete $entry->{$_} if defined $this_cmdline->{$_};
}
# Save opts file
put( $opt, $entry, $optfile );
}
# $opt->show( $optfile )
# show options from file
sub show {
my $opt = shift;
my $optfile = shift;
return 0 if ! -f $optfile;
# Load opts file
my $entry = get( $opt, $optfile );
# Merge all cmdline opts into $entry except for these
main::logger "Options in '$optfile'\n";
my $regex = $opt->excludeopts;
for ( keys %{ $entry } ) {
main::logger "\t$_ = $entry->{$_}\n";
}
}
# $opt->save( $opt_cmdline, $optfile )
# Save cmdline-only options to file
sub put {
my $opt = shift;
my $entry = shift;
my $optfile = shift;
unlink $optfile;
main::logger "DEBUG: adding/changing options to $optfile:\n" if $opt->{debug};
open (OPT, "> $optfile") || die ("ERROR: Cannot save options to $optfile\n");
for ( keys %{ $entry } ) {
if ( defined $entry->{$_} ) {
print OPT "$_ $entry->{$_}\n";
main::logger "DEBUG: Saving option $_ = $entry->{$_}\n" if $opt->{debug};
}
}
close OPT;
main::logger "INFO: Options file $optfile updated\n";
return;
}
# Returns a hashref of 'optname => internal_opt_name' for all options
sub get_opt_map {
my $opt_format_ref = $Options::opt_format_ref;
# Get a hash or optname -> internal_opt_name
my $optname;
for my $optint ( keys %{ $opt_format_ref } ) {
my $format = @{ $opt_format_ref->{$optint} }[1];
#main::logger "INFO: Opt Format '$format'\n";
$format =~ s/=.*$//g;
# Parse each option format
for ( split /\|/, $format ) {
next if /^$/;
#main::logger "INFO: Opt '$_' -> '$optint'\n";
if ( defined $optname->{$_} ) {
main::logger "ERROR: Duplicate Option defined '$_' -> '$optint' and '$optname->{$_}'\n";
exit 11;
}
$optname->{$_} = $optint;
}
}
for my $optint ( keys %{ $opt_format_ref } ) {
$optname->{$optint} = $optint;
}
return $optname;
}
# $entry = get( $opt, $optfile )
# get all options from file into $entry ($opt is used just to get access to general options like debug)
sub get {
my $opt = shift;
my $optfile = shift;
my $opt_format_ref = $Options::opt_format_ref;
my $entry;
return $entry if ( ! defined $optfile ) || ( ! -f $optfile );
my $optname = get_opt_map();
# Load opts
main::logger "DEBUG: Parsing options from $optfile:\n" if $opt->{debug};
my $opt_encoding = ( $^O eq "MSWin32" && $optfile eq $optfile_system ) ? $opt->{encodinglocalefs} : "utf8";
open (OPT, "<:encoding($opt_encoding)", $optfile) || die ("ERROR: Cannot read options file $optfile\n");
while() {
/^\s*([\w\-_]+)\s+(.*)\s*$/;
next if not defined $1;
# Error if the option is not valid
if ( not defined $optname->{$1} ) {
# Force error to go to STDERR (prevents PVR runs getting STDOUT warnings)
$opt->{stderr} = 1;
main::logger "WARNING: Ignoring invalid option in $optfile: '$1 = $2'\n";
main::logger "INFO: Please remove and use 'get_iplayer --dump-options' to display all valid options\n";
delete $opt->{stderr};
next;
}
# Warn if it is listed as a deprecated internal option name
if ( defined @{ $opt_format_ref->{$1} }[2] && @{ $opt_format_ref->{$1} }[2] eq 'Deprecated' ) {
main::logger "WARNING: Deprecated option in $optfile: '$1 = $2'\n";
main::logger "INFO: Use --dump-opts to display all valid options\n";
}
chomp( $entry->{ $optname->{$1} } = $2 );
main::logger "DEBUG: Loaded option $1 ($optname->{$1}) = $2\n" if $opt->{debug};
}
close OPT;
return $entry;
}
# $opt_file->load( $opt, $optfile )
# Load default options from file(s) into instance
sub load {
my $this_file = shift;
my $opt = shift;
my @optfiles = ( @_ );
# If multiple files are specified, load them in order listed
for my $optfile ( @optfiles ) {
# Load opts
my $entry = get( $opt, $optfile );
# Copy to $this_file instance
$this_file->copy_set_options_from( $entry );
}
return;
}
# Usage: $opt_file->display( [], [] );
# Display options
sub display {
my $this = shift;
my $title = shift || 'Options';
my $excluderegex = shift || 'ROGUEVALUE';
my $regex = $this->excludeopts;
main::logger "$title:\n";
for ( sort keys %{$this} ) {
if ( defined $this->{$_} && $this->{$_} ) {
if ( ref($this->{$_}) eq 'ARRAY' ) {
main::logger "\t$_ = ".(join(',', @{$this->{$_}}))."\n";
} else {
main::logger "\t$_ = $this->{$_}\n";
}
}
}
main::logger "\n";
return 0;
}
########################################################
################ History default class #################
package History;
use Encode;
use Env qw[@PATH];
use Fcntl;
use File::Copy;
use File::Path;
use File::stat;
use strict;
# Class vars
# Global options
# Constructor
# Usage: $hist = History->new();
sub new {
my $type = shift;
my %params = @_;
my $self = {};
for (keys %params) {
$self->{$_} = $params{$_};
}
## Ensure the subclass $opt var is pointing to the Superclass global optref
$opt = $History::optref;
bless $self, $type;
}
# $opt->{} access method
sub opt {
my $self = shift;
my $optname = shift;
return $opt->{$optname};
}
# Use to bind a new options ref to the class global $opt_ref var
sub add_opt_object {
my $self = shift;
$History::optref = shift;
}
sub trim {
my $oldhistoryfile = "$historyfile.old";
my $newhistoryfile = "$historyfile.new";
if ( $opt->{trimhistory} =~ /^all$/i ) {
if ( ! copy($historyfile, $oldhistoryfile) ) {
die "ERROR: Cannot copy $historyfile to $oldhistoryfile: $!\n";
}
if ( ! unlink($historyfile) ) {
die "ERROR: Cannot delete $historyfile: $! \n";
}
main::logger "INFO: Deleted all entries from download history\n";
return;
}
if ( $opt->{trimhistory} !~ /^\d+$/ ) {
die "ERROR: --trim-history option must have a positive integer value, or use 'all' to completely delete download history.\n";
}
if ( $opt->{trimhistory} =~ /^0+$/ ) {
die "ERROR: Cannot specify 0 for --trim-history option. Use 'all' to completely delete download history.\n";
}
if ( ! open(HIST, "< $historyfile") ) {
die "ERROR: Cannot read from $historyfile\n";
}
if ( ! open(NEWHIST, "> $newhistoryfile") ) {
die "ERROR: Cannot write to $newhistoryfile\n";
}
my $trim_limit = time() - ($opt->{trimhistory} * 86400);
my $deleted_count = 0;
while () {
chomp();
next if /^[\#\s]/;
my @record = split /\|/;
my $timeadded = $record[4];
if ( $timeadded >= $trim_limit ) {
print NEWHIST "$_\n";
} else {
$deleted_count++;
}
}
close HIST;
close NEWHIST;
if ( ! copy($historyfile, $oldhistoryfile) ) {
die "ERROR: Cannot copy $historyfile to $oldhistoryfile: $!\n";
}
if ( ! move($newhistoryfile, $historyfile) ) {
die "ERROR: Cannot move $newhistoryfile to $historyfile: $!\n";
}
main::logger "INFO: Deleted $deleted_count entries from download history\n";
}
# Uses global @history_format
# Adds prog to history file (with a timestamp) so that it is not rerecorded after deletion
sub add {
my $hist = shift;
my $prog = shift;
# Only add if a pid is specified
return 0 if ! $prog->{pid};
# Don't add to history if nowrite is used
return 0 if $opt->{nowrite};
# Add to history
if ( ! open(HIST, ">> $historyfile") ) {
main::logger "ERROR: Cannot write or append to $historyfile\n";
exit 11;
}
# Update timestamp
$prog->{timeadded} = time();
# Write each field into a line in the history file
print HIST $prog->{$_}.'|' for @history_format;
print HIST "\n";
close HIST;
# (re)load whole hist
# Would be nicer to just add the entry to the history object but this is safer.
$hist->load();
return 0;
}
# Uses global @history_format
# returns, for all the pids in the history file, $history->{pid}->{key} = value
sub load {
my $hist = shift;
# Return if force option specified or stdout streaming only
return 0 if ( $opt->{force} && ! $opt->{pid} ) || $opt->{stdout} || $opt->{nowrite};
# clear first
$hist->clear();
main::logger "INFO: Loading recordings history\n" if $opt->{verbose};
if ( ! open(HIST, "< $historyfile") ) {
main::logger "WARNING: Cannot read $historyfile\n\n" if $opt->{verbose} && -f $historyfile;
return 0;
}
# Slow. Needs to be faster
while () {
chomp();
# Ignore comments
next if /^[\#\s]/;
# Populate %prog_old from cache
# Get history line
my @record = split /\|/;
my $record_entries;
# Update fields in %history hash for $pid
for ( @history_format ) {
$record_entries->{$_} = ( shift @record ) || '';
if ( /^filename$/ ) {
$record_entries->{$_} = main::encode_fs($record_entries->{$_});
}
}
# Create new history entry
if ( defined $hist->{ $record_entries->{pid} } ) {
main::logger "WARNING: duplicate pid $record_entries->{pid} in history\n" if $opt->{debug};
# Append filename and modes - could be a multimode entry
$hist->{ $record_entries->{pid} }->{mode} .= ','.$record_entries->{mode} if defined $record_entries->{mode};
$hist->{ $record_entries->{pid} }->{filename} .= ','.$record_entries->{filename} if defined $record_entries->{filename};
main::logger "DEBUG: Loaded and merged '$record_entries->{pid}' = '$record_entries->{name} - $record_entries->{episode}' from history\n" if $opt->{debug};
} else {
# workaround empty names
#$record_entries->{name} = 'pid:'.$record_entries->{pid} if ! $record_entries->{name};
$hist->{ $record_entries->{pid} } = History->new();
$hist->{ $record_entries->{pid} } = $record_entries;
main::logger "DEBUG: Loaded '$record_entries->{pid}' = '$record_entries->{name} - $record_entries->{episode}' from history\n" if $opt->{debug};
}
}
close (HIST);
return 0;
}
# Clear the history in %{$hist}
sub clear {
my $hist = shift;
# There is probably a faster way
delete $hist->{$_} for keys %{ $pvr };
return 0;
}
# Loads hist from file if required
sub conditional_load {
my $hist = shift;
# Load if empty
if ( ! keys %{ $hist } ) {
main::logger "INFO: Loaded history for first check.\n" if $opt->{verbose};
$hist->load();
}
return 0;
}
# Returns a history pid instance ref
sub get_record {
my $hist = shift;
my $pid = shift;
$hist->conditional_load();
if ( defined $hist->{$pid} ) {
return $hist->{$pid};
}
return undef;
}
# Returns a list of current history pids
sub get_pids {
my $hist = shift;
$hist->conditional_load();
return keys %{ $hist };
}
# Lists current history items
# Requires a load()
sub list_progs {
my $hist = shift;
my $prog = {};
my ( @search_args ) = ( @_ );
# Load if empty
$hist->conditional_load();
# This is a 'well dirty' hack to allow all the Programme class methods to be used on the history objects
# Basically involves copying all history objects into prog objects and then calling the required method
# Sort index by timestamp
my %index_hist;
main::sort_index( $hist, \%index_hist, undef, 'timeadded' );
for my $index ( sort {$a <=> $b} keys %index_hist ) {
my $record = $index_hist{$index};
my $progrec;
if ( not main::is_prog_type( $record->{type} ) ) {
main::logger "WARNING: Programme type '$record->{type}' does not exist - using generic class\n" if $opt->{debug};
$progrec = Programme->new();
} else {
# instantiate a new Programme object and copy all metadata from this history object into it
$progrec = main::progclass( $record->{type} )->new();
}
for my $key ( keys %{ $record } ) {
$progrec->{$key} = $record->{$key};
}
$prog->{ $progrec->{pid} } = $progrec;
# CAVEAT: The filename is comma-separated if there is a multimode download. For now just use the first one
if ( $prog->{ $progrec->{pid} }->{mode} =~ /\w+,\w+/ ) {
$prog->{ $progrec->{pid} }->{mode} =~ s/,.+$//g;
$prog->{ $progrec->{pid} }->{filename} =~ s/,.+$//g;
}
}
# Parse remaining args
my @match_list;
for ( @search_args ) {
chomp();
# If Numerical value < $max_index and the object exists from loaded prog types
if ( /^[\d]+$/ && $_ <= $max_index ) {
if ( defined $index_hist{$_} ) {
main::logger "INFO: Search term '$_' is an Index value\n" if $opt->{verbose};
push @match_list, $prog->{ $index_hist{$_}->{pid} };
}
# If PID then find matching programmes with 'pid:'
} elsif ( m{^\s*pid:(.+?)\s*$}i ) {
if ( defined $prog->{$1} ) {
main::logger "INFO: Search term '$1' is a pid\n" if $opt->{verbose};
push @match_list, $prog->{$1};
} else {
main::logger "INFO: Search term '$1' is a non-existent pid in the history\n";
}
# Else assume this is a programme name regex
} else {
main::logger "INFO: Search term '$_' is a substring\n" if $opt->{verbose};
push @match_list, main::get_regex_matches( $prog, $_ );
}
}
# force skipdeleted if --tagonly is specified
$opt->{skipdeleted} = 1 if $opt->{tagonly};
# Prune list of history entries with non-existant media files
if ( $opt->{skipdeleted} ) {
my @pruned = ();
for my $this ( @match_list ) {
# Skip if no filename in history
if ( defined $this->{filename} && $this->{filename} ) {
# Skip if the originally recorded file no longer exists
if ( ! -f $this->{filename} ) {
main::logger "DEBUG: Skipping metadata/thumbnail/tagging - file no longer exists: '$this->{filename}'\n" if $opt->{verbose};
} else {
push @pruned, $this;
}
}
}
@match_list = @pruned;
}
# De-dup matches and retain order then list matching programmes in history
main::list_progs( undef, main::make_array_unique_ordered( @match_list ) );
return 0;
}
# Generic
# Checks history for previous download of this pid
sub check {
my $hist = shift;
my $pid = shift;
my $mode = shift;
my $silent = shift;
return 0 if ! $pid;
# Return if force option specified or stdout streaming only
return 0 if $opt->{force} || $opt->{stdout} || $opt->{nowrite};
# Load if empty
$hist->conditional_load();
if ( defined $hist->{ $pid } ) {
my ( $name, $episode, $histmode ) = ( $hist->{$pid}->{name}, $hist->{$pid}->{episode}, $hist->{$pid}->{mode} );
main::main::logger "DEBUG: Found PID='$pid' with MODE='$histmode' in history\n" if $opt->{debug};
if ( $opt->{multimode} ) {
# Strip any number off the end of the mode names for the comparison
$mode =~ s/\d+$//g;
# Check against all modes in the comma separated list
my @hmodes = split /,/, $histmode;
for ( @hmodes ) {
s/\d+$//g;
if ( $mode eq $_ ) {
main::logger "INFO: $name - $episode ($pid / $mode) Already in history ($historyfile) - use --force to override\n" if ! $silent;
return 1;
}
}
} else {
main::logger "INFO: $name - $episode ($pid) Already in history ($historyfile) - use --force to override\n" if ! $silent;
return 1;
}
}
main::logger "INFO: Programme not in history\n" if $opt->{verbose} && ! $silent;
return 0;
}
#################### Programme class ###################
package Programme;
use Encode;
use Env qw[@PATH];
use Fcntl;
use File::Basename;
use File::Copy;
use File::Path;
use File::Spec;
use File::stat;
use HTML::Entities;
use HTTP::Cookies;
use HTTP::Headers;
use IO::Seekable;
use IO::Socket;
use LWP::ConnCache;
use LWP::UserAgent;
use POSIX qw(mkfifo);
use strict;
use Time::Local;
use URI;
use Cwd 'abs_path';
# Class vars
# Global options
my $optref;
my $opt;
# File format
sub file_prefix_format { return ' - ' };
# index min/max
sub index_min { return 0 }
sub index_max { return 9999999 };
# Class cmdline Options
sub opt_format {
return {
};
}
# Filter channel names matched with options --refreshexclude/--refreshinclude
sub channels_filtered {
my $prog = shift;
my $channelsref = shift;
# assume class method call
(my $prog_type = $prog) =~ s/Programme:://;
my $exclude = $opt->{'refreshexcludegroups'.$prog_type} || $opt->{'refreshexcludegroups'};
my %channels;
for my $x ( qw(national regional local) ) {
@channels{ keys %{$channelsref->{$x}} } = values %{$channelsref->{$x}} unless $exclude =~ /\b$x\b/;
}
# include/exclude matching channels as required
my $include_regex = '.*';
my $exclude_regex = '^ROGUEVALUE$';
# Create a regex from any comma separated values
$exclude_regex = '('.(join '|', ( split /,/, $opt->{refreshexclude} ) ).')' if $opt->{refreshexclude};
$include_regex = '('.(join '|', ( split /,/, $opt->{refreshinclude} ) ).')' if $opt->{refreshinclude};
for my $channel ( keys %channels ) {
if ( $channels{$channel} !~ /$exclude_regex/i && $channels{$channel} =~ /$include_regex/i ) {
main::logger "INFO: Will refresh channel $channels{$channel}\n" if $opt->{verbose};
} else {
delete $channels{$channel};
}
}
return \%channels;
}
sub channels {
return {};
}
sub channels_schedule {
return {};
}
# Method to return optional list_entry format
sub optional_list_entry_format {
my $prog = shift;
return '';
}
# Returns the modes to try for this prog type
sub modelist {
return '';
}
# Default minimum expected download size for a programme type
sub min_download_size {
return 1024000;
}
# Default cache expiry in seconds
sub expiry {
return 14400;
}
# Constructor
# Usage: $prog{$pid} = Programme->new( 'pid' => $pid, 'name' => $name, );
sub new {
my $type = shift;
my %params = @_;
my $self = {};
for (keys %params) {
$self->{$_} = $params{$_};
}
## Ensure that all instances reference the same class global $optref var
# $self->{optref} = $Programme::optref;
# Ensure the subclass $opt var is pointing to the Superclass global optref
$opt = $Programme::optref;
bless $self, $type;
}
# Use to bind a new options ref to the class global $optref var
sub add_opt_object {
my $self = shift;
$Programme::optref = shift;
}
# $opt->{} access method
sub opt {
my $self = shift;
my $optname = shift;
return $opt->{$optname};
#return $Programme::optref->{$optname};
#my $opt = $self->{optref};
#return $self->{optref}->{$optname};
}
# Cleans up a pid and removes url parts that might be specified
sub clean_pid {
}
# This gets run before the download retry loop if this class type is selected
sub init {
}
# Create dir if it does not exist
sub create_dir {
my $prog = shift;
if ( (! -d "$prog->{dir}") && (! $opt->{test}) ) {
main::logger "INFO: Creating dir '$prog->{dir}'\n" if $opt->{verbose};
eval { mkpath("$prog->{dir}") };
if ( $@ ) {
main::logger "ERROR: Could not create dir '$prog->{dir}': $@";
exit 1;
}
}
}
# Return metadata of the prog
sub get_metadata {
my $prog = shift;
my $ua = shift;
$prog->{modes}->{default} = $prog->modelist();
if ( keys %{ $prog->{verpids} } == 0 ) {
if ( $prog->get_verpids( $ua ) ) {
main::logger "ERROR: Could not get version pid metadata\n" if $opt->{verbose};
return 1;
}
}
$prog->{versions} = join ',', sort keys %{ $prog->{verpids} };
return 0;
}
# Return metadata which is generic such as time and date
sub get_metadata_general {
my $prog = shift;
my @t;
# Special case for history mode, use {timeadded} to generate these two fields as this represents the time of recording
if ( $opt->{history} && $prog->{timeadded} ) {
@t = localtime( $prog->{timeadded} );
# Else use current time
} else {
@t = localtime();
}
#($second, $minute, $hour, $dayOfMonth, $month, $yearOffset, $dayOfWeek, $dayOfYear, $daylightSavings) = localtime();
$prog->{dldate} = sprintf "%02s-%02s-%02s", $t[5] + 1900, $t[4] + 1, $t[3];
$prog->{dltime} = sprintf "%02s:%02s:%02s", $t[2], $t[1], $t[0];
return 0;
}
# Displays specified metadata from supplied object
# Usage: $prog->display_metadata( )
sub display_metadata {
my %data = %{$_[0]};
shift;
my @keys = @_;
@keys = keys %data if $#_ < 0;
main::logger "\n";
for (@keys) {
# Format timeadded field nicely
if ( /^timeadded$/ ) {
if ( $data{$_} ) {
my @t = gmtime( time() - $data{$_} );
main::logger sprintf "%-15s %s\n", $_.':', "$t[7] days $t[2] hours ago ($data{$_})";
}
# Streams data
} elsif ( /^streams$/ ) {
# skip these
# If hash then list keys
} elsif ( ref$data{$_} eq 'HASH' ) {
for my $key ( sort keys %{$data{$_}} ) {
main::logger sprintf "%-15s ", $_.':';
if ( ref$data{$_}->{$key} ne 'HASH' ) {
main::logger "$key: $data{$_}->{$key}";
# This is the same as 'modes' list
#} else {
# main::logger "$key: ".(join ',', sort keys %{ $data{$_}->{$key} } );
}
main::logger "\n";
}
} elsif ( /^desclong$/ ) {
# strip line breaks
if ( $data{$_} ) {
(my $data_out = $data{$_}) =~ s|[\n\r]| |g;
main::logger sprintf "%-15s %s\n", $_.':', $data_out;
}
# else just print out key value pair
} else {
main::logger sprintf "%-15s %s\n", $_.':', $data{$_} if $data{$_};
}
}
main::logger "\n";
return 0;
}
# Return a list of episode pids from the given contents page/pid
sub get_pids_recursive {
my $prog = shift;
return '';
}
# Return hash of version => verpid given a pid
# Also put verpids in $prog->{verpids}->{} =
sub get_verpids {
my $prog = shift;
$prog->{verpids}->{'default'} = 1;
return 0;
}
# Download Subtitles, convert to srt(SubRip) format and apply time offset
sub download_subtitles {
# return failed...
return 1;
}
sub default_version_list {
return qw/ default original iplayer technical editorial lengthened shortened opensubtitled other signed audiodescribed /;
}
# Usage: generate_version_list ($prog)
# Returns sorted array of versions
sub generate_version_list {
my $prog = shift;
# Default Order with which to search for programme versions (can be overridden by --versionlist option)
my @version_search_order = default_version_list();
@version_search_order = split /,/, $opt->{versionlist} if $opt->{versionlist};
# check here for no matching verpids for specified version search list???
my $got = 0;
my @version_list;
for my $version ( @version_search_order ) {
if ( defined $prog->{verpids}->{$version} ) {
$got++;
push @version_list, $version;
}
}
if ( $got == 0 ) {
main::logger "INFO: No versions of this programme were selected (available versions: ".(join ',', sort keys %{ $prog->{verpids} }).")\n";
} else {
main::logger "INFO: Will search for versions: ".(join ',', @version_list)."\n" if $opt->{verbose};
}
return @version_list;
}
# Retry the recording of a programme
# Usage: download_retry_loop ( $prog )
sub download_retry_loop {
my $prog = shift;
my $hist = shift;
# Run the type init
$prog->init();
# If already downloaded then return (unless its for multimode)
return 0 if ( ! $opt->{multimode} ) && $hist->check( $prog->{pid} );
# Skip and warn if there is no pid
if ( ! $prog->{pid} ) {
main::logger "ERROR: No PID for index $_ (try using --type option ?)\n";
return 1;
}
# Setup user-agent
my $ua = main::create_ua( 'desktop' );
# This pre-gets all the metadata - necessary to avoid get_verpids() below if possible
$prog->get_metadata_general();
if ( $prog->get_metadata( $ua ) ) {
main::logger "ERROR: Could not get programme metadata\n" if $opt->{verbose};
return 1;
}
# Look up version pids for this prog - this does nothing if above get_metadata has alredy completed
if ( keys %{ $prog->{verpids} } == 0 ) {
if ( $prog->get_verpids( $ua ) ) {
main::logger "ERROR: Could not get version pid metadata\n" if $opt->{verbose};
return 1;
}
}
# Re-check history because get_verpids() can update the pid (e.g. BBC /programmes/ URLs)
return 0 if ( ! $opt->{multimode} ) && $hist->check( $prog->{pid} );
# if %{ $prog->{verpids} } is empty then skip this programme recording attempt
if ( (keys %{ $prog->{verpids} }) == 0 ) {
main::logger "INFO: No versions exist for this programme\n";
return 1;
}
my @version_search_list = $prog->generate_version_list;
return 1 if $#version_search_list < 0;
# Get all possible (or user overridden) modes for this prog recording
my $modelist = $prog->modelist;
main::logger "INFO: Mode list: $modelist\n" if $opt->{verbose};
######## version loop #######
# Do this for each version tried in this order (if they appeared in the content)
for my $version ( @version_search_list ) {
my $retcode = 1;
main::logger "DEBUG: Trying version '$version'\n" if $opt->{debug};
if ( $prog->{verpids}->{$version} ) {
main::logger "INFO: Checking existence of $version version\n";
$prog->{version} = $version;
main::logger "INFO: Version = $prog->{version}\n" if $opt->{verbose};
# Try to get stream data for this version if not already populated
if ( not defined $prog->{streams}->{$version} ) {
$prog->{streams}->{$version} = $prog->get_stream_data( $prog->{verpids}->{$version} );
}
########## mode loop ########
# record prog depending on the prog type
# only use modes that exist
my @modes;
my @available_modes = sort keys %{ $prog->{streams}->{$version} };
for my $modename ( split /,/, $modelist ) {
# find all numbered modes starting with this modename
push @modes, sort { $a cmp $b } grep /^$modename(\d+)?$/, @available_modes;
}
# Check for no applicable modes - report which ones are available if none are specified
if ($#modes < 0) {
my %available_modes_short;
# Strip the number from the end of the mode name and make a unique array
for ( @available_modes ) {
my $modename = $_;
$modename =~ s/\d+$//g;
$available_modes_short{$modename}++;
}
main::logger "INFO: No specified modes ($modelist) available for this programme with version '$version'\n";
main::logger "INFO: Try using --modes=".(join ',', sort keys %available_modes_short).")\n";
main::logger "INFO: You may receive this message if you are using get_iplayer outside the UK\n" if $#available_modes < 0;
next;
}
main::logger "INFO: ".join(',', @modes)." modes will be tried for version $version\n";
# Expand the modes into a loop
for my $mode ( @modes ) {
chomp( $mode );
(my $modeshort = $mode) =~ s/\d+$//g;
# force regeneration of file name if mode changed
if ( $prog->{modeshort} ne $modeshort ) {
undef $prog->{filename};
main::logger "INFO: Regenerate filename for mode change: $prog->{modeshort} -> $modeshort\n" if ( $prog->{modeshort} && $opt->{verbose} );
}
$prog->{mode} = $mode;
# Keep short mode name for substitutions
$prog->{modeshort} = $modeshort;
# If multimode is used, skip only modes which are in the history
next if $opt->{multimode} && $hist->check( $prog->{pid}, $mode );
main::logger "INFO: Trying $mode mode to record $prog->{type}: $prog->{name} - $prog->{episode}\n";
# try the recording for this mode (rtn==0 -> success, rtn==1 -> next mode, rtn==2 -> next prog)
$retcode = mode_ver_download_retry_loop( $prog, $hist, $ua, $mode, $version, $prog->{verpids}->{$version} );
main::logger "DEBUG: mode_ver_download_retry_loop retcode = $retcode\n" if $opt->{debug};
# quit if successful or skip (unless --multimode selected)
last if ( $retcode == 0 || $retcode == 2 ) && ! $opt->{multimode};
}
}
# Break out of loop if we have a successful recording for this version and mode
return 0 if not $retcode;
}
if (! $opt->{test}) {
main::logger "ERROR: Failed to record '$prog->{name} - $prog->{episode} ($prog->{pid})'\n";
}
return 1;
}
# returns 1 on fail, 0 on success
sub mode_ver_download_retry_loop {
my ( $prog, $hist, $ua, $mode, $version, $version_pid ) = ( @_ );
my $retries = $opt->{attempts} || 3;
my $count = 0;
my $retcode;
# Use different number of retries for flash modes
$retries = $opt->{attempts} || 50 if $mode =~ /^flash/;
# Retry loop
for ($count = 1; $count <= $retries; $count++) {
main::logger "INFO: Attempt number: $count / $retries\n" if $opt->{verbose};
# for live streams update and for each download attempt
# creates new output file if or in
if ( $prog->{type} =~ /live/ ) {
my @t = localtime();
$prog->{dldate} = sprintf "%02s-%02s-%02s", $t[5] + 1900, $t[4] + 1, $t[3];
$prog->{dltime} = sprintf "%02s:%02s:%02s", $t[2], $t[1], $t[0];
}
$retcode = $prog->download( $ua, $mode, $version, $version_pid );
main::logger "DEBUG: Record using $mode mode return code: '$retcode'\n" if $opt->{verbose};
# Exit
if ( $retcode eq 'abort' ) {
main::logger "ERROR: aborting get_iplayer\n";
exit 1;
# Try Next prog
} elsif ( $retcode eq 'skip' ) {
main::logger "INFO: skipping this programme\n";
return 2;
# Try Next mode
} elsif ( $retcode eq 'next' ) {
# break out of this retry loop
main::logger "INFO: skipping $mode mode\n";
last;
# Success
} elsif ( $retcode eq '0' ) {
# No need to do all these post-tasks if its streaming-only
if ( $opt->{stdout} ) {
# Run user command if streaming-only or a stream was writtem
$prog->run_user_command( $opt->{command} ) if $opt->{command};
# Skip
} else {
# Add to history, tag file, and run post-record command if a stream was written
main::logger "\n";
if ( $opt->{thumb} ) {
$prog->create_dir();
$prog->download_thumbnail();
}
if ( $opt->{metadata} ) {
$prog->create_dir();
$prog->create_metadata_file();
}
if ( ! $opt->{nowrite} ) {
$hist->add( $prog );
$prog->tag_file if ! $opt->{notag} && ! $opt->{raw};
} elsif ( $opt->{tagonly} ) {
$prog->tag_file;
}
if ( $opt->{command} && ! $opt->{nowrite} ) {
$prog->run_user_command( $opt->{command} );
}
}
$prog->report() if $opt->{pvr};
return 0;
# Retry this mode
} elsif ( $retcode eq 'retry' && $count < $retries ) {
main::logger "WARNING: Retry recording for '$prog->{name} - $prog->{episode} ($prog->{pid})'\n";
# Try to get stream data for this version/mode - retries require new auth data
$prog->{streams}->{$version} = $prog->get_stream_data( $version_pid );
}
}
return 1;
}
# Send a message to STDOUT so that cron can use this to email
sub report {
my $prog = shift;
print STDOUT "New $prog->{type} programme: '$prog->{name} - $prog->{episode}', '$prog->{desc}'\n";
return 0;
}
# create metadata for tagging
sub tag_metadata {
my $prog = shift;
my $meta;
while ( my ($key, $val) = each %{$prog} ) {
if ( ref($val) eq 'HASH' ) {
$meta->{$key} = $prog->{$key}->{$prog->{version}};
} else {
$meta->{$key} = $val;
}
}
return $meta;
}
# add metadata tags to file
sub tag_file {
my $prog = shift;
# return if file does not exist
return if ! -f $prog->{filename};
# download thumbnail if necessary
$prog->download_thumbnail if ( ! -f $prog->{thumbfile} && ! $opt->{noartwork} );
# create metadata
my $meta = $prog->tag_metadata;
# tag file
my $tagger = Tagger->new();
$tagger->tag_file($meta);
# clean up thumbnail if necessary
unlink $prog->{thumbfile} if ! $opt->{thumb};
}
# Create a metadata file if required
sub create_metadata_file {
my $prog = shift;
my $template;
my $filename;
# XML template for XBMC/Kodi movies - Ref: http://xbmc.org/wiki/?title=Import_-_Export_Library#Movies
$filename->{xbmc_movie} = "$prog->{dir}/$prog->{fileprefix}.nfo";
$template->{xbmc_movie} = '
[name] - [episode]
[desc]
[desclong]
[descshort]
[runtime]
[thumbnail]
[pid]
[dir]/[fileprefix].[ext]
[categories]
[firstbcast]
[channel]
';
$filename->{kodi_movie} = $filename->{xbmc_movie};
$template->{kodi_movie} = $template->{xbmc_movie};
# XML template for XBMC - Ref: http://xbmc.org/wiki/?title=Import_-_Export_Library#TV_Episodes
$filename->{xbmc} = "$prog->{dir}/$prog->{fileprefix}.nfo";
$template->{xbmc} = '
[name] - [episode]
10.00
[seriesnum]
[episodenum]
[desclong]
[channel]
[firstbcast]
';
$filename->{kodi} = $filename->{xbmc};
$template->{kodi} = $template->{xbmc};
# XML template for Freevo - Ref: http://doc.freevo.org/MovieFxd
$filename->{freevo} = "$prog->{dir}/$prog->{fileprefix}.fxd";
$template->{freevo} = '
[fileprefix].[ext]
[dldate] [dltime]
[desclong]
[episode]
[firstbcast]
[categories]
[runtime] minutes
[channel]
';
# Generic XML template for all info
$filename->{generic} = "$prog->{dir}/$prog->{fileprefix}.xml";
$template->{generic} = ''."\n";
$template->{generic} .= ''."\n";
$template->{generic} .= "\t<$_>[$_]$_>\n" for ( sort keys %{$prog} );
$template->{generic} .= " \n";
return if ! -d $prog->{dir};
if ( not defined $template->{ $opt->{metadata} } ) {
main::logger "WARNING: metadata type '$opt->{metadata}' is not valid - must be one of ".(join ',', keys %{$template} )."\n";
return;
}
main::logger "INFO: Writing $opt->{metadata} metadata to file '$filename->{ $opt->{metadata} }'\n";
if ( open(XML, "> $filename->{ $opt->{metadata} }") ) {
my $text = $prog->substitute( $template->{ $opt->{metadata} }, 3, '\[', '\]' );
# Strip out unsubstituted tags
$text =~ s/<.+?>\[.+?\]<.+?>[\s\n\r]*//g;
# Hack: substitute here because freevo needs either or depending on filetype
if ( $opt->{metadata} eq 'freevo' ) {
if ( $prog->{type} =~ /radio/i ) {
$text =~ s/FREEVOTYPE/audio/g;
} else {
$text =~ s/FREEVOTYPE/movie/g;
}
}
print XML $text;
close XML;
} else {
main::logger "WARNING: Couldn't write to metadata file '$filename->{ $opt->{metadata} }'\n";
}
}
# Usage: print $prog{$pid}->substitute('--', [mode], [begin regex tag], [end regex tag]);
# Return a string with formatting fields substituted for a given pid
# sanitize_mode == 0 then sanitize final string and also sanitize '/' in field values
# sanitize_mode == 1 then sanitize final string but don't sanitize '/' (and '\' on Windows) in field values
# sanitize_mode == 2 then just substitute only
# sanitize_mode == 3 then substitute then use encode entities for fields only
# sanitize_mode == 4 then substitute then escape characters in fields only for use in double-quoted shell text.
#
# Also if it find a HASH type then the $prog->{} element is searched and used
# Likewise, if a ARRAY type is found, elements are joined with commas
sub substitute {
my ( $self, $string, $sanitize_mode, $tag_begin, $tag_end ) = ( @_ );
$sanitize_mode = 0 if not defined $sanitize_mode;
$tag_begin = '\<' if not defined $tag_begin;
$tag_end = '\>' if not defined $tag_end;
my $version = $self->{version} || 'unknown';
my $replace = '';
# Make 'duration' == 'length' for the selected version
$self->{duration} = $self->{durations}->{$version} if $self->{durations}->{$version};
$self->{runtime} = int($self->{duration} / 60);
# Tokenize and substitute $format
for my $key ( keys %{$self} ) {
my $value = $self->{$key};
# Get version specific value if this key is a hash
if ( ref$value eq 'HASH' ) {
if ( ref$value->{$version} ne 'HASH' ) {
$value = $value->{$version};
} else {
$value = 'unprintable';
}
}
# Join array elements if value is ARRAY type
if ( ref$value eq 'ARRAY' ) {
$value = join ',', @{ $value };
}
$value = '' if not defined $value;
main::logger "DEBUG: Substitute ($version): '$key' => '$value'\n" if $opt->{debug};
# Remove/replace all non-nice-filename chars if required
# Keep '/' (and '\' on Windows) if $sanitize_mode == 1
if ($sanitize_mode == 0 || $sanitize_mode == 1) {
$replace = StringUtils::sanitize_path( $value, $sanitize_mode );
# html entity encode
} elsif ($sanitize_mode == 3) {
$replace = encode_entities( $value, '&<>"\'' );
# escape these chars: ! ` \ "
} elsif ($sanitize_mode == 4) {
$replace = $value;
# Don't escape file paths
if ( $key !~ /(filename|filepart|thumbfile)/ ) {
$replace =~ s/([\!"\\`])/\\$1/g;
}
} else {
$replace = $value;
}
# special handling for
$replace = '' if $replace eq '-' && $key =~ /episode/i;
# look for prefix in tag
my $pfx_key = $tag_begin.'([^A-Za-z1-9'.$tag_end.']*?)(0*?)'.$key.$tag_end;
my ($prefix, $pad) = $string =~ m/$pfx_key/;
if ( $replace =~ m/^\d+$/ && length($pad) > length($replace) ) {
$replace = substr($pad.$replace, -length($pad))
}
$pfx_key = $tag_begin."\Q$prefix$pad\E".$key.$tag_end;
$prefix = '' if ! $replace;
$string =~ s|$pfx_key|$prefix$replace|gi;
}
if ( $sanitize_mode == 0 || $sanitize_mode == 1 ) {
# Remove unused tags
my $key = $tag_begin.'.*?'.$tag_end;
$string =~ s|$key||mg;
# Replace whitespace with _ unless --whitespace
$string =~ s/\s/_/g unless $opt->{whitespace};
}
return $string;
}
# Determine the correct filenames for a recording
# Sets the various filenames and creates appropriate directories
# Gets more programme metadata if the prog name does not exist
#
# Uses:
# $opt->{fileprefix}
# $opt->{subdir}
# $opt->{whitespace}
# $opt->{test}
# Requires:
# $prog->{dir}
# Sets:
# $prog->{fileprefix}
# $prog->{filename}
# $prog->{filepart}
# $prog->{symlink}
# Returns 0 on success, 1 on failure (i.e. if the already exists)
#
sub generate_filenames {
my ($prog, $ua, $format, $multipart) = (@_);
# Get and set more meta data - Set the %prog values from metadata if they aren't already set (i.e. with --pid option)
if ( ! $prog->{name} ) {
if ( $prog->get_metadata( $ua ) ) {
main::logger "ERROR: Could not get programme metadata\n" if $opt->{verbose};
return 1;
}
$prog->get_metadata_general();
}
# Create symlink filename if required
# do first before or are encoded
if ( $opt->{symlink} ) {
# Substitute the fields for the pid
$prog->{symlink} = $prog->substitute( $opt->{symlink}, 1 );
$prog->{symlink} = main::encode_fs($prog->{symlink});
main::logger("INFO: Symlink file name will be '$prog->{symlink}'\n") if $opt->{verbose};
# remove old symlink
unlink $prog->{symlink} if -l $prog->{symlink} && ! $opt->{test};
}
# Determine directory and find its absolute path
$prog->{dir} = File::Spec->rel2abs( $opt->{ 'output'.$prog->{type} } || $opt->{output} || $ENV{IPLAYER_OUTDIR} || '.' );
$prog->{dir} = main::encode_fs($prog->{dir});
# Add modename to default format string if multimode option is used
$format .= ' ' if $opt->{multimode};
$prog->{fileprefix} = $opt->{fileprefix} || $format;
# get $name, $episode from title
my ( $name, $episode ) = Programme::bbciplayer::split_title( $prog->{title} ) if $prog->{title};
$prog->{name} = $name if $name && ! $prog->{name};
$prog->{episode} = $episode if $episode && ! $prog->{episode};
# store the name extracted from the title metadata in else just use the field
$prog->{longname} = $prog->{name} || $name;
# Set some common metadata fallbacks
$prog->{nameshort} = $prog->{name} if ! $prog->{nameshort};
$prog->{episodeshort} = $prog->{episode} if ! $prog->{episodeshort};
# Create descmedium, descshort by truncation of desc if they don't already exist
$prog->{descmedium} = substr( $prog->{desc}, 0, 1024 ) if ! $prog->{descmedium};
$prog->{descshort} = substr( $prog->{desc}, 0, 255 ) if ! $prog->{descshort};
# substitute fields and sanitize $prog->{fileprefix}
main::logger "DEBUG: Substituted '$prog->{fileprefix}' as " if $opt->{debug};
# Don't allow in fileprefix as it can break when resumes fallback on differently numbered modes of the same type change for
$prog->{fileprefix} =~ s///g;
$prog->{fileprefix} = $prog->substitute( $prog->{fileprefix} );
$prog->{fileprefix} = main::encode_fs($prog->{fileprefix});
# Truncate filename to 240 chars (allows for extra stuff to keep it under system 256 limit)
$prog->{fileprefix} = substr( $prog->{fileprefix}, 0, 240 );
# Change the date in the filename to ISO8601 format if required
$prog->{fileprefix} =~ s|(\d\d)[/_](\d\d)[/_](20\d\d)|$3-$2-$1|g if $opt->{isodate};
main::logger "'$prog->{fileprefix}'\n" if $opt->{debug};
# Special case for history mode, parse the fileprefix and dir from filename if it is already defined
if ( $opt->{history} && defined $prog->{filename} && $prog->{filename} ne '' ) {
( $prog->{fileprefix}, $prog->{dir}, $prog->{ext} ) = fileparse($prog->{filename}, qr/\.[^.]*/);
# Fix up file path components
$prog->{ext} =~ s/\.//;
$prog->{dir} = File::Spec->canonpath($prog->{dir});
$prog->{filename} = File::Spec->catfile($prog->{dir}, "$prog->{fileprefix}.$prog->{ext}");
}
# Don't create subdir if we are only testing recordings
# Create a subdir for programme sorting option
if ( $opt->{subdir} ) {
my $subdir = $prog->substitute( $opt->{subdirformat} || '', 1 );
if ( $opt->{isodate} ) {
$subdir =~ s|(\d\d)[/_](\d\d)[/_](20\d\d)|$3-$2-$1|g;
} else {
$subdir =~ s|(\d\d)[/](\d\d)[/](20\d\d)|$1_$2_$3|g;
}
$prog->{dir} = File::Spec->catdir($prog->{dir}, $subdir);
$prog->{dir} = main::encode_fs($prog->{dir});
main::logger("INFO: Creating subdirectory $prog->{dir} for programme\n") if $opt->{verbose};
}
# Create a subdir if there are multiple parts
if ( $multipart ) {
$prog->{dir} = File::Spec->catdir($prog->{dir}, $prog->{fileprefix});
$prog->{dir} = main::encode_fs($prog->{dir});
main::logger("INFO: Creating multi-part subdirectory $prog->{dir} for programme\n") if $opt->{verbose};
}
main::logger("\rINFO: File name prefix = $prog->{fileprefix} \n");
# Use a dummy file ext if one isn't set - helps with readability of metadata
$prog->{ext} = 'EXT' if ! $prog->{ext};
# check if file extension has changed as a result of failed attempt with different mode
my $ext_changed = 0;
if ( ! $opt->{history} && ! $opt->{multimode} && defined $prog->{filename} && $prog->{filename} ne '' ) {
( my $fileprefix, my $dir, my $ext ) = fileparse($prog->{filename}, qr/\.[^.]*/);
$ext =~ s/\.//;
$ext_changed = ( defined $ext && $ext ne '' && $ext ne $prog->{ext} );
main::logger "DEBUG: File ext changed: $ext -> $prog->{ext}\n" if $ext_changed && $opt->{debug};
}
# Don't override the {filename} if it is already set (i.e. for history info) or unless multimode option is specified
$prog->{filename} = File::Spec->catfile($prog->{dir}, "$prog->{fileprefix}.$prog->{ext}") if ( defined $prog->{filename} && $prog->{filename} =~ /\.EXT$/ ) || $opt->{multimode} || ! $prog->{filename} || $ext_changed;
$prog->{filepart} = File::Spec->catfile($prog->{dir}, "$prog->{fileprefix}.partial.$prog->{ext}");
$prog->{filename} = main::encode_fs($prog->{filename});
$prog->{filepart} = main::encode_fs($prog->{filepart});
# overwrite/error if the file already exists and is going to be written to
if (
( ! $opt->{nowrite} )
&& ( ! $opt->{metadataonly} )
&& ( ! $opt->{thumbonly} )
&& ( ! $opt->{subsonly} )
&& ( ! $opt->{tagonly} )
&& -f $prog->{filename}
&& stat($prog->{filename})->size > $prog->min_download_size()
) {
if ( $opt->{overwrite} ) {
main::logger("INFO: Overwriting file $prog->{filename}\n\n");
unlink $prog->{filename} unless $opt->{test};
} else {
main::logger("WARNING: File $prog->{filename} already exists\n\n");
return 1;
}
}
# Determine thumbnail filename
if ( $prog->{thumbnail} =~ /^http/i ) {
my $ext;
$ext = $1 if $prog->{thumbnail} =~ m{\.(\w+)$};
$ext = $opt->{thumbext} || $ext;
$prog->{thumbfile} = File::Spec->catfile($prog->{dir}, "$prog->{fileprefix}.${ext}");
$prog->{thumbfile} = main::encode_fs($prog->{thumbfile});
}
main::logger "DEBUG: File prefix: $prog->{fileprefix}\n" if $opt->{debug};
main::logger "DEBUG: File ext: $prog->{ext}\n" if $opt->{debug};
main::logger "DEBUG: Directory: $prog->{dir}\n" if $opt->{debug};
main::logger "DEBUG: Partial Filename: $prog->{filepart}\n" if $opt->{debug};
main::logger "DEBUG: Final Filename: $prog->{filename}\n" if $opt->{debug};
main::logger "DEBUG: Thumbnail Filename: $prog->{thumbfile}\n" if $opt->{debug};
main::logger "DEBUG: Raw Mode: $opt->{raw}\n" if $opt->{debug};
# Check path length is < 256 chars (Windows only)
if ( length( $prog->{filepart} ) > 255 && $^O eq "MSWin32" ) {
main::logger("ERROR: Generated file path is too long, please use --fileprefix, --subdir and --output options to shorten it to below 256 characters ('$prog->{filepart}')\n\n");
return 1;
}
return 0;
}
# Run a user specified command
# e.g. --command 'echo " recorded"'
# run_user_command($pid, 'echo " recorded"');
sub run_user_command {
my $prog = shift;
my $command = shift;
# Substitute the fields for the pid (and sanitize for double-quoted shell use)
$command = $prog->substitute( $command, 4 );
$command = main::encode_fs($command);
# run command
main::logger "INFO: Running command '$command'\n" if $opt->{verbose};
my $exit_value = main::run_cmd( 'normal', $command );
main::logger "ERROR: Command Exit Code: $exit_value\n" if $exit_value;
main::logger "INFO: Command succeeded\n" if $opt->{verbose} && ! $exit_value;
return 0;
}
# %type
# Display a line containing programme info (using long, terse, and type options)
sub list_entry {
my ( $prog, $prefix, $tree, $number_of_types, $episode_count, $episode_width ) = ( @_ );
my $prog_type = '';
# Show the type field if >1 type has been specified
$prog_type = "$prog->{type}, " if $number_of_types > 1;
my $name;
# If tree view
if ( $opt->{tree} ) {
$prefix = ' '.$prefix;
$name = '';
} else {
$name = "$prog->{name} - ";
}
main::logger "\n${prog_type}$prog->{name}\n" if $opt->{tree} && ! $tree;
# Display based on output options
if ( $opt->{listformat} ) {
# Slow. Needs to be faster e.g:
#main::logger 'ENTRY'."$prog->{index}|$prog->{thumbnail}|$prog->{pid}|$prog->{available}|$prog->{type}|$prog->{name}|$prog->{episode}|$prog->{versions}|$prog->{duration}|$prog->{desc}|$prog->{channel}|$prog->{categories}|$prog->{timeadded}|$prog->{guidance}|$prog->{web}|$prog->{filename}|$prog->{mode}\n";
main::logger $prefix.$prog->substitute( $opt->{listformat}, 2 )."\n";
} elsif ( $opt->{series} && $episode_width && $episode_count && ! $opt->{tree} ) {
main::logger sprintf( "%s%-${episode_width}s %5s %s\n", $prefix, $prog->{name}, "($episode_count)", $prog->{categories} );
} elsif ( $opt->{long} ) {
my @time = gmtime( time() - $prog->{timeadded} );
main::logger "${prefix}$prog->{index}:\t${prog_type}${name}$prog->{episode}".$prog->optional_list_entry_format.", $time[7] days $time[2] hours ago - $prog->{desc}\n";
} elsif ( $opt->{terse} ) {
main::logger "${prefix}$prog->{index}:\t${prog_type}${name}$prog->{episode}\n";
} else {
main::logger "${prefix}$prog->{index}:\t${prog_type}${name}$prog->{episode}".$prog->optional_list_entry_format."\n";
}
return 0;
}
sub list_entry_html {
my ($prog, $tree) = (@_);
my $html;
# If tree view
my $name = encode_entities( $prog->{name} );
my $episode = encode_entities( $prog->{episode} );
my $desc = encode_entities( $prog->{desc} );
my $channel = encode_entities( $prog->{channel} );
my $type = encode_entities( $prog->{type} );
my $categories = encode_entities( $prog->{categories} );
# Header
if ( not $tree ) {
# Assume all thumbnails for a prog name are the same
$html = "
{web}\"> {thumbnail}\">
{web}\">${name}
${channel}
${type}
${categories}
\n";
# Follow-on episodes
}
$html .= "
$_
{web}\">${episode}
${desc}
\n";
return $html;
}
# Creates symlink
# Usage: $prog->create_symlink( , );
sub create_symlink {
my $prog = shift;
my $symlink = shift;
my $target = shift;
if ( ( ! ( $opt->{stdout} && $opt->{nowrite} ) ) && ( ! $opt->{test} ) ) {
# remove old symlink
unlink $symlink if -l $symlink;
# Create symlink
symlink $target, $symlink;
main::logger "INFO: Created symlink from '$symlink' -> '$target'\n" if $opt->{verbose};
}
}
# Get time ago made available (x days y hours ago) from '2008-06-22T05:01:49Z' and specified epoch time
# Or, Get time in epoch from '2008-06-22T05:01:49Z' or '2008-06-22T05:01:49[+-]NN:NN' if no specified epoch time
sub get_time_string {
$_ = shift;
my $diff = shift;
# suppress warnings for > 32-bit dates in obsolete Perl versions
local $SIG{__WARN__} = sub {
warn @_ unless $_[0] =~ m(^.* too (?:big|small));
};
# extract $year $mon $mday $hour $min $sec $tzhour $tzmin
my ($year, $mon, $mday, $hour, $min, $sec, $tzhour, $tzmin);
if ( m{(\d\d\d\d)\-(\d\d)\-(\d\d)T(\d\d):(\d\d):(\d\d)} ) {
($year, $mon, $mday, $hour, $min, $sec) = ($1, $2, $3, $4, $5, $6);
} else {
return '';
}
# positive TZ offset
($tzhour, $tzmin) = ($1, $2) if m{\d\d\d\d\-\d\d\-\d\dT\d\d:\d\d:\d\d\+(\d\d):(\d\d)};
# negative TZ offset
($tzhour, $tzmin) = ($1*-1, $2*-1) if m{\d\d\d\d\-\d\d\-\d\dT\d\d:\d\d:\d\d\-(\d\d):(\d\d)};
# ending in 'Z'
($tzhour, $tzmin) = (0, 0) if m{\d\d\d\d\-\d\d\-\d\dT\d\d:\d\d:\d\dZ};
main::logger "DEBUG: $_ = $year, $mon, $mday, $hour, $min, $sec, $tzhour, $tzmin\n" if $opt->{debug};
# Sanity check date data
return '' if $year < 1970 || $mon < 1 || $mon > 12 || $mday < 1 || $mday > 31 || $hour < 0 || $hour > 24 || $min < 0 || $min > 59 || $sec < 0 || $sec > 59 || $tzhour < -13 || $tzhour > 13 || $tzmin < -59 || $tzmin > 59;
# Calculate the seconds difference between epoch_now and epoch_datestring and convert back into array_time
my $epoch = eval { timegm($sec, $min, $hour, $mday, ($mon-1), ($year-1900), undef, undef, 0) - $tzhour*60*60 - $tzmin*60; };
# ensure safe 32-bit date if timegm croaks
if ( $@ ) { $epoch = timegm(0, 0, 0, 1, 0, 138, undef, undef, 0) - $tzhour*60*60 - $tzmin*60; };
my $rtn;
if ( $diff ) {
# Return time ago
if ( $epoch < $diff ) {
my @time = gmtime( $diff - $epoch );
# The time() func gives secs since 1970, gmtime is since 1900
my $years = $time[5] - 70;
$rtn = "$years years " if $years;
$rtn .= "$time[7] days $time[2] hours ago";
return $rtn;
# Return time to go
} elsif ( $epoch > $diff ) {
my @time = gmtime( $epoch - $diff );
my $years = $time[5] - 70;
$rtn = 'in ';
$rtn .= "$years years " if $years;
$rtn .= "$time[7] days $time[2] hours";
return $rtn;
# Return 'Now'
} else {
return "now";
}
# Return time in epoch
} else {
# Calculate the seconds difference between epoch_now and epoch_datestring and convert back into array_time
return $epoch;
}
}
sub download_thumbnail {
my $prog = shift;
my $file;
my $ext;
my $image;
if ( $prog->{thumbnail} =~ /^http/i && $prog->{thumbfile} ) {
main::logger "INFO: Getting thumbnail from $prog->{thumbnail}\n" if $opt->{verbose};
$file = $prog->{thumbfile};
# Download thumb
$image = main::request_url_retry( main::create_ua( 'desktop', 1 ), $prog->{thumbnail}, 1);
if (! $image ) {
main::logger "ERROR: Thumbnail Download failed\n";
return 1;
} else {
main::logger "INFO: Downloaded Thumbnail to '$file'\n" if $opt->{verbose} || $opt->{thumb};
}
} else {
# Return if we have no url
main::logger "INFO: Thumbnail not available\n" if $opt->{verbose};
return 2;
}
# Write to file
unlink($file);
open( my $fh, ">:raw", $file );
print $fh $image;
close $fh;
return 0;
}
sub check_duration {
my $prog = shift;
my $filename = shift || $prog->{filename};
return unless $prog->{duration} && $filename;
my $cmd = "\"$bin->{ffmpeg}\" -i \"$filename\" 2>&1";
$cmd = main::encode_fs($cmd);
my $ffout = `$cmd`;
if ( $ffout =~ /duration:\s+((\d+):(\d\d):(\d\d))/i ) {
my $expected_s = $prog->{duration};
if ( $opt->{start} && ! $opt->{stop} ) {
$expected_s -= $opt->{start};
} elsif ( $opt->{stop} ) {
$expected_s = $opt->{stop} - $opt->{start};
}
my $expected = sprintf("%02d:%02d:%02d", $expected_s / 3600, ($expected_s % 3600) / 60, $expected_s % 60);
my $recorded_s = ($2 * 3600) + ($3 * 60) + $4;
my $recorded = $1;
my $diff_s = abs($recorded_s - $expected_s);
my $diff_sign = $recorded_s < $expected_s ? "-" : "";
my $diff = sprintf("$diff_sign%02d:%02d:%02d", $diff_s / 3600, ($diff_s % 3600) / 60, $diff_s % 60);
main::logger "\nINFO: Duration check: recorded: $recorded expected: $expected difference: $diff file: $filename\n\n";
} else {
main::logger "WARNING: Could not determine recorded duration of file: $filename\n";
}
}
################### iPlayer Parent class #################
package Programme::bbciplayer;
use Env qw[@PATH];
use Fcntl;
use File::Copy;
use File::Path;
use File::stat;
use HTML::Entities;
use HTTP::Cookies;
use HTTP::Headers;
use IO::Seekable;
use IO::Socket;
use LWP::ConnCache;
use LWP::UserAgent;
use POSIX qw(mkfifo);
use Storable qw(dclone);
use strict;
use Time::Local;
use URI;
# Inherit from Programme class
use base 'Programme';
# Return hash of version => verpid given a pid
sub get_verpids {
my ( $prog, $ua ) = @_;
my $url;
# If this is already a live or streaming verpid just pass it through
# e.g. http://www.bbc.co.uk/mediaselector/4/gtis/?server=cp52115.live.edgefcs.net&identifier=sport1a@s2388&kind=akamai&application=live&cb=28022
if ( $prog->{pid} =~ m{^http.+/mediaselector/4/[gm]tis}i ) {
# bypass all the xml parsing and return
$prog->{verpids}->{default} = $1 if $prog->{pid} =~ m{^.+(\?.+)$};
# Name
my $title;
$title = $1 if $prog->{pid} =~ m{identifier=(.+?)&};
$title =~ s/\@/_/g;
# Add to prog hash
$prog->{versions} = join ',', keys %{ $prog->{verpids} };
$prog->{title} = decode_entities($title);
return 0;
# Determine if the is a standard pid, Live TV or EMP TV URL
# EMP URL
} elsif ( $prog->{pid} =~ /^http/i ) {
$url = $prog->{pid};
if ( $HTML::Parser::VERSION < 3.71 ) {
main::logger "WARNING: Page parsing may fail with HTML::Parser versions before 3.71. You have version $HTML::Parser::VERSION.\n";
}
# May aswell set the web page metadata here if not set
$prog->{web} = $prog->{pid} if ! $prog->{web};
# Scrape the EMP web page and get playlist URL
my $xml = main::request_url_retry( $ua, $url, 3 );
if ( ! $xml ) {
main::logger "\rERROR: Failed to get EMP page from BBC site\n\n";
return 1;
}
# flatten
$xml =~ s/\n/ /g;
# Find playlist URL in various guises
# JSON config block
if ( $xml =~ m{["\s]pid["\s]:\s?["']([bp]0[a-z0-9]{6})["']} ) {
$prog->{pid} = $1;
$url = 'http://www.bbc.co.uk/iplayer/playlist/'.$prog->{pid};
} elsif ( $xml =~ m{ {pid} = $1;
$url = 'http://www.bbc.co.uk/iplayer/playlist/'.$1;
# live streams (e.g., olympics)
} elsif ( $xml =~ m{"href":\s*"(http:\\/\\/playlists.bbc.co.uk\\/.+?\\/playlist.sxml)"[^\}]+?"live":\s*true} ) {
($url = $1) =~ s/\\//g;
$prog->{pid} = $url;
} elsif ( $xml =~ m{live-experience\/services.+?pid=([bp]0[a-z0-9]{6})} ) {
$url = 'http://www.bbc.co.uk/iplayer/playlist/'.$1;
$prog->{pid} = $url;
# playlist embedded in JSON
} elsif ( $xml =~ m{"href":"(http:\\/\\/playlists.bbc.co.uk\\/.+?\\/playlist.sxml)"} ) {
($url = $1) =~ s/\\//g;
# embedded player
} elsif ( $xml =~ m{emp\.load\("(http://www.bbc.co.uk/iplayer/playlist/([bp]0[a-z0-9]{6}))"\)} ) {
$url = $1;
$prog->{pid} = $2;
} elsif ( $url =~ m{^http.+.xml$} ) {
# Just keep the url as it is probably already an xml playlist
## playlist: "http://www.bbc.co.uk/iplayer/playlist/bbc_radio_one",
#} elsif ( $xml =~ m{playlist: "http.+?playlist\/(\w+?)"}i ) {
# $prog->{pid} = $1;
# $url = 'http://www.bbc.co.uk/iplayer/playlist/'.$prog->{pid};
}
# URL decode url
$url = main::url_decode( $url );
# iPlayer LiveTV or PID
} else {
$url = 'http://www.bbc.co.uk/iplayer/playlist/'.$prog->{pid};
# use the audiodescribed playlist url if non-default versions are specified
$url .= '/ad' if defined $opt->{versionlist} && $opt->{versionlist} =~ /(audiodescribed|signed)/;
}
main::logger "INFO: iPlayer metadata URL = $url\n" if $opt->{verbose};
#main::logger "INFO: Getting version pids for programme $prog->{pid} \n" if ! $opt->{verbose};
# send request
my $xml = main::request_url_retry( $ua, $url, 3 );
if ( ! $xml ) {
main::logger "\rERROR: Failed to get version pid metadata from iplayer site\n\n";
return 1;
}
# The URL http://www.bbc.co.uk/iplayer/playlist/ contains for example:
#
#
# tag:bbc.co.uk,2008:pips:b00dlrc8:playlist
#
#
#
# Amazon with Bruce Parry: Episode 1
# Bruce Parry begins an epic adventure in the Amazon following the river from source to sea, beginning in the High Andes and visiting the Ashaninka tribe.
# 2008-09-18T14:03:35Z
# -
#
tag:bbc.co.uk,2008:pips:bbc_two
#
#
# -
#
1
# tag:bbc.co.uk,2008:pips:b00dlr9p
# BBC Two
# BBC Two
#
#
# Contains some strong language.
#
#
# -
#
1
# tag:bbc.co.uk,2008:pips:b00dp4xn
# BBC One
# BBC Two
#
#
# Contains some strong language.
#
#
# If a prog is totally unavailable you get
# ...
# 2009-01-15T23:13:33Z
#
#
#
# flatten
$xml =~ s/\n/ /g;
# set title here - broken in JSON playlists
$prog->{title} = decode_entities($1) if $xml =~ m{\s*(.+?)\s*<\/title>};
$prog->{thumbnail} ||= $1 if $xml =~ m{ {guidance} ||= $1 if $xml =~ m{(.*?)};
$prog->{descshort} = $1 if $xml =~ m{(.*?) };
$prog->{type} ||= 'tv' if grep /kind="programme"/, $xml;
$prog->{type} ||= 'radio' if grep /kind="radioProgramme"/, $xml;
# Detect noItems or no programmes
if ( $xml =~ m{get_verpids_json( $ua );
my $rc_html = 1;
if ( ( ! $prog->{type} || $prog->{type} eq 'tv' ) && ! $opt->{noscrapeversions} ) {
$rc_html = $prog->get_verpids_html( $ua );
}
return 0 if ! $rc_json || ! $rc_html;
main::logger "\nWARNING: No programmes are available for this pid with version(s): ".($opt->{versionlist} ? $opt->{versionlist} : 'default').($prog->{versions} ? " (available versions: $prog->{versions})\n" : "\n");
main::logger "WARNING: You may receive this message if you are using get_iplayer outside the UK\n";
return 1;
}
# Split into - sections
my $prev_version = '';
for ( split /
- {debug};
my ($verpid, $version);
# Treat live streams accordingly
# Live TV
if ( m{\s+simulcast="true"} ) {
$version = 'default';
#
-
# $verpid = "http://www.bbc.co.uk/emp/simulcast/".$2.".xml" if m{\s+live="true"\s+(liverewind="true"\s+)?identifier="(.+?)"};
$verpid = $2 if m{\s+live="true"\s+(liverewind="true"\s+)?identifier="(.+?)"};
my $hls_pid_map = Programme::livetv->hls_pid_map();
my $hls_pid = $hls_pid_map->{$prog->{pid}};
$verpid = $hls_pid || $verpid;
main::logger "INFO: Using Live TV: $verpid\n" if $opt->{verbose} && $verpid;
# Live/Non-live EMP tv/radio XML URL
} elsif ( $prog->{pid} =~ /^http/i && $url =~ /^http.+xml$/ ) {
$version = 'default';
$verpid = $url;
main::logger "INFO: Using Live/Non-live EMP tv/radio XML URL: $verpid\n" if $opt->{verbose} && $verpid;
# Live/Non-live EMP tv/radio URL
} elsif ( $prog->{pid} =~ /^http/i && $url =~ /^http/ ) {
$version = 'default';
$verpid = $url;
main::logger "INFO: Using Live/Non-live EMP tv/radio URL: $verpid\n" if $opt->{verbose} && $verpid;
# Live/Non-live EMP tv/radio
} elsif ( $prog->{pid} =~ /^http/i ) {
$version = 'default';
#
#
#
#
#
# verpid = ?server=cp52115.live.edgefcs.net&identifier=sport2a@s2405&kind=akamai&application=live
$verpid = "?server=$4&identifier=$3&kind=$1&application=$2" if $xml =~ m{{verbose} && $verpid;
# Live radio
} elsif ( m{\s+live="true"\s} ) {
# Try to get live stream version and verpid
# -
$verpid = $1 if m{\s+live="true"\s+identifier="(.+?)"};
my $hls_pid_map = Programme::liveradio->hls_pid_map();
my $hls_pid = $hls_pid_map->{$prog->{pid}};
$verpid = $hls_pid || $verpid;
$version = 'default';
main::logger "INFO: Using Live radio: $verpid\n" if $opt->{verbose} && $verpid;
# Not Live standard TV and Radio
} else {
# duration="3600" identifier="b00dp4xn" group="b00dlrc8" publisher="pips">
$verpid = $1 if m{\s+duration=".*?"\s+identifier="(.+?)"};
# assume default version
my $curr_version = "default";
#
if ( m{ 'audiodescribed' if we are using the /ad playlist URL:
if ( defined $opt->{versionlist} && $opt->{versionlist} =~ /(audiodescribed|signed)/ ) {
$curr_version = 'audiodescribed' if $curr_version eq 'default';
}
}
$version = $curr_version;
# check version collisions
if ( $prog->{verpids}->{$curr_version} ) {
my $vercount = 1;
# Search for the next free suffix
while ( $prog->{verpids}->{$curr_version} ) {
$vercount++;
$curr_version = $version.$vercount;
}
$version = $curr_version;
}
main::logger "INFO: Using Not Live standard TV and Radio: $verpid\n" if $opt->{verbose} && $verpid;
}
next if ! ($verpid && $version);
$prog->{verpids}->{$version} = $verpid;
$prog->{durations}->{$version} = $1 if m{duration="(\d+?)"};
main::logger "INFO: Version: $version, VersionPid: $verpid, Duration: $prog->{durations}->{$version}\n" if $opt->{verbose};
}
# try json playlist for channel and any missing fields
if ( $prog->{type} eq 'tv' || $prog->{type} eq 'radio' ) {
$prog->get_verpids_json( $ua );
}
# Add to prog hash
$prog->{versions} = join ',', keys %{ $prog->{verpids} };
return 0;
}
# Return hash of version => verpid given a pid
# Uses JSON playlist: http://www.bbc.co.uk/programmes//playlist.json
sub get_verpids_json {
my ( $prog, $ua ) = @_;
my $pid;
if ( $prog->{pid} =~ /^http/i ) {
$pid = $1 if $prog->{pid} =~ /\/([bp]0[a-z0-9]{6})/
}
$pid ||= $prog->{pid};
if ( $prog->{pid} ne $pid ) {
main::logger "INFO: pid changed from $prog->{pid} to $pid (JSON)\n" if $opt->{verbose};
$prog->{pid} = $pid;
}
if ( $pid !~ /^[bp]0[a-z0-9]{6}$/ ) {
main::logger "INFO: skipping playlist for non-PID $pid (JSON)\n" if $opt->{verbose};
return;
}
my $url = 'http://www.bbc.co.uk/programmes/'.$pid.'/playlist.json';
main::logger "INFO: iPlayer metadata URL (JSON) = $url\n" if $opt->{verbose};
my $json = main::request_url_retry( $ua, $url, 3 );
if ( ! $json ) {
main::logger "ERROR: Failed to get version pid metadata from iplayer site (JSON)\n";
return 1;
}
my ( $default, $versions ) = split /"allAvailableVersions"/, $json;
unless ( $prog->{channel} ) {
$prog->{channel} = $1 if $default =~ /"masterBrandName":"(.*?)"/;
}
unless ( $prog->{descshort} ) {
$prog->{descshort} = $1 if $default =~ /"summary":"(.*?)"/;
}
unless ( $prog->{guidance} ) {
my $guidance = $2 if $default =~ /"guidance":(null|"(.*?)")/;
$prog->{guidance} = "Yes" if $guidance;
}
unless ( $prog->{thumbnail} ) {
my $thumbnail = $1 if $default =~ /"holdingImageURL":"(.*?)"/;
$thumbnail =~ s/\\\//\//g;
my $thumbsize = $opt->{thumbsize} || $opt->{thumbsizecache} || 150;
my $recipe = Programme::bbciplayer->thumb_url_recipes->{ $thumbsize };
if ( ! $recipe ) {
main::logger "WARNING: Invalid thumbnail size: $thumbsize - using default (JSON)\n";
$recipe = Programme::bbciplayer->thumb_url_recipes->{ 150 };
}
$thumbnail =~ s/\$recipe/$recipe/;
$prog->{thumbnail} = $thumbnail if $thumbnail;
}
unless ( $prog->{title} ) {
my $title = $1 if $default =~ /"title":"(.*?)"/;
$title =~ s/\\\//\//g;
$prog->{title} = decode_entities($title) if $title;
}
unless ( $prog->{type} ) {
$prog->{type} = 'tv' if $default =~ /"kind":"video"/;
$prog->{type} = 'radio' if $default =~ /"kind":"audio"/;
}
my @versions = split /"markers"/, $versions;
pop @versions;
for ( @versions ) {
main::logger "DEBUG: Block (JSON): $_\n" if $opt->{debug};
my ($verpid, $version);
my $type = $1 if /"types":\["(.*?)"/;
if ( $type =~ /describe/i ) {
$version = "audiodescribed";
} elsif ($type =~ /sign/i ) {
$version = "signed";
} else {
$version = "default";
}
next if $prog->{verpids}->{$version};
$verpid = $1 if /{"vpid":"(\w+)","kind":"(programme|radioProgramme)"/i;
next if ! ($verpid && $version);
$prog->{verpids}->{$version} = $verpid;
$prog->{durations}->{$version} = $1 if /"duration":(\d+)/;
}
$prog->{versions} = join ',', keys %{ $prog->{verpids} };
my $version_map = { "default" => "", "audiodescribed" => "ad", "signed" => "sign"};
my $version_list = $opt->{versionlist} || 'default';
for ( split /,/, $version_list ) {
if ( $prog->{verpids}->{$_} ) {
my $episode_url;
if ( $prog->{type} eq 'tv' ) {
$episode_url = 'http://www.bbc.co.uk/iplayer/episode/'.$pid."/$version_map->{$_}";
} elsif ( $prog->{type} eq 'radio' ) {
$episode_url = 'http://www.bbc.co.uk/programmes/'.$pid;
}
unless ( $prog->{player} ) {
$prog->{player} = $episode_url if $episode_url;
last;
}
}
}
my $found;
for ( keys %{ $prog->{verpids} } ) {
$found = 1 if $version_list =~ /$_/ && $prog->{verpids}->{$_};
last if $found;
}
return 1 if ! $found;
return 0;
}
# Return hash of version => verpid given a pid
# Scrapes HTML from episode page: http://www.bbc.co.uk/iplayer/episode/
# Only works for TV programmes
sub get_verpids_html {
my ( $prog, $ua ) = @_;
my $pid;
if ( $prog->{pid} =~ /^http/i ) {
$pid = $1 if $prog->{pid} =~ /\/([bp]0[a-z0-9]{6})/
}
$pid ||= $prog->{pid};
if ( $prog->{pid} ne $pid ) {
main::logger "INFO: pid changed from $prog->{pid} to $pid (HTML)\n" if $opt->{verbose};
$prog->{pid} = $pid;
}
if ( $pid !~ /^[bp]0[a-z0-9]{6}$/ ) {
main::logger "INFO: skipping playlist for non-PID $pid (HTML)\n" if $opt->{verbose};
return;
}
my $version_list = $opt->{versionlist} || 'default';
my $version_map = { "default" => "", "audiodescribed" => "ad", "signed" => "sign"};
for my $version ( "default", "audiodescribed", "signed" ) {
next if $version_list !~ /$version/ || $prog->{verpids}->{$version};
my $url = 'http://www.bbc.co.uk/iplayer/episode/'.$pid."/$version_map->{$version}";
main::logger "INFO: iPlayer metadata URL (HTML) [$version] = $url\n" if $opt->{verbose};
my $html = main::request_url_retry( $ua, $url, 3 );
if ( ! $html ) {
main::logger "\rERROR: Failed to get version pid metadata from iplayer site (HTML)\n\n";
return 1;
}
my $config = $1 if $html =~ /require\(\{\s*config:(.*?)\<\/script\>/s;
main::logger "DEBUG: Block (HTML): $config\n" if $opt->{debug};
my $verpid = $1 if $config =~ /"vpid":"(.*?)"/;
if ( ! $verpid ) {
main::logger "INFO: $version version not found in metadata retrieved from iplayer site (HTML)\n" if $opt->{verbose};
next;
}
unless ( $prog->{channel} ) {
$prog->{channel} = $1 if $config =~ /"masterBrandTitle":"(.*?)"/;
}
unless ( $prog->{descshort} ) {
$prog->{descshort} = $1 if $config =~ /"summary":"(.*?)"/;
}
unless ( $prog->{guidance} ) {
my $guidance = $2 if $config =~ /"guidance":(null|"(.*?)")/;
$prog->{guidance} = "Yes" if $guidance;
}
unless ( $prog->{thumbnail} ) {
my $thumbnail = $1 if $config =~ /"image":"(.*?)"/;
$thumbnail =~ s/\\\//\//g;
my $thumbsize = $opt->{thumbsize} || $opt->{thumbsizecache} || 150;
my $recipe = Programme::bbciplayer->thumb_url_recipes->{ $thumbsize };
if ( ! $recipe ) {
main::logger "WARNING: Invalid thumbnail size: $thumbsize - using default (HTML)\n";
$recipe = Programme::bbciplayer->thumb_url_recipes->{ 150 };
}
$thumbnail =~ s/{recipe}/$recipe/;
$prog->{thumbnail} = $thumbnail if $thumbnail;
}
unless ( $prog->{title} ) {
my $title = $1 if $config =~ /"title":"(.*?)"/;
$title =~ s/\\\//\//g;
my $subtitle = $1 if $config =~ /"subtitle":"(.*?)"/;
$subtitle =~ s/\\\//\//g;
$title .= ": $subtitle" if $subtitle;
$prog->{title} = decode_entities($title) if $title;
}
unless ( $prog->{type} ) {
$prog->{type} = "tv";
}
$prog->{verpids}->{$version} = $verpid;
$prog->{durations}->{$version} = $1 if $config =~ /"duration":(\d+)/;
}
$prog->{versions} = join ',', keys %{ $prog->{verpids} };
for ( split /,/, $version_list ) {
if ( $prog->{verpids}->{$_} ) {
my $episode_url;
if ( $prog->{type} eq 'tv' ) {
$episode_url = 'http://www.bbc.co.uk/iplayer/episode/'.$pid."/$version_map->{$_}";
} elsif ( $prog->{type} eq 'radio' ) {
$episode_url = 'http://www.bbc.co.uk/programmes/'.$pid;
}
unless ( $prog->{player} ) {
$prog->{player} = $episode_url if $episode_url;
last;
}
}
}
my $found;
for ( keys %{ $prog->{verpids} } ) {
$found = 1 if $version_list =~ /$_/ && $prog->{verpids}->{$_};
last if $found;
}
return 1 if ! $found;
return 0;
}
# get full episode metadata given pid and ua. Uses two different urls to get data
sub get_metadata {
my $prog = shift;
my $ua = shift;
my $prog_data_url = 'http://www.bbc.co.uk/programmes/'; # $pid
my @ignore_categories = ("Films", "Sign Zone", "Audio Described", "Northern Ireland", "Scotland", "Wales", "England");
my ($title, $name, $brand, $series, $episode, $longname, $available, $channel, $expiry, $meddesc, $longdesc, $summary, $versions, $guidance, $prog_type, $categories, $category, $web, $player, $thumbnail, $seriesnum, $episodenum, $episodepart );
# This URL works for tv/radio prog types:
# http://www.bbc.co.uk/programmes/{pid}.xml
# This URL works for tv/radio prog types (has long synopsis and categories):
# http://www.bbc.co.uk/programmes/{pid}.rdf
# Works for all Verison PIDs to get the last/first broadcast dates
# http://www.bbc.co.uk/programmes/.rdf
main::logger "DEBUG: Getting Metadata for $prog->{pid}:\n" if $opt->{debug};
my $got_metadata;
eval "use XML::Simple";
if ( $@ ) {
main::logger "WARNING: Please download and run latest installer or install the XML::Simple Perl module for more accurate programme metadata.\n";
} elsif ( $prog->{pid} =~ /^[bp]0[a-z0-9]{6}$/ && ! $opt->{playlistmetadata} ) {
my $url = $prog_data_url.$prog->{pid}.".xml";
main::logger "INFO: Programme metadata URL = $url\n" if $opt->{verbose};
my $xml = main::request_url_retry($ua, $url, 3, '', '');
if ( $xml ) {
my $doc = eval { XMLin($xml, KeyAttr => [], ForceArray => 1, SuppressEmpty => 1) };
if ( ! $@ ) {
if ( $doc->{type} eq "episode" || $doc->{type} eq "clip" ) {
my $parent = $doc->{parent}->[0]->{programme}->[0];
my $grandparent = $parent->{parent}->[0]->{programme}->[0];
my $greatgrandparent = $grandparent->{parent}->[0]->{programme}->[0];
my $pid = $doc->{pid}->[0];
my $parentpid = $parent->{pid}->[0];
$prog_type = $doc->{media_type}->[0];
$prog_type = 'tv' if $prog_type =~ m{video}s;
$prog_type = 'radio' if $prog_type eq 'audio';
$longdesc = $doc->{long_synopsis}->[0];
$meddesc = $doc->{medium_synopsis}->[0];
$summary = $doc->{short_synopsis}->[0];
$channel = $doc->{ownership}->[0]->{service}->[0]->{title}->[0];
my $image_pid = $doc->{image}->[0]->{pid}->[0];
my $thumbsize = $opt->{thumbsize} || $opt->{thumbsizecache} || 150;
my $recipe = Programme::bbciplayer->thumb_url_recipes->{ $thumbsize };
$recipe = Programme::bbciplayer->thumb_url_recipes->{ 150 } if ! $recipe;
$thumbnail = "http://ichef.bbci.co.uk/images/ic/${recipe}/${image_pid}.jpg";
$web = "http://www.bbc.co.uk/programmes/$parentpid" if $parentpid;
if ( $prog_type eq "tv" && $doc->{type} eq "episode" ) {
$player = "http://www.bbc.co.uk/iplayer/episode/$pid";
} else {
$player = "http://www.bbc.co.uk/programmes/$pid";
}
# title strings
my ($series_position, $subseries_position);
$episode = $doc->{title}->[0];
for my $ancestor ($parent, $grandparent, $greatgrandparent) {
if ( $ancestor->{type} && $ancestor->{title}->[0] ) {
if ( $ancestor->{type} eq "brand" ) {
$brand = $ancestor->{title}->[0];
} elsif ( $ancestor->{type} eq "series" ) {
# handle rare subseries
if ( $series ) {
$episode = "$series $episode";
$subseries_position = $series_position;
}
$series = $ancestor->{title}->[0];
$series_position = $ancestor->{position}->[0];
}
}
}
if ( $brand ) {
if ( $series && $series ne $brand ) {
$name = "$brand: $series";
} else {
$name = $brand;
}
} else {
$name = $series;
}
unless ( $name ) {
$name = $brand = $episode;
$episode = "-";
$title = $name;
} else {
$title = "$name: $episode";
}
# categories
my (@cats1, @cats2, @cats3);
for my $cat1 ( @{$doc->{categories}->[0]->{category}} ) {
unshift @cats1, $cat1->{title}->[0];
for my $cat2 ( @{$cat1->{broader}->[0]->{category}} ) {
unshift @cats2, $cat2->{title}->[0];
for my $cat3 ( @{$cat2->{broader}->[0]->{category}} ) {
unshift @cats3, $cat3->{title}->[0];
}
}
}
my %seen;
my @categories = grep { ! $seen{$_}++ } ( @cats3, @cats2, @cats1 );
$categories = join(',', @categories);
foreach my $cat ( @categories ) {
if ( ! grep(/$cat/i, @ignore_categories) ) {
$category = $cat;
last;
}
}
$categories ||= "get_iplayer";
$category ||= $categories[0] || "get_iplayer";
# series/episode numbers
if ( $subseries_position ) {
my @parts = ("a".."z");
$episodepart = $parts[$doc->{position}->[0] - 1];
}
$episodenum = $subseries_position || $doc->{position}->[0];
$seriesnum = $series_position || $parent->{position}->[0];
# the Doctor Who fudge
my ($seriesnum2, $episodenum2);
# Extract the seriesnum
my $regex = 'Series\s+'.main::regex_numbers();
if ( "$name $episode" =~ m{$regex}i ) {
$seriesnum2 = main::convert_words_to_number( $1 );
}
# Extract the episode num
my $regex_1 = 'Episode\s+'.main::regex_numbers();
my $regex_2 = '^'.main::regex_numbers().'\.\s+';
if ( "$name $episode" =~ m{$regex_1}i ) {
$episodenum2 = main::convert_words_to_number( $1 );
} elsif ( $episode =~ m{$regex_2}i ) {
$episodenum2 = main::convert_words_to_number( $1 );
}
# override series/episode numbers if mismatch
$seriesnum = $seriesnum2 if $seriesnum2;
$episodenum = $episodenum2 if $episodenum2;
# insert episode number in $episode
$episode = Programme::bbciplayer::insert_episode_number($episode, $episodenum, $episodepart);
# minimum episode number = 1 if not a film and series number == 0
$episodenum = 1 if ( $seriesnum == 0 && $episodenum == 0 && $prog_type eq 'tv' && $categories !~ "Films" );
# minimum series number = 1 if episode number != 0
$seriesnum = 1 if ( $seriesnum == 0 && $episodenum != 0 );
# programme versions
my %found;
for my $ver ( @{$doc->{versions}->[0]->{version}} ) {
my $type;
# check for audiodescribed and signed first
if ( grep /describe/i, @{$ver->{types}->[0]->{type}} ) {
$type = "audiodescribed";
} elsif ( grep /sign/i, @{$ver->{types}->[0]->{type}} ) {
$type = "signed";
} else {
($type = lc($ver->{types}->[0]->{type}->[0])) =~ s/\s+.*$//;
}
if ( $type ) {
my $version = $type;
$version .= $found{$type} if ++$found{$type} > 1;
$prog->{verpids}->{$version} = $ver->{pid}->[0];
$prog->{durations}->{$version} = $ver->{duration}->[0];
}
}
$got_metadata = 1;
} else {
main::logger "WARNING: PID $prog->{pid} does not refer to an iPlayer programme episode. Download may fail and metadata may be inaccurate.\n";
}
} else {
main::logger "WARNING: Could not parse programme metadata from $url\n";
}
} else {
main::logger "WARNING: Could not download programme metadata from $url\n";
}
}
# Get list of available modes for each version available
# populate version pid metadata if we don't have it already
if ( keys %{ $prog->{verpids} } == 0 ) {
if ( $prog->get_verpids( $ua ) ) {
main::logger "ERROR: Could not get version pid metadata\n" if $opt->{verbose};
# Return at this stage unless we want metadata/tags only for various reasons
return 1 if ! ( $opt->{info} || $opt->{metadataonly} || $opt->{thumbonly} || $opt->{tagonly} )
}
}
# use fallback metadata if necessary
unless ( $got_metadata ) {
$prog->get_metadata_fallback( $ua );
}
my $modes;
my $mode_sizes;
my $first_broadcast;
my $last_broadcast;
# Do this for each version tried in this order (if they appeared in the content)
for my $version ( sort keys %{ $prog->{verpids} } ) {
# Try to get stream data for this version if it isn't already populated
if ( not defined $prog->{streams}->{$version} ) {
# Add streamdata to object
$prog->{streams}->{$version} = get_stream_data($prog, $prog->{verpids}->{$version} );
}
if ( keys %{ $prog->{streams}->{$version} } == 0 ) {
main::logger "INFO: No streams available for '$version' version ($prog->{verpids}->{$version}) - skipping RDF\n" if $opt->{verbose};
next;
}
$modes->{$version} = join ',', sort keys %{ $prog->{streams}->{$version} };
# Estimate the file sizes for each mode
my @sizes;
for my $mode ( sort keys %{ $prog->{streams}->{$version} } ) {
# get expiry from stream data
if ( ! $expiry && $prog->{streams}->{$version}->{$mode}->{expires} ) {
$expiry = $prog->{streams}->{$version}->{$mode}->{expires};
$prog->{expiryrel} = Programme::get_time_string( $expiry, time() );
}
my $size;
if ( $prog->{streams}->{$version}->{$mode}->{size} ) {
$size = $prog->{streams}->{$version}->{$mode}->{size};
} else {
next if ( ! $prog->{durations}->{$version} ) || (! $prog->{streams}->{$version}->{$mode}->{bitrate} );
$size = $prog->{streams}->{$version}->{$mode}->{bitrate} * $prog->{durations}->{$version} / 8.0 * 1024.0;
}
if ( $size < 1048576 ) {
push @sizes, sprintf( "%s=%.0fKB", $mode, $size / 1024.0 );
} else {
push @sizes, sprintf( "%s=%.0fMB", $mode, $size / 1048576.0 );
}
}
$mode_sizes->{$version} = join ',', @sizes;
# Set duration for this version if it is not defined
$prog->{durations}->{$version} = $prog->{duration} if $prog->{duration} =~ /\d+/ && ! $prog->{durations}->{$version};
next unless $prog->{verpids}->{$version} =~ /^[bp]0[a-z0-9]{6}$/;
# get the last/first broadcast dates from the RDF for this verpid
# rdf url: http://www.bbc.co.uk/programmes/.rdf
# Date in this format 'CCYY-MM-DDTHH:MM:SS+01:00'
# Don't get this feed if the verpid starts with '?'
my $rdf_url = 'http://www.bbc.co.uk/programmes/'.$prog->{verpids}->{$version}.'.rdf';
my $rdf;
$rdf = main::request_url_retry($ua, $rdf_url, 3, '', '') if $prog->{verpids}->{$version} !~ m{^\?};
decode_entities($rdf);
main::logger "DEBUG: $rdf_url:\n$rdf\n\n" if $opt->{debug};
# Flatten
$rdf =~ s|\n| |g;
# Get min/max bcast dates from rdf
my ( $now, $first, $last, $first_string, $last_string ) = ( time(), 9999999999, 0, 'Never', 'Never' );
#
# 2009-06-06
#
#
#