MythTV  master
cinemarv_api.py
Go to the documentation of this file.
1 # -*- coding: UTF-8 -*-
2 
3 # ----------------------
4 # Name: cinemarv_api - XPath and XSLT functions for the CinemaRV.com grabber
5 # Python Script
6 # Author: R.D. Vaughan
7 # Purpose: This python script is intended to perform a variety of utility functions
8 # for the conversion of data to the MNV standard RSS output format.
9 # See this link for the specifications:
10 # http://www.mythtv.org/wiki/MythNetvision_Grabber_Script_Format
11 #
12 # License:Creative Commons GNU GPL v2
13 # (http://creativecommons.org/licenses/GPL/2.0/)
14 #-------------------------------------
15 __title__ ="cinemarv_api - XPath and XSLT functions for the CinemaRV.com grabber"
16 __author__="R.D. Vaughan"
17 __purpose__='''
18 This python script is intended to perform a variety of utility functions
19 for the conversion of data to the MNV standard RSS output format.
20 See this link for the specifications:
21 http://www.mythtv.org/wiki/MythNetvision_Grabber_Script_Format
22 '''
23 
24 __version__="v0.1.0"
25 # 0.1.0 Initial development
26 
27 
28 # Specify the class names that have XPath extention functions
29 __xpathClassList__ = ['xpathFunctions', ]
30 
31 # Specify the XSLT extention class names. Each class is a stand lone extention function
32 #__xsltExtentionList__ = ['xsltExtExample', ]
33 __xsltExtentionList__ = []
34 
35 import os, sys, re, time, datetime, shutil, urllib.request, urllib.parse, urllib.error, string
36 from copy import deepcopy
37 import io
38 
39 class OutStreamEncoder(object):
40  """Wraps a stream with an encoder"""
41  def __init__(self, outstream, encoding=None):
42  self.out = outstream
43  if not encoding:
44  self.encoding = sys.getfilesystemencoding()
45  else:
46  self.encoding = encoding
47 
48  def write(self, obj):
49  """Wraps the output stream, encoding Unicode strings with the specified encoding"""
50  if isinstance(obj, str):
51  obj = obj.encode(self.encoding)
52  try:
53  self.out.buffer.write(obj)
54  except OSError:
55  pass
56 
57  def __getattr__(self, attr):
58  """Delegate everything but write to the stream"""
59  return getattr(self.out, attr)
60 
61 if isinstance(sys.stdout, io.TextIOWrapper):
62  sys.stdout = OutStreamEncoder(sys.stdout, 'utf8')
63  sys.stderr = OutStreamEncoder(sys.stderr, 'utf8')
64 
65 try:
66  from io import StringIO
67  from lxml import etree
68 except Exception as e:
69  sys.stderr.write('\n! Error - Importing the "lxml" and "StringIO" python libraries failed on error(%s)\n' % e)
70  sys.exit(1)
71 
72 # Check that the lxml library is current enough
73 # From the lxml documents it states: (http://codespeak.net/lxml/installation.html)
74 # "If you want to use XPath, do not use libxml2 2.6.27. We recommend libxml2 2.7.2 or later"
75 # Testing was performed with the Ubuntu 9.10 "python-lxml" version "2.1.5-1ubuntu2" repository package
76 version = ''
77 for digit in etree.LIBXML_VERSION:
78  version+=str(digit)+'.'
79 version = version[:-1]
80 if version < '2.7.2':
81  sys.stderr.write('''
82 ! Error - The installed version of the "lxml" python library "libxml" version is too old.
83  At least "libxml" version 2.7.2 must be installed. Your version is (%s).
84 ''' % version)
85  sys.exit(1)
86 
87 
88 class xpathFunctions(object):
89  """Functions specific extending XPath
90  """
91  def __init__(self):
92  self.functList = ['cinemarvLinkGeneration', 'cinemarvIsCustomHTML', 'cinemarvCheckIfDBItem', ]
93  self.TextTail = etree.XPath("string()")
94  self.persistence = {}
95  # end __init__()
96 
97 
102 
103  def cinemarvLinkGeneration(self, context, *args):
104  '''Generate a link for the CinemaRV.com site. A read of the item's web page is required to
105  extract the flash video id.
106  Call example: 'mnvXpath:cinemarvLinkGeneration(string(link))'
107  return the url link
108  '''
109  webURL = args[0]
110  # If this is for the download then just return what was found for the "link" element
111  if 'cinemarvLinkGeneration' in self.persistence:
112  if self.persistence['cinemarvLinkGeneration'] is not None:
113  returnValue = self.persistence['cinemarvLinkGeneration']
114  self.persistence['cinemarvLinkGeneration'] = None
115  return returnValue
116  else:
117  self.persistence['cinemarvLinkGenerationVideoID'] = etree.XPath('//object[@id="flashObj"]//param[@name="flashVars"]/@value', namespaces=common.namespaces)
118  self.persistence['cinemarvLinkGenerationParser'] = etree.HTMLParser()
119 
120  try:
121  webPageElement = etree.parse(webURL, self.persistence['cinemarvLinkGenerationParser'])
122  except Exception as errmsg:
123  sys.stderr.write('!Warning: The web page URL(%s) could not be read, error(%s)\n' % (webURL, errmsg))
124  return webURL
125  if webPageElement is None:
126  self.persistence['cinemarvLinkGeneration'] = webURL
127  return webURL
128 
129  tmpVideoID = self.persistence['cinemarvLinkGenerationVideoID'](webPageElement)
130  if not len(tmpVideoID):
131  self.persistence['cinemarvLinkGeneration'] = webURL
132  return webURL
133  index = tmpVideoID[0].find('&')
134  if index == -1:
135  self.persistence['cinemarvLinkGeneration'] = webURL
136  return webURL
137  videocode = tmpVideoID[0][:index].replace('videoId=', '')
138  self.persistence['cinemarvLinkGeneration'] = common.linkWebPage('dummycontext', 'cinemarv')+videocode
139  return self.persistence['cinemarvLinkGeneration']
140  # end cinemarvLinkGeneration()
141 
142  def cinemarvIsCustomHTML(self, context, *args):
143  '''Check if the link is for a custom HTML
144  Example call: mnvXpath:cinemarvIsCustomHTML(('dummy'))
145  return True if the link does not starts with "http://"
146  return False if the link starts with "http://"
147  '''
148  if self.persistence['cinemarvLinkGeneration'] is None:
149  return False
150 
151  if self.persistence['cinemarvLinkGeneration'].startswith('http://'):
152  return False
153  else:
154  return True
155  # end cinemarvIsCustomHTML()
156 
157  def cinemarvCheckIfDBItem(self, context, *arg):
158  '''Use a unique key value pairing to find out if the 'internetcontentarticles' table already
159  has a matching item. This is done to save accessing the Internet when not required.
160  Call example: 'mnvXpath:cinemarvCheckIfDBItem(.)'
161  return True if a match was found
162  return False if a match was not found
163  '''
164  return common.checkIfDBItem('dummy', {'feedtitle': 'Movie Trailers', 'title': arg[0].replace('Trailer', '').strip(), 'author': arg[1], 'description': arg[2]})
165  # end cinemarvCheckIfDBItem()
166 
167 
172 
173 
178 
179 
nv_python_libs.xsltfunctions.cinemarv_api.OutStreamEncoder.out
out
Definition: cinemarv_api.py:42
nv_python_libs.xsltfunctions.cinemarv_api.xpathFunctions.cinemarvCheckIfDBItem
def cinemarvCheckIfDBItem(self, context, *arg)
Definition: cinemarv_api.py:157
nv_python_libs.xsltfunctions.cinemarv_api.OutStreamEncoder.__init__
def __init__(self, outstream, encoding=None)
Definition: cinemarv_api.py:41
nv_python_libs.xsltfunctions.cinemarv_api.xpathFunctions.functList
functList
Definition: cinemarv_api.py:92
nv_python_libs.xsltfunctions.cinemarv_api.xpathFunctions.__init__
def __init__(self)
Definition: cinemarv_api.py:91
nv_python_libs.xsltfunctions.cinemarv_api.xpathFunctions.persistence
persistence
Definition: cinemarv_api.py:94
nv_python_libs.xsltfunctions.cinemarv_api.xpathFunctions.TextTail
TextTail
Definition: cinemarv_api.py:93
nv_python_libs.xsltfunctions.cinemarv_api.xpathFunctions.cinemarvIsCustomHTML
def cinemarvIsCustomHTML(self, context, *args)
Definition: cinemarv_api.py:142
nv_python_libs.xsltfunctions.cinemarv_api.OutStreamEncoder.encoding
encoding
Definition: cinemarv_api.py:44
nv_python_libs.xsltfunctions.cinemarv_api.xpathFunctions
Definition: cinemarv_api.py:88
nv_python_libs.xsltfunctions.cinemarv_api.xpathFunctions.cinemarvLinkGeneration
def cinemarvLinkGeneration(self, context, *args)
Start of XPath extension functions.
Definition: cinemarv_api.py:103
nv_python_libs.xsltfunctions.cinemarv_api.OutStreamEncoder.__getattr__
def __getattr__(self, attr)
Definition: cinemarv_api.py:57
nv_python_libs.xsltfunctions.cinemarv_api.OutStreamEncoder
Definition: cinemarv_api.py:39
nv_python_libs.xsltfunctions.cinemarv_api.OutStreamEncoder.write
def write(self, obj)
Definition: cinemarv_api.py:48
find
static pid_list_t::iterator find(const PIDInfoMap &map, pid_list_t &list, pid_list_t::iterator begin, pid_list_t::iterator end, bool find_open)
Definition: dvbstreamhandler.cpp:363