File: mhmanager.py

package info (click to toggle)
congruity 18-1.1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 816 kB
  • ctags: 1,136
  • sloc: python: 8,425; makefile: 52
file content (951 lines) | stat: -rw-r--r-- 42,307 bytes parent folder | download | duplicates (2)
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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
#!/usr/bin/python

# Copyright 2012-2013 Scott Talbert
#
# This file is part of congruity.
#
# congruity 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.
#
# congruity 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 congruity.  If not, see <http://www.gnu.org/licenses/>.

import logging
import httplib
import urlparse
import urllib
import urllib2
import uuid
import re
import time
import os
import sys
import random
import datetime
from HTMLParser import HTMLParser
from suds.cache import ObjectCache
from suds.client import Client
from suds.plugin import MessagePlugin

XSI_NS = "http://www.w3.org/2001/XMLSchema"
MS_NS = "http://schemas.microsoft.com/2003/10/Serialization/"
DATA_NS = "http://schemas.datacontract.org/2004/07/Logitech.Harmony.Services.Common.Contracts.Data"
OPERATION_NS = "http://schemas.datacontract.org/2004/07/Logitech.Harmony.Services.Common.Contracts.Data.Operation"
DM_OPERATION_NS = "http://schemas.datacontract.org/2004/07/Logitech.Harmony.Services.Manager.DeviceManager.Contracts.Data.Operation"
ACCOUNT_NS = "http://schemas.datacontract.org/2004/07/Logitech.Harmony.Services.DataContract.Account"
BUTTON_MAPPING_NS = "http://schemas.datacontract.org/2004/07/Logitech.Harmony.Services.DataContract.ButtonMapping"
ACTIVITY_NS = "http://schemas.datacontract.org/2004/07/Logitech.Harmony.Services.DataContract.Activity"
ARRAYS_NS = "http://schemas.microsoft.com/2003/10/Serialization/Arrays"
USER_FEATURE_NS = "http://schemas.datacontract.org/2004/07/Logitech.Harmony.Services.DataContract.UserFeature"

TYPES_FOR_WHICH_TO_INCLUDE_TYPE_ENCODING = [
    (XSI_NS, "long"),
    (MS_NS, "guid"),
    (BUTTON_MAPPING_NS, "HardButton"),
    (BUTTON_MAPPING_NS, "CommandButtonAssignment"),
    (BUTTON_MAPPING_NS, "ChannelButtonAssignment"),
    (OPERATION_NS, "OperationBag"),
    (DM_OPERATION_NS, "Operation"),
    (DM_OPERATION_NS, "AddDeviceBySearchResultOperation"),
    (DM_OPERATION_NS, "UpdateDeviceNameOperation"),
    (DM_OPERATION_NS, "AddCommandOperation"),
    (DM_OPERATION_NS, "DeleteCommandOperation"),
    (ACTIVITY_NS, "AccessInternetActivityRole"),
    (ACTIVITY_NS, "ChannelChangingActivityRole"),
    (ACTIVITY_NS, "ControlsNetflixActivityRole"),
    (ACTIVITY_NS, "ControlsVideoCallActivityRole"),
    (ACTIVITY_NS, "DisplayActivityRole"),
    (ACTIVITY_NS, "PassThroughActivityRole"),
    (ACTIVITY_NS, "PlayGameActivityRole"),
    (ACTIVITY_NS, "PlayMediaActivityRole"),
    (ACTIVITY_NS, "PlayMovieActivityRole"),
    (ACTIVITY_NS, "RunLogitechGoogleTVActivityRole"),
    (ACTIVITY_NS, "VolumeActivityRole"),
    (USER_FEATURE_NS, "IRDelayAction"),
    (USER_FEATURE_NS, "IRDevAction"),
    (USER_FEATURE_NS, "IRPressAction"),
    (USER_FEATURE_NS, "InputFeature"),
    (USER_FEATURE_NS, "PowerFeature"),
    (USER_FEATURE_NS, "ChannelTuningFeature"),
]

# This is a mapping between ActivityTypes and a friendly string
ACTIVITY_TYPE_STRINGS = {
    "Custom"        : "Custom",
    "ListenToMusic" : "Listen to Music",
    "MakeVideoCall" : "Make a Video Call",
    "PlayGame"      : "Play a Game",
    "SurfWeb"       : "Surf the Web",
    "WatchDvd"      : "Watch a Movie",
    "WatchNetflix"  : "Watch Netflix",
    "WatchTV"       : "Watch TV",
}

# This is a mapping between Roles and a friendly string
ROLE_STRINGS = {
    "AccessInternetActivityRole"      : "access the Internet",
    "ChannelChangingActivityRole"     : "change channels",
    "ControlsNetflixActivityRole"     : "watch Netflix",
    "ControlsVideoCallActivityRole"   : "make a video call",
    "PlayGameActivityRole"            : "play video games",
    "PlayMediaActivityRole"           : "play music",
    "PlayMovieActivityRole"           : "watch a movie",
    "RunLogitechGoogleTVActivityRole" : "watch Google TV",
    "VolumeActivityRole"              : "control volume",
}

