Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

# Licensed under the MIT license 

# http://opensource.org/licenses/mit-license.php 

 

# Copyright 2005, Tim Potter <tpot@samba.org> 

# Copyright 2006 John-Mark Gurney <gurney_j@resnet.uoregon.edu> 

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

 

# Content Directory service 

 

from twisted.internet import defer 

from twisted.python import failure 

from twisted.web import resource 

 

from coherence.upnp.core import service 

from coherence.upnp.core.DIDLLite import DIDLElement 

from coherence.upnp.core.soap_service import UPnPPublisher 

from coherence.upnp.core.soap_service import errorCode 

 

 

class ContentDirectoryControl(service.ServiceControl, UPnPPublisher): 

 

    def __init__(self, server): 

        service.ServiceControl.__init__(self) 

        UPnPPublisher.__init__(self) 

        self.service = server 

        self.variables = server.get_variables() 

        self.actions = server.get_actions() 

 

 

class ContentDirectoryServer(service.ServiceServer, resource.Resource): 

    logCategory = 'content_directory_server' 

 

    def __init__(self, device, backend=None, transcoding=False): 

        self.device = device 

        self.transcoding = transcoding 

        if backend is None: 

            backend = self.device.backend 

        resource.Resource.__init__(self) 

        service.ServiceServer.__init__(self, 'ContentDirectory', 

                                       self.device.version, backend) 

 

        self.control = ContentDirectoryControl(self) 

        self.putChild(b'scpd.xml', service.scpdXML(self, self.control)) 

        self.putChild(b'control', self.control) 

 

        self.set_variable(0, 'SystemUpdateID', 0) 

        self.set_variable(0, 'ContainerUpdateIDs', '') 

 

    def listchilds(self, uri): 

        if isinstance(uri, bytes): 

            uri = uri.decode('utf-8') 

        cl = '' 

        for c in self.children: 

            cl += '<li><a href=%s/%s>%s</a></li>' % (uri, c, c) 

        return cl 

 

    def render(self, request): 

        return \ 

            '<html><p>root of the ContentDirectory</p>' \ 

            '<p><ul>%s</ul></p></html>' % self.listchilds( 

                request.uri.decode('utf-8')) 

 

    def upnp_Search(self, *args, **kwargs): 

        ContainerID = kwargs['ContainerID'] 

        Filter = kwargs['Filter'] 

        StartingIndex = int(kwargs['StartingIndex']) 

        RequestedCount = int(kwargs['RequestedCount']) 

        SortCriteria = kwargs['SortCriteria'] 

        SearchCriteria = kwargs['SearchCriteria'] 

 

        total = 0 

        root_id = 0 

        item = None 

        items = [] 

 

        parent_container = str(ContainerID) 

 

        didl = DIDLElement(upnp_client=kwargs.get('X_UPnPClient', ''), 

                           parent_container=parent_container, 

                           transcoding=self.transcoding) 

 

        def build_response(tm): 

            r = {'Result': didl.toString(), 'TotalMatches': tm, 

                 'NumberReturned': didl.numItems()} 

 

            if hasattr(item, 'update_id'): 

                r['UpdateID'] = item.update_id 

            elif hasattr(self.backend, 'update_id'): 

                r['UpdateID'] = self.backend.update_id  # FIXME 

            else: 

                r['UpdateID'] = 0 

 

            return r 

 

        def got_error(r): 

            return r 

 

        def process_result(result, total=None, found_item=None): 

            if result is None: 

                result = [] 

 

            cl = [] 

 

            def process_items(result, tm): 

                if result is None: 

                    result = [] 

                for i in result: 

                    if i[0]: 

                        didl.addItem(i[1]) 

 

                return build_response(tm) 

 

            for i in result: 

                d = defer.maybeDeferred(i.get_item) 

                cl.append(d) 

 

            if found_item is not None: 

                def got_child_count(count): 

                    dl = defer.DeferredList(cl) 

                    dl.addCallback(process_items, count) 

                    return dl 

 

                d = defer.maybeDeferred(found_item.get_child_count) 

                d.addCallback(got_child_count) 

 

                return d 

            elif total is None: 

                total = item.get_child_count() 

 

            dl = defer.DeferredList(cl) 

            dl.addCallback(process_items, total) 

            return dl 

 

        def proceed(result): 

            if (kwargs.get('X_UPnPClient', '') == 'XBox' and 

                    hasattr(result, 'get_artist_all_tracks')): 

                d = defer.maybeDeferred(result.get_artist_all_tracks, 

                                        StartingIndex, 

                                        StartingIndex + RequestedCount) 

            else: 

                d = defer.maybeDeferred(result.get_children, StartingIndex, 

                                        StartingIndex + RequestedCount) 

            d.addCallback(process_result, found_item=result) 

            d.addErrback(got_error) 

            return d 

 

        try: 

            root_id = ContainerID 

        except Exception: 

            pass 

 

        wmc_mapping = getattr(self.backend, "wmc_mapping", None) 

        if kwargs.get('X_UPnPClient', '') == 'XBox': 

            if (wmc_mapping is not None and 

                    ContainerID in wmc_mapping): 

                """ fake a Windows Media Connect Server 

                """ 

                root_id = wmc_mapping[ContainerID] 

                if callable(root_id): 

                    item = root_id() 

                    if item is not None: 

                        if isinstance(item, list): 

                            total = len(item) 

                            if int(RequestedCount) == 0: 

                                items = item[StartingIndex:] 

                            else: 

                                items = item[StartingIndex: 

                                             StartingIndex + RequestedCount] 

                            return process_result(items, total=total) 

                        else: 

                            if isinstance(item, defer.Deferred): 

                                item.addCallback(proceed) 

                                return item 

                            else: 

                                return proceed(item) 

 

                item = self.backend.get_by_id(root_id) 

                if item is None: 

                    return process_result([], total=0) 

 

                if isinstance(item, defer.Deferred): 

                    item.addCallback(proceed) 

                    return item 

                else: 

                    return proceed(item) 

 

        item = self.backend.get_by_id(root_id) 

        if item is None: 

            return failure.Failure(errorCode(701)) 

 

        if isinstance(item, defer.Deferred): 

            item.addCallback(proceed) 

            return item 

        else: 

            return proceed(item) 

 

    def upnp_Browse(self, *args, **kwargs): 

        try: 

            ObjectID = kwargs['ObjectID'] 

        except KeyError: 

            self.debug( 

                "hmm, a Browse action and no ObjectID argument? " 

                "An XBox maybe?") 

            try: 

                ObjectID = kwargs['ContainerID'] 

            except KeyError: 

                ObjectID = 0 

        BrowseFlag = kwargs['BrowseFlag'] 

        Filter = kwargs['Filter'] 

        StartingIndex = int(kwargs['StartingIndex']) 

        RequestedCount = int(kwargs['RequestedCount']) 

        SortCriteria = kwargs['SortCriteria'] 

        parent_container = None 

        requested_id = None 

 

        item = None 

        total = 0 

        items = [] 

 

        if BrowseFlag == 'BrowseDirectChildren': 

            parent_container = str(ObjectID) 

        else: 

            requested_id = str(ObjectID) 

 

        self.info("upnp_Browse request %r %r %r %r", ObjectID, BrowseFlag, 

                  StartingIndex, RequestedCount) 

        # self.debug('\t- kwargs: {}'.format(kwargs)) 

 

        didl = DIDLElement(upnp_client=kwargs.get('X_UPnPClient', ''), 

                           requested_id=requested_id, 

                           parent_container=parent_container, 

                           transcoding=self.transcoding) 

 

        def got_error(r): 

            return r 

 

        def process_result(result, total=None, found_item=None): 

            if result is None: 

                result = [] 

            if BrowseFlag == 'BrowseDirectChildren': 

                cl = [] 

 

                def process_items(result, tm): 

                    if result is None: 

                        result = [] 

                    for i in result: 

                        if i[0]: 

                            didl.addItem(i[1]) 

 

                    return build_response(tm) 

 

                for i in result: 

                    d = defer.maybeDeferred(i.get_item) 

                    cl.append(d) 

 

                if found_item is not None: 

                    def got_child_count(count): 

                        dl = defer.DeferredList(cl) 

                        dl.addCallback(process_items, count) 

                        return dl 

 

                    d = defer.maybeDeferred(found_item.get_child_count) 

                    d.addCallback(got_child_count) 

 

                    return d 

                elif total is None: 

                    total = item.get_child_count() 

 

                dl = defer.DeferredList(cl) 

                dl.addCallback(process_items, total) 

                return dl 

            else: 

                didl.addItem(result) 

                total = 1 

 

            return build_response(total) 

 

        def build_response(tm): 

            r = {'Result': didl.toString(), 

                 'TotalMatches': tm, 

                 'NumberReturned': didl.numItems()} 

 

            if hasattr(item, 'update_id'): 

                r['UpdateID'] = item.update_id 

            elif hasattr(self.backend, 'update_id'): 

                r['UpdateID'] = self.backend.update_id  # FIXME 

            else: 

                r['UpdateID'] = 0 

 

            return r 

 

        def proceed(result): 

            if BrowseFlag == 'BrowseDirectChildren': 

                d = defer.maybeDeferred(result.get_children, StartingIndex, 

                                        StartingIndex + RequestedCount) 

            else: 

                d = defer.maybeDeferred(result.get_item) 

 

            d.addCallback(process_result, found_item=result) 

            d.addErrback(got_error) 

            return d 

 

        root_id = ObjectID 

 

        wmc_mapping = getattr(self.backend, "wmc_mapping", None) 

        if kwargs.get('X_UPnPClient', '') == 'XBox' and \ 

                wmc_mapping is not None and ObjectID in wmc_mapping: 

            """ fake a Windows Media Connect Server 

            """ 

            root_id = wmc_mapping[ObjectID] 

            if callable(root_id): 

                item = root_id() 

                if item is not None: 

                    if isinstance(item, list): 

                        total = len(item) 

                        if int(RequestedCount) == 0: 

                            items = item[StartingIndex:] 

                        else: 

                            items = item[StartingIndex: 

                                         StartingIndex + 

                                         RequestedCount] 

                        return process_result(items, total=total) 

                    else: 

                        if isinstance(item, defer.Deferred): 

                            item.addCallback(proceed) 

                            return item 

                        else: 

                            return proceed(item) 

 

            item = self.backend.get_by_id(root_id) 

            if item is None: 

                return process_result([], total=0) 

 

            if isinstance(item, defer.Deferred): 

                item.addCallback(proceed) 

                return item 

            else: 

                return proceed(item) 

 

        item = self.backend.get_by_id(root_id) 

        if item is None: 

            return failure.Failure(errorCode(701)) 

 

        if isinstance(item, defer.Deferred): 

            item.addCallback(proceed) 

            return item 

        else: 

            return proceed(item)