Source code for coherence.backends.dvbd_storage

# Licensed under the MIT license
# http://opensource.org/licenses/mit-license.php

# Copyright 2008, Frank Scholz <coherence@beebits.net>

import urllib.error
import urllib.parse
import urllib.request
from datetime import datetime

import dbus
import dbus.service
from twisted.internet import defer
from twisted.python import failure, util
from twisted.python.filepath import FilePath

import coherence.extern.louie as louie
from coherence.backend import BackendItem, BackendStore
from coherence.upnp.core import DIDLLite
from coherence.upnp.core.soap_service import errorCode

ROOT_CONTAINER_ID = 0

RECORDINGS_CONTAINER_ID = 100
CHANNELS_CONTAINER_ID = 200
CHANNEL_GROUPS_CONTAINER_ID = 300
BASE_CHANNEL_GROUP_ID = 1000

BUS_NAME = 'org.gnome.DVB'
RECORDINGSSTORE_OBJECT_PATH = '/org/gnome/DVB/RecordingsStore'
MANAGER_OBJECT_PATH = '/org/gnome/DVB/Manager'


[docs]class Container(BackendItem): logCategory = 'dvbd_store' def __init__(self, id, parent_id, name, store=None, children_callback=None, container_class=DIDLLite.Container): BackendItem.__init__(self) self.id = id self.parent_id = parent_id self.name = name self.mimetype = 'directory' self.item = container_class(id, parent_id, self.name) self.item.childCount = 0 self.update_id = 0 if children_callback is not None: self.children = children_callback else: self.children = util.OrderedDict() if store is not None: self.get_url = lambda: store.urlbase + str(self.id)
[docs] def add_child(self, child): id = child.id if isinstance(child.id, str): _, id = child.id.split('.') self.children[id] = child if self.item.childCount is not None: self.item.childCount += 1
[docs] def get_children(self, start=0, end=0): self.info("container.get_children %r %r", start, end) if callable(self.children): return self.children(start, end - start) else: children = list(self.children.values()) if end == 0: return children[start:] else: return children[start:end]
[docs] def remove_children(self): if not callable(self.children): self.children = util.OrderedDict() self.item.childCount = 0
[docs] def get_child_count(self): if self.item.childCount is not None: return self.item.childCount if callable(self.children): return len(self.children()) else: return len(self.children)
[docs] def get_item(self): return self.item
[docs] def get_name(self): return self.name
[docs] def get_id(self): return self.id
[docs]class Channel(BackendItem): logCategory = 'dvbd_store' def __init__(self, store, id, parent_id, name, url, network, mimetype): BackendItem.__init__(self) self.store = store self.id = 'channel.%s' % id self.parent_id = parent_id self.real_id = id self.name = str(name) self.network = str(network) self.stream_url = url self.mimetype = str(mimetype)
[docs] def get_children(self, start=0, end=0): return []
[docs] def get_child_count(self): return 0
[docs] def get_item(self, parent_id=None): self.debug("Channel get_item %r @ %r", self.id, self.parent_id) item = DIDLLite.VideoBroadcast(self.id, self.parent_id) item.title = self.name res = DIDLLite.Resource(self.stream_url, 'rtsp-rtp-udp:*:%s:*' % self.mimetype) item.res.append(res) return item
[docs] def get_id(self): return self.id
[docs] def get_name(self): return self.name
[docs]class Recording(BackendItem): logCategory = 'dvbd_store' def __init__(self, store, id, parent_id, file, title, date, duration, mimetype): BackendItem.__init__(self) self.store = store self.id = 'recording.%s' % id self.parent_id = parent_id self.real_id = id path = str(file) # make sure path is an absolute local path (and not an URL) if path.startswith("file://"): path = path[7:] self.location = FilePath(path) self.title = str(title) self.mimetype = str(mimetype) self.date = datetime.fromtimestamp(int(date)) self.duration = int(duration) try: self.size = self.location.getsize() except Exception as msg: self.size = 0 self.bitrate = 0 self.url = self.store.urlbase + str(self.id)
[docs] def get_children(self, start=0, end=0): return []
[docs] def get_child_count(self): return 0
[docs] def get_item(self, parent_id=None): self.debug("Recording get_item %r @ %r", self.id, self.parent_id) # create item item = DIDLLite.VideoBroadcast(self.id, self.parent_id) item.date = self.date item.title = self.title # add http resource res = DIDLLite.Resource(self.url, 'http-get:*:%s:*' % self.mimetype) if self.size > 0: res.size = self.size if self.duration > 0: res.duration = str(self.duration) if self.bitrate > 0: res.bitrate = str(self.bitrate) item.res.append(res) # add internal resource res = DIDLLite.Resource( 'file://' + urllib.parse.quote(self.get_path()), 'internal:%s:%s:*' % ( self.store.server.coherence.hostname, self.mimetype)) if self.size > 0: res.size = self.size if self.duration > 0: res.duration = str(self.duration) if self.bitrate > 0: res.bitrate = str(self.bitrate) item.res.append(res) return item
[docs] def get_id(self): return self.id
[docs] def get_name(self): return self.title
[docs] def get_url(self): return self.url
[docs] def get_path(self): return self.location.path
[docs]class DVBDStore(BackendStore): """ this is a backend to the DVB Daemon http://www.k-d-w.org/node/42 """ implements = ['MediaServer'] logCategory = 'dvbd_store' def __init__(self, server, **kwargs): if server.coherence.config.get('use_dbus', 'no') != 'yes': raise Exception( 'this backend needs use_dbus enabled in the configuration') BackendStore.__init__(self, server, **kwargs) self.config = kwargs self.name = kwargs.get('name', 'TV') self.update_id = 0 self.channel_groups = [] if kwargs.get('enable_destroy', 'no') == 'yes': self.upnp_DestroyObject = self.hidden_upnp_DestroyObject self.bus = dbus.SessionBus() dvb_daemon_recordingsStore = self.bus.get_object( BUS_NAME, RECORDINGSSTORE_OBJECT_PATH) dvb_daemon_manager = self.bus.get_object(BUS_NAME, MANAGER_OBJECT_PATH) self.store_interface = dbus.Interface(dvb_daemon_recordingsStore, 'org.gnome.DVB.RecordingsStore') self.manager_interface = dbus.Interface(dvb_daemon_manager, 'org.gnome.DVB.Manager') dvb_daemon_recordingsStore.connect_to_signal( 'Changed', self.recording_changed, dbus_interface='org.gnome.DVB.RecordingsStore') self.containers = {} self.containers[ROOT_CONTAINER_ID] = \ Container(ROOT_CONTAINER_ID, -1, self.name, store=self) self.containers[RECORDINGS_CONTAINER_ID] = \ Container(RECORDINGS_CONTAINER_ID, ROOT_CONTAINER_ID, 'Recordings', store=self) self.containers[CHANNELS_CONTAINER_ID] = \ Container(CHANNELS_CONTAINER_ID, ROOT_CONTAINER_ID, 'Channels', store=self) self.containers[CHANNEL_GROUPS_CONTAINER_ID] = \ Container(CHANNEL_GROUPS_CONTAINER_ID, ROOT_CONTAINER_ID, 'Channel Groups', store=self) self.containers[ROOT_CONTAINER_ID].add_child( self.containers[RECORDINGS_CONTAINER_ID]) self.containers[ROOT_CONTAINER_ID].add_child( self.containers[CHANNELS_CONTAINER_ID]) self.containers[ROOT_CONTAINER_ID].add_child( self.containers[CHANNEL_GROUPS_CONTAINER_ID]) def query_finished(r): louie.send('Coherence.UPnP.Backend.init_completed', None, backend=self) def query_failed(error): self.error("ERROR: %s", error) louie.send('Coherence.UPnP.Backend.init_failed', None, backend=self, msg=error) # get_device_groups is called after get_channel_groups, # because we need channel groups first channel_d = self.get_channel_groups() channel_d.addCallback(self.get_device_groups) channel_d.addErrback(query_failed) d = defer.DeferredList((channel_d, self.get_recordings())) d.addCallback(query_finished) d.addErrback(query_failed) def __repr__(self): return "DVBDStore"
[docs] def get_by_id(self, id): self.info("looking for id %r", id) if isinstance(id, str): id = id.split('@', 1)[0] elif isinstance(id, bytes): id = id.decode('utf-8').split('@', 1)[0] item = None try: id = int(id) item = self.containers[id] except (ValueError, KeyError): try: type, id = id.split('.') if type == 'recording': return self.containers[ RECORDINGS_CONTAINER_ID].children[id] except (ValueError, KeyError): return None return item
[docs] def recording_changed(self, id, mode): self.containers[RECORDINGS_CONTAINER_ID].remove_children() def handle_result(r): self.debug("recording changed, handle_result: %s", self.containers[RECORDINGS_CONTAINER_ID].update_id) self.containers[RECORDINGS_CONTAINER_ID].update_id += 1 if (self.server and hasattr(self.server, 'content_directory_server')): if hasattr(self, 'update_id'): self.update_id += 1 self.server.content_directory_server.set_variable( 0, 'SystemUpdateID', self.update_id) value = (RECORDINGS_CONTAINER_ID, self.containers[RECORDINGS_CONTAINER_ID].update_id) self.debug("ContainerUpdateIDs new value: %s", value) self.server.content_directory_server.set_variable( 0, 'ContainerUpdateIDs', value) def handle_error(error): self.error("ERROR: %s", error) return error d = self.get_recordings() d.addCallback(handle_result) d.addErrback(handle_error)
[docs] def get_recording_details(self, id): self.debug("GET RECORDING DETAILS") def process_details(data): self.debug("GOT RECORDING DETAILS %s", data) rid, name, desc, length, start, channel, location = data if len(name) == 0: name = 'Recording ' + str(rid) return {'id': rid, 'name': name, 'path': location, 'date': start, 'duration': length} def handle_error(error): self.error("ERROR: %s", error) return error d = defer.Deferred() d.addCallback(process_details) d.addErrback(handle_error) self.store_interface.GetAllInformations( id, reply_handler=lambda x, success: d.callback(x), error_handler=lambda x, success: d.errback(x)) return d
[docs] def get_recordings(self): self.debug("GET RECORDINGS") def handle_error(error): self.error("ERROR: %s", error) return error def process_query_result(ids): self.debug("GOT RECORDINGS: %s", ids) if len(ids) == 0: return [] rd = [] for id in ids: rd.append(self.get_recording_details(id)) dl = defer.DeferredList(rd) return dl def process_details(results): # print('process_details', results) for result, recording in results: # print(result, recording['name']) if result: # print("add", recording['id'], recording['name'], # recording['path'], recording['date'], # recording['duration']) video_item = Recording(self, recording['id'], RECORDINGS_CONTAINER_ID, recording['path'], recording['name'], recording['date'], recording['duration'], 'video/mpegts') self.containers[RECORDINGS_CONTAINER_ID].add_child( video_item) d = defer.Deferred() d.addCallback(process_query_result) d.addCallback(process_details) d.addErrback(handle_error) d.addErrback(handle_error) self.store_interface.GetRecordings( reply_handler=lambda x: d.callback(x), error_handler=lambda x: d.errback(x)) return d
[docs] def get_channel_details(self, channelList_interface, id): self.debug("GET CHANNEL DETAILS %s", id) def get_name(id): d = defer.Deferred() channelList_interface.GetChannelName( id, reply_handler=lambda x, success: d.callback(x), error_handler=lambda x, success: d.errback(x)) return d def get_network(id): d = defer.Deferred() channelList_interface.GetChannelNetwork( id, reply_handler=lambda x, success: d.callback(x), error_handler=lambda x, success: d.errback(x)) return d def get_url(id): d = defer.Deferred() channelList_interface.GetChannelURL( id, reply_handler=lambda x, success: d.callback(x), error_handler=lambda x, success: d.errback(x)) return d def process_details(r, id): self.debug("GOT DETAILS %d: %s", id, r) name = r[0][1] network = r[1][1] url = r[2][1] return {'id': id, 'name': name.encode('latin-1'), 'network': network, 'url': url} def handle_error(error): return error dl = defer.DeferredList((get_name(id), get_network(id), get_url(id))) dl.addCallback(process_details, id) dl.addErrback(handle_error) return dl
[docs] def get_channelgroup_members(self, channel_items, channelList_interface): self.debug("GET ALL CHANNEL GROUP MEMBERS") def handle_error(error): self.error("ERROR: %s", error) return error def process_getChannelsOfGroup(results, group_id): for channel_id in results: channel_id = int(channel_id) if channel_id in channel_items: item = channel_items[channel_id] container_id = BASE_CHANNEL_GROUP_ID + group_id self.containers[container_id].add_child(item) def get_members(channelList_interface, group_id): self.debug("GET CHANNEL GROUP MEMBERS %d", group_id) d = defer.Deferred() d.addCallback(process_getChannelsOfGroup, group_id) d.addErrback(handle_error) channelList_interface.GetChannelsOfGroup( group_id, reply_handler=lambda x, success: d.callback(x), error_handler=lambda x, success: d.callback(x)) return d ml = [] for group_id, group_name in self.channel_groups: ml.append(get_members(channelList_interface, group_id)) dl = defer.DeferredList(ml) return dl
[docs] def get_tv_channels(self, channelList_interface): self.debug("GET TV CHANNELS") def handle_error(error): self.error("ERROR: %s", error) return error def process_getChannels_result(channels, channelList_interface): self.debug("GetChannels: %s", channels) if len(channels) == 0: return [] cl = [] for channel_id in channels: cl.append( self.get_channel_details( channelList_interface, channel_id)) dl = defer.DeferredList(cl) return dl def process_details(results): self.debug('GOT DEVICE GROUP DETAILS %s', results) channels = {} for result, channel in results: # print channel if result: name = str(channel['name'], errors='ignore') # print "add", name, channel['url'] video_item = Channel(self, channel['id'], CHANNELS_CONTAINER_ID, name, channel['url'], channel['network'], 'video/mpegts') self.containers[CHANNELS_CONTAINER_ID].add_child( video_item) channels[int(channel['id'])] = video_item return channels d = defer.Deferred() d.addCallback(process_getChannels_result, channelList_interface) d.addCallback(process_details) d.addCallback(self.get_channelgroup_members, channelList_interface) d.addErrback(handle_error) d.addErrback(handle_error) d.addErrback(handle_error) channelList_interface.GetTVChannels( reply_handler=lambda x: d.callback(x), error_handler=lambda x: d.errback(x)) return d
[docs] def get_deviceGroup_details(self, devicegroup_interface): self.debug("GET DEVICE GROUP DETAILS") def handle_error(error): self.error("ERROR: %s", error) return error def process_getChannelList_result(result): self.debug("GetChannelList: %s", result) dvbd_channelList = self.bus.get_object(BUS_NAME, result) channelList_interface = dbus.Interface( dvbd_channelList, 'org.gnome.DVB.ChannelList') return self.get_tv_channels(channelList_interface) d = defer.Deferred() d.addCallback(process_getChannelList_result) d.addErrback(handle_error) devicegroup_interface.GetChannelList( reply_handler=lambda x: d.callback(x), error_handler=lambda x: d.errback(x)) return d
[docs] def get_device_groups(self, results): self.debug("GET DEVICE GROUPS") def handle_error(error): self.error("ERROR: %s", error) return error def process_query_result(ids): self.debug("GetRegisteredDeviceGroups: %s", ids) if len(ids) == 0: return gl = [] for group_object_path in ids: dvbd_devicegroup = self.bus.get_object(BUS_NAME, group_object_path) devicegroup_interface = dbus.Interface( dvbd_devicegroup, 'org.gnome.DVB.DeviceGroup') gl.append(self.get_deviceGroup_details(devicegroup_interface)) dl = defer.DeferredList(gl) return dl d = defer.Deferred() d.addCallback(process_query_result) d.addErrback(handle_error) self.manager_interface.GetRegisteredDeviceGroups( reply_handler=lambda x: d.callback(x), error_handler=lambda x: d.errback(x)) return d
[docs] def get_channel_groups(self): self.debug("GET CHANNEL GROUPS") def handle_error(error): self.error("ERROR: %s", error) return error def process_GetChannelGroups_result(data): self.debug("GOT CHANNEL GROUPS %s", data) for group in data: self.channel_groups.append(group) # id, name container_id = BASE_CHANNEL_GROUP_ID + group[0] group_item = Container(container_id, CHANNEL_GROUPS_CONTAINER_ID, group[1], store=self) self.containers[container_id] = group_item self.containers[CHANNEL_GROUPS_CONTAINER_ID].add_child( group_item) d = defer.Deferred() d.addCallback(process_GetChannelGroups_result) d.addErrback(handle_error) self.manager_interface.GetChannelGroups( reply_handler=lambda x: d.callback(x), error_handler=lambda x: d.errback(x)) return d
[docs] def upnp_init(self): if self.server: self.server.connection_manager_server.set_variable( 0, 'SourceProtocolInfo', [ 'http-get:*:video/mpegts:*', 'internal:%s:video/mpegts:*' % self.server.coherence.hostname, ], 'rtsp-rtp-udp:*:video/mpegts:*', )
[docs] def hidden_upnp_DestroyObject(self, *args, **kwargs): ObjectID = kwargs['ObjectID'] item = self.get_by_id(ObjectID) if item is None: return failure.Failure(errorCode(701)) def handle_success(deleted): print('deleted', deleted, kwargs['ObjectID']) if not deleted: return failure.Failure(errorCode(715)) return {} def handle_error(error): return failure.Failure(errorCode(701)) d = defer.Deferred() self.store_interface.Delete(int(item.real_id), reply_handler=lambda x: d.callback(x), error_handler=lambda x: d.errback(x)) d.addCallback(handle_success) d.addErrback(handle_error) return d
[docs]class DVBDScheduledRecording(BackendStore): logCategory = 'dvbd_store' def __init__(self, server, **kwargs): if server.coherence.config.get('use_dbus', 'no') != 'yes': raise Exception( 'this backend needs use_dbus enabled in the configuration') BackendStore.__init__(self, server, **kwargs) self.state_update_id = 0 self.bus = dbus.SessionBus() # We have one ScheduleRecording service for each device group # TODO use one ScheduledRecording for each device group self.device_group_interface = None dvbd_recorder = self.device_group_interface.GetRecorder() self.recorder_interface = self.bus.get_object(BUS_NAME, dvbd_recorder) def __repr__(self): return "DVBDScheduledRecording"
[docs] def get_timer_details(self, tid): self.debug("GET TIMER DETAILS %d", tid) def handle_error(error): self.error("ERROR: %s", error) return error def get_infos(t_id): d = defer.Callback() self.recorder_interface.GetAllInformations( t_id, reply_handler=lambda x, success: d.callback(x), error_handler=lambda x, success: d.errback(x)) return d def get_start_time(t_id): d = defer.Callback() self.recorder_interface.GetStartTime( t_id, reply_handler=lambda x, success: d.callback(x), error_handler=lambda x, success: d.errback(x)) return d def process_details(results): t_id, duration, active, channel_name, title = results[0][1] start = results[1][1] start_datetime = datetime(*start) # TODO return what we actually need # FIXME we properly want the channel id here rather than the name return {'id': t_id, 'duration': duration, 'channel': channel_name, 'start': start_datetime} d = defer.DeferredList( [get_infos(tid), get_start_time(tid)] ) d.addCallback(process_details) d.addErrback(handle_error) return d
[docs] def get_timers(self): self.debug("GET TIMERS") def handle_error(error): self.error("ERROR: %s", error) return error def process_GetTimers_results(timer_ids): tl = [] for tid in timer_ids: tl.append(self.get_timer_details(tid)) dl = defer.DeferredList(tl) return dl d = defer.Deferred() d.addCallback(process_GetTimers_results) d.addErrback(handle_error) self.recorder_interface.GetTimers( reply_handler=lambda x: d.callback(x), error_handler=lambda x: d.errback(x)) return d
[docs] def add_timer(self, channel_id, start_datetime, duration): self.debug("ADD TIMER") def handle_error(error): self.error("ERROR: %s", error) return error def process_AddTimer_result(timer_id): self.state_update_id += 1 return timer_id d = defer.Deferred() d.addCallback(process_AddTimer_result) d.addErrback(handle_error) self.recorder_interface.AddTimer( channel_id, start_datetime.year, start_datetime.month, start_datetime.day, start_datetime.hour, start_datetime.minute, duration, reply_handler=lambda x, success: d.callback(x), error_handler=lambda x, success: d.errback(x)) return d
[docs] def delete_timer(self, tid): self.debug("DELETE TIMER %d", tid) def handle_error(error): self.error("ERROR: %s", error) return error def process_DeleteTimer_result(success): if not success: # TODO: return 704 return self.state_update_id += 1 d = defer.Deferred() d.addCallback(process_DeleteTimer_result) d.addErrback(handle_error) self.recorder_interface.DeleteTimer( tid, reply_handler=lambda x, success: d.callback(x), error_handler=lambda x, success: d.errback(x)) return d
[docs] def upnp_GetPropertyList(self, *args, **kwargs): pass
[docs] def upnp_GetAllowedValues(self, *args, **kwargs): pass
[docs] def upnp_GetStateUpdateID(self, *args, **kwargs): return self.state_update_id
[docs] def upnp_BrowseRecordSchedules(self, *args, **kwargs): schedules = [] # ChannelID, StartDateTime, Duration sched = self.upnp_GetRecordSchedule(*args, **kwargs) return sched
[docs] def upnp_BrowseRecordTasks(self, *args, **kwargs): rec_sched_id = int(kwargs['RecordScheduleID']) tasks = [] # ScheduleID, ChannelID, StartDateTime, Duration task = self.upnp_GetRecordTask(*args, **kwargs) return task
[docs] def upnp_CreateRecordSchedule(self, *args, **kwargs): schedule = kwargs['RecordScheduleParts'] channel_id = schedule.getChannelID() # returns a python datetime object start = schedule.getStartDateTime() # duration in minutes duration = schedule.getDuration() return self.add_timer(channel_id, start, duration)
[docs] def upnp_DeleteRecordSchedule(self, *args, **kwargs): rec_sched_id = int(kwargs['RecordScheduleID']) def handle_error(error): self.error("ERROR: %s", error) return error def process_IsTimerActive_result(is_active, rec_sched_id): if is_active: # TODO: Return 705 return else: return self.delete_timer(rec_sched_id) d = defer.Deferred() d.addCallback(process_IsTimerActive_result, rec_sched_id) d.addErrback(handle_error) self.recorder_interface.IsTimerActive( rec_sched_id, reply_handler=lambda x: d.callback(x), error_handler=lambda x: d.errback(x)) return d
[docs] def upnp_GetRecordSchedule(self, *args, **kwargs): rec_sched_id = int(kwargs['RecordScheduleID']) return self.get_timer_details(rec_sched_id)
[docs] def upnp_GetRecordTask(self, *args, **kwargs): rec_task_id = int(kwargs['RecordTaskID']) return self.get_timer_details(rec_task_id)