class MHPlugin(MessagePlugin):
    def fix_elements(self, prefix, elements):
        for element in elements:
            # This is a bit odd, but the MH parser expects type="xxx" attributes
            # only for a few certain types.
            if (element.get('type') is not None) and (element.name is not None):
                ns = element.resolvePrefix(element.get('type').split(':')[0])[1]
                type = element.get('type').split(':')[1]
                if (ns, type) not in TYPES_FOR_WHICH_TO_INCLUDE_TYPE_ENCODING:
                    element.unset('type')
            # Set the namespace prefix where it is set on the parent but not
            # on the children.
            if (element.prefix is None) and (prefix is not None):
                element.setPrefix(prefix)
                #print "PLUGIN: set prefix for {0}".format(element)
            # Recursively fix the child elements.
            if element.getChildren() is not None:
                self.fix_elements(element.prefix, element.getChildren())
    def marshalled(self, context):
        body = context.envelope.getChild('Body')
        # Make the namespace explicit in the operation tag vice having it
        # predefined, e.g.:
        # xmlns:ns="namespace"; <ns:operation> ==> <operation xmlns="namespace">
        operation = body[0]
        if operation.prefix is not None:
            ns = operation.resolvePrefix(operation.prefix)
            if ns[1] is not None:
                operation.expns = ns[1]
        operation.prefix = None
        self.fix_elements(None, operation.getChildren())

