9 from datetime
import datetime
10 from xml
.dom
import minidom
11 from xml
.parsers
import expat
18 from lrucache
import LRUCache
21 import plugins
.video
.transcode
25 TRIBUNE_CR
= ' Copyright Tribune Media Services, Inc.'
27 TV_RATINGS
= {'TV-Y7': 1, 'TV-Y': 2, 'TV-G': 3, 'TV-PG': 4, 'TV-14': 5,
28 'TV-MA': 6, 'TV-NR': 7, 'TVY7': 1, 'TVY': 2, 'TVG': 3,
29 'TVPG': 4, 'TV14': 5, 'TVMA': 6, 'TVNR': 7, 'Y7': 1,
30 'Y': 2, 'G': 3, 'PG': 4, '14': 5, 'MA': 6, 'NR': 7,
31 'UNRATED': 7, 'X1': 1, 'X2': 2, 'X3': 3, 'X4': 4, 'X5': 5,
34 MPAA_RATINGS
= {'G': 1, 'PG': 2, 'PG-13': 3, 'PG13': 3, 'R': 4, 'X': 5,
35 'NC-17': 6, 'NC17': 6, 'NR': 8, 'UNRATED': 8, 'G1': 1,
36 'P2': 2, 'P3': 3, 'R4': 4, 'X5': 5, 'N6': 6, 'N8': 8}
38 STAR_RATINGS
= {'1': 1, '1.5': 2, '2': 3, '2.5': 4, '3': 5, '3.5': 6,
39 '4': 7, '*': 1, '**': 3, '***': 5, '****': 7, 'X1': 1,
40 'X2': 2, 'X3': 3, 'X4': 4, 'X5': 5, 'X6': 6, 'X7': 7}
42 HUMAN
= {'mpaaRating': {1: 'G', 2: 'PG', 3: 'PG-13', 4: 'R', 5: 'X',
44 'tvRating': {1: 'Y7', 2: 'Y', 3: 'G', 4: 'PG', 5: '14',
46 'starRating': {1: '1', 2: '1.5', 3: '2', 4: '2.5', 5: '3',
49 COLOR_CODES
= {'1': ["B & W", 1],
50 '2': ["COLOR AND B & W", 2],
51 '3': ["COLORIZED", 3],
60 tivo_cache
= LRUCache(50)
61 mp4_cache
= LRUCache(50)
62 dvrms_cache
= LRUCache(50)
63 nfo_cache
= LRUCache(50)
65 mswindows
= (sys
.platform
== "win32")
68 return HUMAN
['mpaaRating'].get(rating
, 'NR')
71 return HUMAN
['tvRating'].get(rating
, 'NR')
73 def get_stars(rating
):
74 return HUMAN
['starRating'].get(rating
, '')
79 tsize
= '%.2f GB' % (raw
/ GB
)
81 tsize
= '%.2f MB' % (raw
/ MB
)
83 tsize
= '%.2f KB' % (raw
/ KB
)
85 tsize
= '%d Bytes' % raw
88 def tag_data(element
, tag
):
89 for name
in tag
.split('/'):
91 for new_element
in element
.childNodes
:
92 if new_element
.nodeName
== name
:
98 if not element
.firstChild
:
100 return element
.firstChild
.data
102 def _vtag_data(element
, tag
):
103 for name
in tag
.split('/'):
104 new_element
= element
.getElementsByTagName(name
)
107 element
= new_element
[0]
108 elements
= element
.getElementsByTagName('element')
109 return [x
.firstChild
.data
for x
in elements
if x
.firstChild
]
111 def _vtag_data_alternate(element
, tag
):
113 for name
in tag
.split('/'):
115 for elmt
in elements
:
116 new_elements
+= elmt
.getElementsByTagName(name
)
117 elements
= new_elements
118 return [x
.firstChild
.data
for x
in elements
if x
.firstChild
]
120 def _tag_value(element
, tag
):
121 item
= element
.getElementsByTagName(tag
)
123 value
= item
[0].attributes
['value'].value
126 def from_moov(full_path
):
127 if full_path
in mp4_cache
:
128 return mp4_cache
[full_path
]
134 mp4meta
= mutagen
.File(unicode(full_path
, 'utf-8'))
137 mp4_cache
[full_path
] = {}
140 # The following 1-to-1 correspondence of atoms to pyTivo
141 # variables is TV-biased
142 keys
= {'tvnn': 'callsign',
143 'tvsh': 'seriesTitle'}
145 if 'stik' in mp4meta
:
146 isTVShow
= (mp4meta
['stik'] == mutagen
.mp4
.MediaKind
.TV_SHOW
)
148 isTVShow
= 'tvsh' in mp4meta
149 for key
, value
in mp4meta
.items():
150 if type(value
) == list:
153 metadata
[keys
[key
]] = value
155 #could be programId (EP, SH, or MV) or "SnEn"
156 if value
.startswith('SH'):
157 metadata
['isEpisode'] = 'false'
158 elif value
.startswith('MV') or value
.startswith('EP'):
159 metadata
['isEpisode'] = 'true'
160 metadata
['programId'] = value
161 elif key
.startswith('S') and key
.count('E') == 1:
162 epstart
= key
.find('E')
163 seasonstr
= key
[1:epstart
]
164 episodestr
= key
[epstart
+1:]
165 if (seasonstr
.isdigit() and episodestr
.isdigit()):
166 if len(episodestr
) < 2:
167 episodestr
= '0' + episodestr
168 metadata
['episodeNumber'] = seasonstr
+episodestr
170 #put together tvsn and tves to make episodeNumber
173 if 'tves' in mp4meta
:
174 tvesValue
= mp4meta
['tves']
175 if type(tvesValue
) == list:
176 tvesValue
= tvesValue
[0]
177 tves
= str(tvesValue
)
180 metadata
['episodeNumber'] = tvsn
+tves
181 # These keys begin with the copyright symbol \xA9
182 elif key
== '\xa9day':
185 value
+= '-01-01T16:00:00Z'
186 metadata
['originalAirDate'] = value
189 metadata
['movieYear'] = value
[:4]
190 #metadata['time'] = value
191 elif key
in ['\xa9gen', 'gnre']:
192 for k
in ('vProgramGenre', 'vSeriesGenre'):
194 metadata
[k
].append(value
)
196 metadata
[k
] = [value
]
197 elif key
== '\xa9nam':
199 metadata
['episodeTitle'] = value
201 metadata
['title'] = value
203 # Description in desc, cmt, and/or ldes tags. Keep the longest.
204 elif key
in ['desc', '\xa9cmt', 'ldes'] and len(value
) > len_desc
:
205 metadata
['description'] = value
206 len_desc
= len(value
)
208 # A common custom "reverse DNS format" tag
209 elif (key
== '----:com.apple.iTunes:iTunEXTC' and
210 ('us-tv' in value
or 'mpaa' in value
)):
211 rating
= value
.split("|")[1].upper()
212 if rating
in TV_RATINGS
and 'us-tv' in value
:
213 metadata
['tvRating'] = TV_RATINGS
[rating
]
214 elif rating
in MPAA_RATINGS
and 'mpaa' in value
:
215 metadata
['mpaaRating'] = MPAA_RATINGS
[rating
]
217 # Actors, directors, producers, AND screenwriters may be in a long
218 # embedded XML plist.
219 elif (key
== '----:com.apple.iTunes:iTunMOVI' and
220 'plistlib' in sys
.modules
):
221 items
= {'cast': 'vActor', 'directors': 'vDirector',
222 'producers': 'vProducer', 'screenwriters': 'vWriter'}
224 data
= plistlib
.readPlistFromString(value
)
230 metadata
[items
[item
]] = [x
['name'] for x
in data
[item
]]
232 mp4_cache
[full_path
] = metadata
235 def from_mscore(rawmeta
):
237 keys
= {'title': ['Title'],
238 'description': ['Description', 'WM/SubTitleDescription'],
239 'episodeTitle': ['WM/SubTitle'],
240 'callsign': ['WM/MediaStationCallSign'],
241 'displayMajorNumber': ['WM/MediaOriginalChannel'],
242 'originalAirDate': ['WM/MediaOriginalBroadcastDateTime'],
243 'rating': ['WM/ParentalRating'],
244 'credits': ['WM/MediaCredits'], 'genre': ['WM/Genre']}
247 for tag
in keys
[tagname
]:
250 value
= rawmeta
[tag
][0]
251 if type(value
) not in (str, unicode):
254 metadata
[tagname
] = value
258 if 'episodeTitle' in metadata
and 'title' in metadata
:
259 metadata
['seriesTitle'] = metadata
['title']
260 if 'genre' in metadata
:
261 value
= metadata
['genre'].split(',')
262 metadata
['vProgramGenre'] = value
263 metadata
['vSeriesGenre'] = value
264 del metadata
['genre']
265 if 'credits' in metadata
:
266 value
= [x
.split('/') for x
in metadata
['credits'].split(';')]
268 metadata
['vActor'] = [x
for x
in (value
[0] + value
[3]) if x
]
269 metadata
['vDirector'] = [x
for x
in value
[1] if x
]
270 del metadata
['credits']
271 if 'rating' in metadata
:
272 rating
= metadata
['rating']
273 if rating
in TV_RATINGS
:
274 metadata
['tvRating'] = TV_RATINGS
[rating
]
275 del metadata
['rating']
279 def from_dvrms(full_path
):
280 if full_path
in dvrms_cache
:
281 return dvrms_cache
[full_path
]
284 rawmeta
= mutagen
.File(unicode(full_path
, 'utf-8'))
287 dvrms_cache
[full_path
] = {}
290 metadata
= from_mscore(rawmeta
)
291 dvrms_cache
[full_path
] = metadata
294 def from_eyetv(full_path
):
295 keys
= {'TITLE': 'title', 'SUBTITLE': 'episodeTitle',
296 'DESCRIPTION': 'description', 'YEAR': 'movieYear',
297 'EPISODENUM': 'episodeNumber'}
299 path
= os
.path
.dirname(unicode(full_path
, 'utf-8'))
300 eyetvp
= [x
for x
in os
.listdir(path
) if x
.endswith('.eyetvp')][0]
301 eyetvp
= os
.path
.join(path
, eyetvp
)
303 eyetv
= plistlib
.readPlist(eyetvp
)
306 if 'epg info' in eyetv
:
307 info
= eyetv
['epg info']
310 metadata
[keys
[key
]] = info
[key
]
312 metadata
['seriesTitle'] = info
['TITLE']
314 metadata
['vActor'] = [x
.strip() for x
in info
['ACTORS'].split(',')]
316 metadata
['vDirector'] = [info
['DIRECTOR']]
318 for ptag
, etag
, ratings
in [('tvRating', 'TV_RATING', TV_RATINGS
),
319 ('mpaaRating', 'MPAA_RATING', MPAA_RATINGS
),
320 ('starRating', 'STAR_RATING', STAR_RATINGS
)]:
321 x
= info
[etag
].upper()
322 if x
and x
in ratings
:
323 metadata
[ptag
] = ratings
[x
]
325 # movieYear must be set for the mpaa/star ratings to work
326 if (('mpaaRating' in metadata
or 'starRating' in metadata
) and
327 'movieYear' not in metadata
):
328 metadata
['movieYear'] = eyetv
['info']['start'].year
331 def from_text(full_path
):
333 full_path
= unicode(full_path
, 'utf-8')
334 path
, name
= os
.path
.split(full_path
)
335 title
, ext
= os
.path
.splitext(name
)
340 parent
= os
.path
.dirname(ptmp
)
345 search_paths
.append(os
.path
.join(ptmp
, 'default.txt'))
347 search_paths
.append(os
.path
.join(path
, title
) + '.properties')
348 search_paths
.reverse()
350 search_paths
+= [full_path
+ '.txt',
351 os
.path
.join(path
, '.meta', 'default.txt'),
352 os
.path
.join(path
, '.meta', name
) + '.txt']
354 for metafile
in search_paths
:
355 if os
.path
.exists(metafile
):
356 sep
= ':='[metafile
.endswith('.properties')]
357 for line
in file(metafile
, 'U'):
358 if line
.startswith(BOM
):
360 if line
.strip().startswith('#') or not sep
in line
:
362 key
, value
= [x
.strip() for x
in line
.split(sep
, 1)]
363 if not key
or not value
:
365 if key
.startswith('v'):
367 metadata
[key
].append(value
)
369 metadata
[key
] = [value
]
371 metadata
[key
] = value
373 for rating
, ratings
in [('tvRating', TV_RATINGS
),
374 ('mpaaRating', MPAA_RATINGS
),
375 ('starRating', STAR_RATINGS
),
376 ('colorCode', COLOR_CODES
)]:
377 x
= metadata
.get(rating
, '').upper()
379 metadata
[rating
] = ratings
[x
]
389 def basic(full_path
, mtime
=None):
390 base_path
, name
= os
.path
.split(full_path
)
391 title
, ext
= os
.path
.splitext(name
)
393 mtime
= os
.path
.getmtime(unicode(full_path
, 'utf-8'))
395 originalAirDate
= datetime
.utcfromtimestamp(mtime
)
397 originalAirDate
= datetime
.utcnow()
399 metadata
= {'title': title
,
400 'originalAirDate': originalAirDate
.isoformat()}
402 if ext
in ['.mp4', '.m4v', '.mov']:
403 metadata
.update(from_moov(full_path
))
404 elif ext
in ['.dvr-ms', '.asf', '.wmv']:
405 metadata
.update(from_dvrms(full_path
))
406 elif 'plistlib' in sys
.modules
and base_path
.endswith('.eyetv'):
407 metadata
.update(from_eyetv(full_path
))
408 metadata
.update(from_nfo(full_path
))
409 metadata
.update(from_text(full_path
))
413 def from_container(xmldoc
):
416 keys
= {'title': 'Title', 'episodeTitle': 'EpisodeTitle',
417 'description': 'Description', 'programId': 'ProgramId',
418 'seriesId': 'SeriesId', 'episodeNumber': 'EpisodeNumber',
419 'tvRating': 'TvRating', 'displayMajorNumber': 'SourceChannel',
420 'callsign': 'SourceStation', 'showingBits': 'ShowingBits',
421 'mpaaRating': 'MpaaRating'}
423 details
= xmldoc
.getElementsByTagName('Details')[0]
426 data
= tag_data(details
, keys
[key
])
428 if key
== 'description':
429 data
= data
.replace(TRIBUNE_CR
, '')
430 elif key
== 'tvRating':
432 elif key
== 'displayMajorNumber':
434 data
, metadata
['displayMinorNumber'] = data
.split('-')
439 def from_details(xml
):
442 xmldoc
= minidom
.parseString(xml
)
443 showing
= xmldoc
.getElementsByTagName('showing')[0]
444 program
= showing
.getElementsByTagName('program')[0]
446 items
= {'description': 'program/description',
447 'title': 'program/title',
448 'episodeTitle': 'program/episodeTitle',
449 'episodeNumber': 'program/episodeNumber',
450 'programId': 'program/uniqueId',
451 'seriesId': 'program/series/uniqueId',
452 'seriesTitle': 'program/series/seriesTitle',
453 'originalAirDate': 'program/originalAirDate',
454 'isEpisode': 'program/isEpisode',
455 'movieYear': 'program/movieYear',
456 'partCount': 'partCount',
457 'partIndex': 'partIndex',
461 data
= tag_data(showing
, items
[item
])
463 if item
== 'description':
464 data
= data
.replace(TRIBUNE_CR
, '')
465 metadata
[item
] = data
467 vItems
= ['vActor', 'vChoreographer', 'vDirector',
468 'vExecProducer', 'vProgramGenre', 'vGuestStar',
469 'vHost', 'vProducer', 'vWriter']
472 data
= _vtag_data(program
, item
)
474 metadata
[item
] = data
476 sb
= showing
.getElementsByTagName('showingBits')
478 metadata
['showingBits'] = sb
[0].attributes
['value'].value
480 #for tag in ['starRating', 'mpaaRating', 'colorCode']:
481 for tag
in ['starRating', 'mpaaRating']:
482 value
= _tag_value(program
, tag
)
484 metadata
[tag
] = value
486 rating
= _tag_value(showing
, 'tvRating')
488 metadata
['tvRating'] = rating
492 def _nfo_vitems(source
, metadata
):
494 vItems
= {'vGenre': 'genre',
495 'vWriter': 'credits',
496 'vDirector': 'director',
497 'vActor': 'actor/name'}
500 data
= _vtag_data_alternate(source
, vItems
[key
])
502 metadata
.setdefault(key
, [])
504 if not dat
in metadata
[key
]:
505 metadata
[key
].append(dat
)
507 if 'vGenre' in metadata
:
508 metadata
['vSeriesGenre'] = metadata
['vProgramGenre'] = metadata
['vGenre']
512 def _parse_nfo(nfo_path
, nfo_data
=None):
513 # nfo files can contain XML or a URL to seed the XBMC metadata scrapers
514 # It's also possible to have both (a URL after the XML metadata)
515 # pyTivo only parses the XML metadata, but we'll try to stip the URL
516 # from mixed XML/URL files. Returns `None` when XML can't be parsed.
518 nfo_data
= [line
.strip() for line
in file(nfo_path
, 'rU')]
521 xmldoc
= minidom
.parseString(os
.linesep
.join(nfo_data
))
522 except expat
.ExpatError
, err
:
523 if expat
.ErrorString(err
.code
) == expat
.errors
.XML_ERROR_INVALID_TOKEN
:
524 # might be a URL outside the xml
525 while len(nfo_data
) > err
.lineno
:
526 if len(nfo_data
[-1]) == 0:
530 if len(nfo_data
) == err
.lineno
:
531 # last non-blank line contains the error
533 return _parse_nfo(nfo_path
, nfo_data
)
536 def _from_tvshow_nfo(tvshow_nfo_path
):
537 if tvshow_nfo_path
in nfo_cache
:
538 return nfo_cache
[tvshow_nfo_path
]
540 items
= {'description': 'plot',
542 'seriesTitle': 'showtitle',
543 'starRating': 'rating',
546 nfo_cache
[tvshow_nfo_path
] = metadata
= {}
548 xmldoc
= _parse_nfo(tvshow_nfo_path
)
552 tvshow
= xmldoc
.getElementsByTagName('tvshow')
559 data
= tag_data(tvshow
, items
[item
])
561 metadata
[item
] = data
563 metadata
= _nfo_vitems(tvshow
, metadata
)
565 nfo_cache
[tvshow_nfo_path
] = metadata
568 def _from_episode_nfo(nfo_path
, xmldoc
):
571 items
= {'description': 'plot',
572 'episodeTitle': 'title',
573 'seriesTitle': 'showtitle',
574 'originalAirDate': 'aired',
575 'starRating': 'rating',
581 basepath
= os
.path
.dirname(path
)
585 tv_nfo
= os
.path
.join(path
, 'tvshow.nfo')
586 if os
.path
.exists(tv_nfo
):
587 metadata
.update(_from_tvshow_nfo(tv_nfo
))
590 episode
= xmldoc
.getElementsByTagName('episodedetails')
596 metadata
['isEpisode'] = 'true'
598 data
= tag_data(episode
, items
[item
])
600 metadata
[item
] = data
602 season
= tag_data(episode
, 'displayseason')
603 if not season
or season
== "-1":
604 season
= tag_data(episode
, 'season')
608 ep_num
= tag_data(episode
, 'displayepisode')
609 if not ep_num
or ep_num
== "-1":
610 ep_num
= tag_data(episode
, 'episode')
611 if ep_num
and ep_num
!= "-1":
612 metadata
['episodeNumber'] = "%d%02d" % (int(season
), int(ep_num
))
614 if 'originalAirDate' in metadata
:
615 metadata
['originalAirDate'] += 'T00:00:00Z'
617 metadata
= _nfo_vitems(episode
, metadata
)
621 def _from_movie_nfo(xmldoc
):
624 movie
= xmldoc
.getElementsByTagName('movie')
630 items
= {'description': 'plot',
633 'starRating': 'rating',
634 'mpaaRating': 'mpaa'}
636 metadata
['isEpisode'] = 'false'
639 data
= tag_data(movie
, items
[item
])
641 metadata
[item
] = data
643 metadata
['movieYear'] = "%04d" % int(metadata
.get('movieYear', 0))
645 metadata
= _nfo_vitems(movie
, metadata
)
648 def from_nfo(full_path
):
649 if full_path
in nfo_cache
:
650 return nfo_cache
[full_path
]
652 metadata
= nfo_cache
[full_path
] = {}
654 nfo_path
= "%s.nfo" % os
.path
.splitext(full_path
)[0]
655 if not os
.path
.exists(nfo_path
):
658 xmldoc
= _parse_nfo(nfo_path
)
662 if xmldoc
.getElementsByTagName('episodedetails'):
664 metadata
.update(_from_episode_nfo(nfo_path
, xmldoc
))
665 elif xmldoc
.getElementsByTagName('movie'):
667 metadata
.update(_from_movie_nfo(xmldoc
))
670 if 'starRating' in metadata
:
671 # .NFO 0-10 -> TiVo 1-7
672 rating
= int(float(metadata
['starRating']) * 6 / 10 + 1.5)
673 metadata
['starRating'] = rating
675 for key
, mapping
in [('mpaaRating', MPAA_RATINGS
),
676 ('tvRating', TV_RATINGS
)]:
678 rating
= mapping
.get(metadata
[key
], None)
680 metadata
[key
] = rating
684 nfo_cache
[full_path
] = metadata
687 def _tdcat_bin(tdcat_path
, full_path
, tivo_mak
):
688 fname
= unicode(full_path
, 'utf-8')
690 fname
= fname
.encode('cp1252')
691 tcmd
= [tdcat_path
, '-m', tivo_mak
, '-2', fname
]
692 tdcat
= subprocess
.Popen(tcmd
, stdout
=subprocess
.PIPE
)
693 return tdcat
.stdout
.read()
695 def _tdcat_py(full_path
, tivo_mak
):
698 tfile
= open(full_path
, 'rb')
699 header
= tfile
.read(16)
700 offset
, chunks
= struct
.unpack('>LH', header
[10:])
701 rawdata
= tfile
.read(offset
- 16)
705 for i
in xrange(chunks
):
706 chunk_size
, data_size
, id, enc
= struct
.unpack('>LLHH',
707 rawdata
[count
:count
+ 12])
709 data
= rawdata
[count
:count
+ data_size
]
710 xml_data
[id] = {'enc': enc
, 'data': data
, 'start': count
+ 16}
711 count
+= chunk_size
- 12
714 details
= chunk
['data']
716 xml_key
= xml_data
[3]['data']
718 hexmak
= hashlib
.md5('tivo:TiVo DVR:' + tivo_mak
).hexdigest()
719 key
= hashlib
.sha1(hexmak
+ xml_key
).digest()[:16] + '\0\0\0\0'
721 turkey
= hashlib
.sha1(key
[:17]).digest()
722 turiv
= hashlib
.sha1(key
).digest()
724 details
= turing
.Turing(turkey
, turiv
).crypt(details
, chunk
['start'])
728 def from_tivo(full_path
):
729 if full_path
in tivo_cache
:
730 return tivo_cache
[full_path
]
732 tdcat_path
= config
.get_bin('tdcat')
733 tivo_mak
= config
.get_server('tivo_mak')
737 details
= _tdcat_bin(tdcat_path
, full_path
, tivo_mak
)
739 details
= _tdcat_py(full_path
, tivo_mak
)
740 metadata
= from_details(details
)
741 tivo_cache
[full_path
] = metadata
747 def force_utf8(text
):
748 if type(text
) == str:
750 text
= text
.decode('utf8')
752 if sys
.platform
== 'darwin':
753 text
= text
.decode('macroman')
755 text
= text
.decode('cp1252')
756 return text
.encode('utf-8')
758 def dump(output
, metadata
):
760 value
= metadata
[key
]
761 if type(value
) == list:
763 output
.write('%s : %s\n' % (key
, item
.encode('utf-8')))
765 if key
in HUMAN
and value
in HUMAN
[key
]:
766 output
.write('%s : %s\n' % (key
, HUMAN
[key
][value
]))
768 output
.write('%s : %s\n' % (key
, value
.encode('utf-8')))
770 if __name__
== '__main__':
771 if len(sys
.argv
) > 1:
774 logging
.basicConfig()
775 fname
= force_utf8(sys
.argv
[1])
776 ext
= os
.path
.splitext(fname
)[1].lower()
778 metadata
.update(from_tivo(fname
))
779 elif ext
in ['.mp4', '.m4v', '.mov']:
780 metadata
.update(from_moov(fname
))
781 elif ext
in ['.dvr-ms', '.asf', '.wmv']:
782 metadata
.update(from_dvrms(fname
))
784 vInfo
= plugins
.video
.transcode
.video_info(fname
)
785 metadata
.update(from_mscore(vInfo
['rawmeta']))
786 dump(sys
.stdout
, metadata
)