class MHManager():
    def __init__(self, use_local_wsdl=False, suds_debug=False):
        if use_local_wsdl:
            # Find the harmony.wsdl file.
            appdir = os.path.abspath(os.path.dirname(sys.argv[0]))
            dirs = ['/usr/share/congruity', appdir, '.']
            for dir in dirs:
                fpath = os.path.join(dir, "harmony.wsdl")
                if os.path.isfile(fpath):
                    self.wsdl_path = fpath
                    break

            url = 'file://' + self.wsdl_path
            cache = None
        else:
            url = 'http://congruity.sourceforge.net/congruity/harmony.wsdl'
            cache = ObjectCache(hours=4)
        if suds_debug:
            logging.basicConfig(level=logging.INFO)
            logging.getLogger('suds.transport').setLevel(logging.DEBUG)
        self.client = Client(url, cache=cache, plugins=[MHPlugin()])
        self.logged_in = False

    # Log in to web service - Returns True if login succeeded, False otherwise.
    def Login(self, email, password):
        self.logged_in = self.client.service['Security'].LoginUser(
            email=email, password=password, customCredential='',
            isPresistent=False)
        self.email = email
        self.password = password
        return self.logged_in is not None

    # Gets the household info.
    def GetHousehold(self):
        self.household = self.client.service['AccountManager'].GetMyHousehold()

    # Gets the remote(s) for a given account.
    def GetRemotes(self):
        self.GetHousehold()
        remotes = []
        for account in self.household.Accounts.Account:
            if account.Remotes != "":
                for remote in account.Remotes.Remote:
                    remotes.append(remote)
        return remotes

    # Gets the product info for a given Skin Id.
    def GetProduct(self, skinId):
        return self.client.service['ProductsManager'].GetProduct(skinId)

    def GetProductButtonList(self, skinId):
        return self.client.service['ProductsManager'].GetProductButtonList(skinId).Buttons.ButtonDefinition

    def GetCommands(self, deviceId):
        deviceIds = self.client.factory.create('{' + DATA_NS + '}deviceIds')
        deviceIds.DeviceId.append(deviceId)
        result = self.client.service['DeviceManager'].GetCommands(deviceIds)
        if result is not None:
            return result[0].Value[0]
        else:
            return None

    def GetButtonMap(self, deviceId):
        deviceIds = self.client.factory.create('{' + DATA_NS + '}deviceIds')
        deviceIds.DeviceId.append(deviceId)
        result = self.client.service['UserButtonMappingManager'] \
            .GetDeviceModeButtonMaps(deviceIds)
        if result is not None:
            return result[0].Value
        else:
            return None

    def UpdateButtonMap(self, existingButtonMap, button, command,
                        isChannelButton = False):
        buttonMaps = self.client.factory.create('{' + BUTTON_MAPPING_NS
                                                + '}buttonMaps')
        buttonMap = self.client.factory.create('{' + BUTTON_MAPPING_NS
                                               + '}ButtonMap')
        # Have to do this because existingButtonMap doesn't have the correct
        # namespaces.  Same with the others below.
        buttonMap.ButtonMapId.IsPersisted = \
            existingButtonMap.ButtonMapId.IsPersisted
        buttonMap.ButtonMapId.Value = existingButtonMap.ButtonMapId.Value
        buttonMap.ButtonMapType = existingButtonMap.ButtonMapType
        newButton = self.client.factory.create('{' + BUTTON_MAPPING_NS
                                               + '}HardButton')
        if isChannelButton is False:
            newButton.ButtonAssignment = self.client.factory.create(
                '{' + BUTTON_MAPPING_NS + '}CommandButtonAssignment')
            newButton.ButtonAssignment.CommandId.IsPersisted = \
                command.Id.IsPersisted
            newButton.ButtonAssignment.CommandId.Value = command.Id.Value
            newButton.ButtonAssignment.OverriddenDeviceId = None
            newButton.ButtonAssignment.OverriddenButtonMapType = "NoSetting"
        else:
            newButton.ButtonAssignment = self.client.factory.create(
                '{' + BUTTON_MAPPING_NS + '}ChannelButtonAssignment')
            newButton.ButtonAssignment.Channel = command
            newButton.ButtonAssignment.DeviceId.IsPersisted = \
                existingButtonMap.PrimaryDeviceReferenceId.IsPersisted
            newButton.ButtonAssignment.DeviceId.Value = \
                existingButtonMap.PrimaryDeviceReferenceId.Value
        newButton.ButtonKey = button.ButtonKey
        buttonMap.Buttons.AbstractButton = newButton
        buttonMap.PrimaryDeviceReferenceId.IsPersisted = \
            existingButtonMap.PrimaryDeviceReferenceId.IsPersisted
        buttonMap.PrimaryDeviceReferenceId.Value = \
            existingButtonMap.PrimaryDeviceReferenceId.Value
        buttonMap.SurfaceId = "0"
        buttonMaps.ButtonMap = buttonMap
        self.client.service['UserButtonMappingManager'] \
            .UpdateDeviceModeButtonMaps(buttonMaps)

    # Get remote config file for the specified remote and write it to the
    # specified filename.
    def GetConfig(self, remote, filename):
        remoteId = self.client.factory.create('{' + DATA_NS + '}Id')
        remoteId.IsPersisted = remote.Id.IsPersisted
        remoteId.Value = remote.Id.Value

        compile = self.client.service['CompileManager'].StartCompileWithLocale(
            remoteId, "Not Implemented")
        url = urlparse.urlparse(compile.DownloadUrl)
        match = re.search('CompilationId=(.+)', compile.DownloadUrl)
        compilationId = match.group(1)
        compilationIdString = '<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">' + compilationId + '</string>'
        maxAttempts = 15
        count = 0
        while (count < maxAttempts):
            newUrl = "http://" + url.netloc + url.path + "?" + str(uuid.uuid4())
            httpRequest = urllib2.Request(newUrl, compilationIdString,
                                          {"Content-Type": "text/xml"})
            self.client.options.transport.cookiejar.add_cookie_header(
                httpRequest)
            fp = urllib2.urlopen(httpRequest)
            rawfile = fp.read()
            response = rawfile.decode('ascii', 'ignore')
            status = re.search(
                '<RemoteConfiguration status=\'Successful\' length=\'.+\'/>',
                response)
            if status is not None:
                file = rawfile[status.end():]
                outputFile = open(filename, 'wb')
                outputFile.write(file)
                outputFile.close()
                break
            else:
                # Give server time to respond.
                time.sleep(4)
                count += 1
        if count == maxAttempts:
            raise Exception("Failed to download config file")

    def GetAccountForRemote(self, remoteId):
        for account in self.household.Accounts.Account:
            if account.Remotes != "":
                for remote in account.Remotes.Remote:
                    if (remote.Id.IsPersisted == remoteId.IsPersisted) and \
                            (remote.Id.Value == remoteId.Value):
                        return account
        return None

    def GetAccountIdForDevice(self, deviceId):
        for account in self.household.Accounts.Account:
            if account.Devices != "":
                for device in account.Devices.Device:
                    if (device.Id.IsPersisted == deviceId.IsPersisted) and \
                            (device.Id.Value == deviceId.Value):
                        return account.Id
        return None

    def GetDevices(self, remoteId):
        self.GetHousehold()
        account = self.GetAccountForRemote(remoteId)
        if account.Devices != "":
            deviceIds = self.client.factory.create('{' + DATA_NS + '}deviceIds')
            for device in account.Devices.Device:
                deviceIds.DeviceId.append(device.Id)
            return self.client.service['DeviceManager'].GetDevices(
                deviceIds).Device
        else:
            return None

    def DeleteDevice(self, deviceId):
        self.GetHousehold()
        accountId = self.GetAccountIdForDevice(deviceId)
        deviceIds = self.client.factory.create('{' + DATA_NS + '}deviceIds')
        deviceIds.DeviceId.append(deviceId)
        return self.client.service['DeletionManager'].DeleteDevices(accountId,
                                                                    deviceIds)

    def SearchDevices(self, manufacturer, modelNumber, maxResults):
        return self.client.service['DeviceManager'].SearchGlobalDevices(
            manufacturer, modelNumber, "Unknown", "DidYouMeanMatch", maxResults)

    def AddDevice(self, device, remoteId):
        self.GetHousehold()
        operation = self.client.factory.create(
            '{' + DM_OPERATION_NS + '}AddDeviceBySearchResultOperation'
        )
        operation.ParentAccount = self.GetAccountForRemote(remoteId).Id
        operation.ReturnIdAsKey = str(uuid.uuid4())
        operation.DeviceClassification = "Any"
        operation.DeviceName = device.Manufacturer + " " + device.DeviceModel
        operation.IsScartCableSupported = "false"
        operation.Match = device
        operation.PrivateAddTypeUsed = "NotApplicable"
        return self.client.service['DeviceManager'].UpdateMyData(operation)

    def RenameDevice(self, deviceId, newName):
        self.GetHousehold()
        operation = self.client.factory.create(
            '{' + DM_OPERATION_NS + '}UpdateDeviceNameOperation'
        )
        id = self.client.factory.create('{' + DATA_NS + '}Id')
        id.IsPersisted = deviceId.IsPersisted
        id.Value = deviceId.Value
        operation.ParentAccount = self.GetAccountIdForDevice(deviceId)
        operation.DeviceId = id
        operation.DeviceName = newName
        return self.client.service['DeviceManager'].UpdateMyData(operation)

    # Returns 'None' on success.  Otherwise returns a string with an error msg.
    # Parameter is an instance of MHAccountDetails.
    def CreateAccount(self, details):
        host = "setup.myharmony.com"
        url = "https://setup.myharmony.com/MartiniWeb/Account/Register"
        params = urllib.urlencode(
            {'FirstName': details.firstName, 'LastName': details.lastName,
             'ctl00$MainContent$selectCountry': '- Select Country -',
             'region': details.country, 'Emailaddress': details.email,
             'Password': details.password, 'RetypePassword': details.password,
             'securityquestion': details.securityQuestion,
             'Securityanswer': details.securityAnswer,
             'IsPolicyAccepted': 'true',
             'Keepmeinformed': details.keepMeInformed})
        headers = {"Content-type": "application/x-www-form-urlencoded"}
        conn = httplib.HTTPSConnection(host)
        conn.request("POST", url, params, headers)
        response = conn.getresponse()
        data = response.read()
        conn.close()
        # We get a redirect response (code 302) on success.  Return.
        if response.status == 302:
            return None
        # Check for field validation errors.
        parser = CreateAccountResponseHTMLParser()
        parser.feed(data)
        if parser.error != "":
            return parser.error
        else:
            return "Unknown Error"

    # Returns an instance of MHAccountDetails with the existing account's
    # details filled in.
    def GetAccountDetails(self):
        details = MHAccountDetails()
        self.GetHousehold()
        properties = self.household.Accounts.Account[0].Properties
        passwordQuestion = self.client.service['AccountManager']. \
            GetPasswordQuestion(properties.Email)
        details.firstName = properties.FirstName
        details.lastName = properties.LastName
        details.country = properties.CountryType
        details.email = properties.Email
        details.password = self.password
        details.securityQuestion = passwordQuestion.PasswordQuestion
        details.securityAnswer = None
        details.keepMeInformed = properties.ContactMe
        return details

    # Updates an account with the provided details, which should be an instance
    # of MHAccountDetails.
    def UpdateAccountDetails(self, details):
        randGen = random.SystemRandom()
        nonce = randGen.randint(100000000,2000000000)
        handshakeResult = self.client.service['AccountManager']. \
            SecureControllerHandshake(nonce)
        if handshakeResult is None:
            print "SecureControllerHandshake failed."
            return False

        accountId = self.household.Accounts.Account[0].Id
        properties = self.client.factory.create('{' + ACCOUNT_NS
                                                + '}Properties')
        properties.ContactMe = details.keepMeInformed
        properties.CountryType = details.country
        properties.Email = details.email
        properties.FirstName = details.firstName
        properties.IsPolicyAccepted = "true"
        properties.LastName = details.lastName
        properties.UserKey = \
            self.household.Accounts.Account[0].Properties.UserKey
        result = self.client.service['AccountManager']. \
            SecureUpdateAccountProperties(accountId, properties,
                                          handshakeResult.Challenge)
        if result is not None:
            print "SecureUpdateAccountProperties failed: " + str(result)
            return False

        if details.securityAnswer != "":
            result = self.client.service['AccountManager']. \
                UpdatePasswordQuestionAndAnswer(self.password,
                                                details.securityQuestion,
                                                details.securityAnswer)
            if result != "true":
                print "UpdatePasswordQuestionAndAnswer failed: " + str(result)
                return False

        if details.password != self.password:
            result = self.client.service['AccountManager']. \
                UpdatePasswordByOldPassword(details.email, self.password,
                                            details.password)
            if result != "true":
                print "UpdatePasswordByOldPassword failed: " + str(result)
                return False
            self.password = details.password

        return True

    def GetCountryLists(self):
        conn = httplib.HTTPSConnection("setup.myharmony.com")
        conn.request("GET", "https://setup.myharmony.com/Account/Register")
        response = conn.getresponse()
        data = unicode(response.read(), 'utf-8')
        parser = CountryListHTMLParser()
        parser.feed(parser.unescape(data))
        return [parser.country_codes, parser.countries]

    def AddRemote(self, serialNumber, skinId, usbPid, usbVid):
        self.GetHousehold()
        accountId = None
        for account in self.household.Accounts.Account:
            if account.Remotes is None or account.Remotes == "":
                accountId = account.Id
                break
        if accountId is None:
            result = self.client.service['AccountManager']. \
                CreateNewAccountInMyHousehold()
            accountId = result.Id

        remoteInfo = self.client.factory.create(
            '{' + ACCOUNT_NS + '}remoteInfo')
        remoteInfo.AccountId = accountId
        remoteInfo.KeyPadLayout = "Undefined"
        remoteInfo.SerialNumber = serialNumber
        remoteInfo.SkinId = skinId
        remoteInfo.UsbPid = usbPid
        remoteInfo.UsbVid = usbVid
        return self.client.service['UserAccountDirector'].AddRemoteToAccount(
            remoteInfo)

    # Removes a remote from an account.
    def DeleteRemote(self, remoteId):
        account = self.GetAccountForRemote(remoteId)
        self.client.service['AccountManager'].RemoveAccountFromHousehold(
            account.Id)

    # Returns a set of the remote skins supported by this web interface.
    def GetSupportedRemoteSkinIds(self):
        products = self.client.service['ProductsManager'].GetHarmonyProducts()
        skinIds = set()
        for product in products.HarmonyProduct:
            skinIds.add(int(product.SkinId))
        return skinIds

    # Returns a list of the remote names supported by this web interface.
    def GetSupportedRemoteNames(self):
        products = self.client.service['ProductsManager'].GetHarmonyProducts()
        remoteNames = set()
        for product in products.HarmonyProduct:
            remoteNames.add(product.DisplayName)
        remoteNames = list(remoteNames)
        remoteNames.sort()
        return remoteNames

    def GetGlobalRemote(self, serialNumber):
        return self.client.service['RemoteManager'].GetGlobalRemote(
            serialNumber)

    # Gets the "Remote Name" for a given remoteId - used mainly for Harmony
    # Link to identity the room.
    def GetRemoteName(self, remoteId):
        remotes = self.GetRemotes()
        for remote in remotes:
            if remote.Id.Value == remoteId.Value:
                return remote.RemoteProperties.RemoteName
        return None

    # Sets the "Remote Name" - used for Harmony Link to identify the room where
    # the link is located
    def SetRemoteName(self, remoteId, remoteName):
        remoteProperties = self.client.factory.create('{' + ACCOUNT_NS
                                                      + '}RemoteProperties')
        remoteProperties.IsActiveRemote = True
        remoteProperties.IsLocked = False
        remoteProperties.RemoteName = remoteName
        result = self.client.service['RemoteManager'].SaveRemoteProperties(
            remoteId, remoteProperties)
        if result == "Successful":
            return True
        else:
            return False

    # Returns the recommended activities for a given remoteId.
    def GetRecommendedActivities(self, remoteId):
        account = self.GetAccountForRemote(remoteId)
        devices = self.GetDevices(remoteId)
        devicesWithCapabilities = \
            self.client.factory.create('{' + ACTIVITY_NS
                                       + '}DevicesWithCapabilities')
        for device in devices:
            deviceWithCapabilities = \
                self.client.factory.create('{' + ACTIVITY_NS +
                                           '}DeviceWithCapabilities')
            deviceWithCapabilities.DeviceId = device.Id
            deviceWithCapabilities.DeviceType = "Unknown"
            deviceWithCapabilities.PrioritizedCapabilities = \
                device.DeviceCapabilitiesWithPriority
            devicesWithCapabilities.DeviceWithCapabilities.append(
                deviceWithCapabilities)
        return self.client.service['ActivityManager'].\
            GetRecommendedActivitiesFromDevices(account.Id,
                                                devicesWithCapabilities)[0]

    def GetActivityTypeString(self, activityType):
        try:
            return ACTIVITY_TYPE_STRINGS[activityType]
        except:
            return activityType

    def GetRoleString(self, role):
        try:
            return ROLE_STRINGS[role]
        except:
            return role

    def GetActivityTypesAndRoles(self, accountId):
        print self.client.service['ActivityManager'].\
            GetActivityTypesAndRoles(accountId)

    def GetActivityRolesAndDevices(self, remoteId, activityType):
        account = self.GetAccountForRemote(remoteId)
        activityTypes = \
            self.client.factory.create('{' + ACTIVITY_NS + '}ActivityTypes')
        activityTypes.ActivityType.append(activityType)
        devices = self.GetDevices(remoteId)
        devicesWithCapabilities = \
            self.client.factory.create('{' + ACTIVITY_NS
                                       + '}DevicesWithCapabilities')
        for device in devices:
            deviceWithCapabilities = \
                self.client.factory.create('{' + ACTIVITY_NS +
                                           '}DeviceWithCapabilities')
            deviceWithCapabilities.DeviceId = device.Id
            deviceWithCapabilities.DeviceType = "Unknown"
            deviceWithCapabilities.PrioritizedCapabilities = \
                device.DeviceCapabilitiesWithPriority
            devicesWithCapabilities.DeviceWithCapabilities.append(
                deviceWithCapabilities)        
        return (self.client.service['ActivityManager'].GetActivityRoles(
            account.Id, activityTypes, devicesWithCapabilities).\
                KeyValueOfActivityTypeRoleToDeviceMapping_SFvkcgrh[0].Value.\
                Mapping.KeyValueOfAbstractActivityRoleArrayOfDeviceIdGQ_S527jd,
                devices)

    def GetActivityTemplate(self, remoteId, activityType):
        roles, devices = self.GetActivityRolesAndDevices(remoteId, activityType)
        activityTemplate = ActivityTemplate()
        deviceNames = {}
        activityTemplate.devices = []
        activityTemplate.devicesWithInputs = []
        activityTemplate.roles = []
        for device in devices:
            deviceNames[device.Id.Value] = device.Name
            activityTemplate.devices.append((device.Name, device.Id))
            inputNames = self.GetDeviceInputNames(device.Id)
            if inputNames:
                activityTemplate.devicesWithInputs.append(
                    (device.Name, device.Id, inputNames))
        for role in roles:
            roleType = role.Key.__class__.__name__
            if roleType != "PassThroughActivityRole":
                roleDevices = []
                for deviceId in role.Value.DeviceId:
                    roleDevices.append((deviceNames[deviceId.Value], deviceId))
                activityTemplate.roles.append((roleType, roleDevices))
        return activityTemplate

    # Returns the configured activities (if any) for a given remoteId
    def GetActivities(self, remoteId):
        accountId = self.GetAccountForRemote(remoteId).Id
        result = self.client.service['UserAccountDirector'].SimpleGetActivities(
            accountId)
        if result:
            return result.Activity
        return None

    # Returns the activity with the supplied name if it exists, None otherwise
    def GetActivity(self, remoteId, activityName):
        activities = self.GetActivities(remoteId)
        if activities is not None:
            for activity in activities:
                if activity.Name == activityName:
                    return activity
        return None

    # Creates a 'Roles' structure and returns it
    # deviceInfo is a list of (deviceId, selectedInputName)
    def CreateRoles(self, deviceInfo):
        roles = self.client.factory.create('{' + ACTIVITY_NS + '}Roles')
        deviceNum = 1
        for device in deviceInfo:
            deviceId, inputName = device
            role = self.client.factory.create(
                '{' + ACTIVITY_NS + '}PassThroughActivityRole')
            role.DeviceId = deviceId
            role.Id = None
            role.PowerOffOrder = deviceNum
            role.PowerOnOrder = deviceNum
            if inputName:
                role.SelectedInput = self.client.factory.create(
                    '{' + ACTIVITY_NS + '}SelectedInput')
                role.SelectedInput.Id = None
                role.SelectedInput.Name = inputName
            else:
                role.SelectedInput = None
            roles.AbstractActivityRole.append(role)
            deviceNum = deviceNum + 1
        return roles

    def CreateRolesByTemplate(self, saveActivityTemplate):
        roles = self.client.factory.create('{' + ACTIVITY_NS + '}Roles')
        for roleType, deviceId, inputName in saveActivityTemplate.roles:
            role = self.client.factory.create('{' + ACTIVITY_NS + '}' +
                                              roleType)
            role.DeviceId = deviceId
            role.Id = None
            if inputName:
                role.SelectedInput.Id = None
                role.SelectedInput.Name = inputName
            else:
                role.SelectedInput = None
            roles.AbstractActivityRole.append(role)
        return roles

    # Creates a WatchTV activity for 200/300 remotes
    # deviceInfo is a list of (deviceId, selectedInputName)
    def SaveWatchTVActivity(self, remoteId, deviceInfo, activity=None):
        accountId = self.GetAccountForRemote(remoteId).Id
        if not activity:
            activity = self.client.factory.create(
                '{' + ACTIVITY_NS + '}Activity')
            activity.AccountId = accountId
            activity.ActivityGroup = "VirtualGeneric"
            activity.ActivityOrder = "0"
            activity.DateCreated = datetime.datetime.min
            activity.DateModified = datetime.datetime.min
            activity.Id = None
            activity.IsDefault = False
            activity.IsTuningDefault = False
            activity.Name = "WatchTV"
            activity.State = "Setup"
            activity.Type = "WatchTV"
        activity.Roles = self.CreateRoles(deviceInfo)
        return self.SaveActivity(remoteId, activity)

    def SaveActivityByTemplate(self, remoteId, saveActivityTemplate, activity):
        accountId = self.GetAccountForRemote(remoteId).Id
        if not activity:
            activity = self.client.factory.create(
                '{' + ACTIVITY_NS + '}Activity')
            activity.AccountId = accountId
            activity.ActivityGroup = "VirtualGeneric"
            activity.ActivityOrder = "0"
            activity.DateCreated = datetime.datetime.min
            activity.DateModified = datetime.datetime.min
            activity.Id = None
            activity.IsDefault = False
            activity.IsTuningDefault = False
            activity.State = "Setup"
            activity.Type = saveActivityTemplate.activityType
        activity.Name = saveActivityTemplate.activityName
        activity.Roles = self.CreateRolesByTemplate(saveActivityTemplate)
        return self.SaveActivity(remoteId, activity)        

    # Saves the specified activity
    def SaveActivity(self, remoteId, activity):
        accountId = self.GetAccountForRemote(remoteId).Id
        activities = self.client.factory.create('{' + ACTIVITY_NS
                                                + '}Activities')
        activities.Activity.append(activity)
        return self.client.service['ActivityManager'].SaveActivities(
            accountId, activities)

    # Deletes the specified activity
    def DeleteActivity(self, activity):
        activityIds = self.client.factory.create('{' + DATA_NS + '}activityIds')
        activityIds.ActivityId.append(activity.Id)
        return self.client.service['ActivityManager'].DeleteActivities(
            activity.AccountId, activityIds)

    def GetRoleDeviceId(self, activity, roleType):
        for role in activity.Roles.AbstractActivityRole:
            if role.__class__.__name__ == roleType:
                return role.DeviceId
        return None

    def GetDeviceInput(self, activity, deviceId):
        for role in activity.Roles.AbstractActivityRole:
            if role.DeviceId.Value == deviceId.Value:
                return role.SelectedInput.Name
        return None

    def GetDeviceInputNames(self, deviceId):
        features = self.GetUserFeatures(deviceId)
        if features:
            for feature in features.DeviceFeature:
                try:
                    if feature.InputType == "Discrete" or \
                       feature.InputType == "MultiMethod":
                        inputNames = []
                        for input in feature.Inputs.Input:
                            inputNames.append(input.InputName)
                        return inputNames
                except:
                    continue
        return None

    def GetUserFeatures(self, deviceId):
        deviceIds = self.client.factory.create('{' + DATA_NS + '}deviceIds')
        deviceIds.DeviceId.append(deviceId)
        result = self.client.service['UserFeatureManager'].GetUserFeatures(
            deviceIds)
        if result:
            return result.KeyValueOfDeviceIdArrayOfDeviceFeatureeiEyJu8p[0].\
                Value
        return None

    def GetPowerFeature(self, deviceId):
        features = self.GetUserFeatures(deviceId)
        if features:
            for feature in features.DeviceFeature:
                if feature.__class__.__name__ == "PowerFeature":
                    return feature
        return None

    # This returns an array of tuples of (IRPressAction/IRDelayAction, Command,
    # Duration) for the given Power Feature Type (ie, pass in
    # powerFeature.PowerToggleActions)
    def GetPowerFeatureActions(self, powerFeatureType):
        if powerFeatureType and powerFeatureType.AbstractIRAction:
            actions = []
            for action in powerFeatureType.AbstractIRAction:
                if action.__class__.__name__ == "IRPressAction":
                    if action.Duration is None:
                        duration = "0"
                    else:
                        duration = action.Duration
                    actions.append(("IRPressAction", action.IRCommandName, 
                                    duration))
                elif action.__class__.__name__ == "IRDelayAction":
                    actions.append(("IRDelayAction", None, action.Delay))
            return actions
        else:
            return None

    # powerFeatureActions is an array of (IRPressAction/IRDelayAction, Command,
    # Duration); actionType is "PowerToggle", "PowerOn", etc.
    def SavePowerFeature(self, powerFeature, powerFeatureActions, actionType):
        ufActions = self.client.factory.create('{' + USER_FEATURE_NS +
                                             '}Actions')
        actionNum = 1
        for pfAction in powerFeatureActions:
            ufAction = None
            if pfAction[0] == "IRPressAction":
                ufAction = self.client.factory.create('{' + USER_FEATURE_NS +
                                                      '}IRPressAction')
                ufAction.ActionId = 0
                ufAction.Order = actionNum
                ufAction.Duration = pfAction[2]
                ufAction.IRCommandName = pfAction[1]
            elif pfAction[0] == "IRDelayAction":
                ufAction = self.client.factory.create('{' + USER_FEATURE_NS +
                                                      '}IRDelayAction')
                ufAction.ActionId = 3
                ufAction.Order = actionNum
                ufAction.Delay = pfAction[2]
            if ufAction is not None:
                ufActions.AbstractIRAction.append(ufAction)
                actionNum += 1

        if actionType == "PowerToggle":
            powerFeature.PowerToggleActions = ufActions
        elif actionType == "PowerOn":
            powerFeature.PowerOnActions = ufActions
        deviceFeatures = self.client.factory.create('{' + USER_FEATURE_NS
                                                    + '}DeviceFeatures')
        deviceFeatures.DeviceFeature.append(powerFeature)
        return self.client.service['UserFeatureManager'].SaveUserFeatures(
            deviceFeatures)

    # Adds a learned IR command (if the command name does not already exist) or
    # updates the IR command for the specified command name and device.
    def UpdateIRCommand(self, commandName, rawSequence, deviceId):
        result = self.client.service['InfraredAnalysisManager'].AnalyzeInfrared(
            None, rawSequence)
        try:
            result.KeyCode
        except:
            return "AnalyzeInfrared failed:" + str(result)

        operation = self.client.factory.create('{' + OPERATION_NS
                                               + '}OperationBag')
        operation.ParentAccount = self.GetAccountIdForDevice(deviceId)
        operation.Items.Operation = self.client.factory.create(
            '{' + DM_OPERATION_NS + '}AddCommandOperation'
        )
        operation.Items.Operation.ParentAccount = operation.ParentAccount
        operation.Items.Operation.DeviceId = deviceId
        operation.Items.Operation.KeyCode = result.KeyCode
        operation.Items.Operation.Name = commandName
        operation.Items.Operation.RawInfrared = rawSequence
        result = self.client.service['DeviceManager'].UpdateMultiple(operation)
        if result is None:
            return "UpdateMultiple failed"
        return None

    # Deletes an IR command (if it is a user-added one) or removes the override
    # if the command is an officially provided one.
    def DeleteIRCommand(self, commandId, deviceId):
        deviceIds = self.client.factory.create('{' + DATA_NS + '}deviceIds')
        deviceIds.DeviceId.append(deviceId)
        taughtCommandIds = self.client.factory.create('{' + ARRAYS_NS
                                                      + '}taughtCommandIds')
        taughtCommandIds.long = commandId.Value
        result = self.client.service['UserButtonMappingManager']. \
            DeleteTaughtDeviceModeCommandButtonMaps(deviceIds, taughtCommandIds)
        if result is not None:
            return "DeleteTaughtDeviceModeCommandButtonMaps:" + str(result)

        operation = self.client.factory.create('{' + OPERATION_NS
                                               + '}OperationBag')
        operation.ParentAccount = self.GetAccountIdForDevice(deviceId)
        operation.Items.Operation = self.client.factory.create(
            '{' + DM_OPERATION_NS + '}DeleteCommandOperation'
        )
        operation.Items.Operation.ParentAccount = operation.ParentAccount
        operation.Items.Operation.DeviceId = deviceId
        operation.Items.Operation.LanguageElementIds.long = commandId.Value
        result = self.client.service['DeviceManager'].UpdateMultiple(operation)
        if result is None:
            return "UpdateMultiple failed"
        return None

class ActivityTemplate:
    def __init__(self):
        self.devices = None # List of (Device Name, DeviceId)
        self.roles = None # List of (Role Name, [(Device Name, DeviceId), .. ]
        self.devicesWithInputs = None # [(Device Name, DeviceId, [Inputs])]

class SaveActivityTemplate:
    def __init__(self):
        self.activityName = None               # Activity Name (String)
        self.activityType = None               # ActivityType
        self.roles = None                      # [(Role Name, DeviceId, Input)]

class MHAccountDetails:
    def __init__(self):
        firstName = ""
        lastName = ""
        country = ""
        email = ""
        password = ""
        securityQuestion = ""
        securityAnswer = ""
        keepMeInformed = ""

class CreateAccountResponseHTMLParser(HTMLParser):
    def __init__(self):
        HTMLParser.__init__(self)
        self.save_data = False
        self.error = ""
    def handle_starttag(self, tag, attrs):
        for attr in attrs:
            if attr == ('class', 'field-validation-error'):
                self.save_data = True
    def handle_data(self, data):
        if self.save_data:
            self.error += data
            self.save_data = False

class CountryListHTMLParser(HTMLParser):
    def __init__(self):
        HTMLParser.__init__(self)
        self.in_country_section = False
        self.country_codes = []
        self.countries = []
        self.country_code = None
    def handle_starttag(self, tag, attrs):
        if tag == 'select' and ('id', 'region') in attrs and \
                ('name', 'region') in attrs:
            self.in_country_section = True
            return
        if self.in_country_section:
            if tag == 'option':
                for attr in attrs:
                    if attr[0] == 'value':
                        self.country_code = attr[1]
    def handle_data(self, data):
        if self.country_code is not None:
            self.country_codes.append(self.country_code)
            self.countries.append(data)
            self.country_code = None
    def handle_endtag(self, tag):
        if self.in_country_section and tag == 'select':
            self.in_country_section = False