~ursinha/launchpad/add-all-fl-tests

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
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
# Copyright 2009 Canonical Ltd.  This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).

# pylint: disable-msg=E0211,E0213

"""Interfaces related to the hardware database."""

__metaclass__ = type

__all__ = [
    'HWBus',
    'HWSubmissionFormat',
    'HWSubmissionKeyNotUnique',
    'HWSubmissionMissingFields',
    'HWSubmissionProcessingStatus',
    'IHWDBApplication',
    'IHWDevice',
    'IHWDeviceClass',
    'IHWDeviceClassSet',
    'IHWDeviceDriverLink',
    'IHWDeviceDriverLinkSet',
    'IHWDeviceNameVariant',
    'IHWDeviceNameVariantSet',
    'IHWDeviceSet',
    'IHWDriver',
    'IHWDriverName',
    'IHWDriverPackageName',
    'IHWDriverSet',
    'IHWSubmission',
    'IHWSubmissionBug',
    'IHWSubmissionBugSet',
    'IHWSubmissionForm',
    'IHWSubmissionSet',
    'IHWSubmissionDevice',
    'IHWSubmissionDeviceSet',
    'IHWSystemFingerprint',
    'IHWSystemFingerprintSet',
    'IHWVendorID',
    'IHWVendorIDSet',
    'IHWVendorName',
    'IHWVendorNameSet',
    'IllegalQuery',
    'ParameterError',
    ]

from zope.component import getUtility
from zope.interface import Interface, Attribute
from zope.schema import (
    ASCIILine, Bool, Bytes, Choice, Datetime, Int, List, TextLine)
from lazr.enum import DBEnumeratedType, DBItem

from canonical.launchpad import _
from lp.registry.interfaces.distribution import IDistribution
from lp.registry.interfaces.distroseries import IDistroSeries
from lp.registry.interfaces.person import IPerson
from lp.registry.interfaces.product import License
from lp.soyuz.interfaces.distroarchseries import IDistroArchSeries
from canonical.launchpad.interfaces.launchpad import IPrivacy
from canonical.launchpad.validators import LaunchpadValidationError
from canonical.launchpad.validators.name import valid_name
from canonical.launchpad.validators.email import valid_email
from canonical.launchpad.webapp.interfaces import ILaunchpadApplication

from lazr.restful.fields import CollectionField, Reference
from lazr.restful.interface import copy_field
from lazr.restful.declarations import (
    REQUEST_USER, call_with, export_as_webservice_entry,
    export_destructor_operation, export_read_operation,
    export_write_operation, exported, operation_parameters,
    operation_returns_collection_of, operation_returns_entry,
    webservice_error)


def validate_new_submission_key(submission_key):
    """Check, if submission_key already exists in HWDBSubmission."""
    if not valid_name(submission_key):
        raise LaunchpadValidationError(
            'Submission key can contain only lowercase alphanumerics.')
    submission_set = getUtility(IHWSubmissionSet)
    if submission_set.submissionIdExists(submission_key):
        raise LaunchpadValidationError(
            'Submission key already exists.')
    return True

def validate_email_address(emailaddress):
    """Validate an email address.

    Returns True for valid addresses, else raises LaunchpadValidationError.
    The latter allows convenient error handling by LaunchpadFormView.
    """
    if not valid_email(emailaddress):
        raise LaunchpadValidationError(
            'Invalid email address')
    return True

class HWSubmissionKeyNotUnique(Exception):
    """Prevent two or more submission with identical submission_key."""


class HWSubmissionMissingFields(Exception):
    """Indicate that the HWDB client sent incomplete data."""


class HWSubmissionProcessingStatus(DBEnumeratedType):
    """The status of a submission to the hardware database."""

    INVALID = DBItem(0, """
        Invalid submission

        The submitted data could not be parsed.
        """)

    SUBMITTED = DBItem(1, """
        Submitted

        The submitted data has not yet been processed.
        """)

    PROCESSED = DBItem(2, """
        Processed

        The submitted data has been processed.
        """)

class HWSubmissionFormat(DBEnumeratedType):
    """The format version of the submitted data."""

    VERSION_1 = DBItem(1, "Version 1")


class IHWSubmission(Interface, IPrivacy):
    """Raw submission data for the hardware database.

    See doc/hwdb.txt for details about the attributes.
    """
    export_as_webservice_entry()

    date_created = exported(
        Datetime(
            title=_(u'Date Created'), required=True, readonly=True))
    date_submitted = exported(
        Datetime(
            title=_(u'Date Submitted'), required=True, readonly=True))
    format = exported(
        Choice(
            title=_(u'Format Version'), required=True,
            vocabulary=HWSubmissionFormat, readonly=True))
    status = exported(
        Choice(
            title=_(u'Submission Status'), required=True,
            vocabulary=HWSubmissionProcessingStatus, readonly=True))
    # This is redefined from IPrivacy.private because the attribute is
    # is required.
    private = exported(
        Bool(
            title=_(u'Private Submission'), required=True))
    contactable = exported(
        Bool(
            title=_(u'Contactable'), required=True, readonly=True))
    submission_key = exported(
        TextLine(
            title=_(u'Unique Submission ID'), required=True, readonly=True))
    owner = exported(
        Reference(
            IPerson, title=_(u"The owner of this submission"), readonly=True))
    distroarchseries = Attribute(
        _(u'The DistroArchSeries'))
    raw_submission = exported(
        Bytes(title=_(u'The raw submission data'), required=True,
              readonly=True))
    system_fingerprint = Attribute(
        _(u'The system this submmission was made on'))
    raw_emailaddress = TextLine(
        title=_('Email address'), required=True)

    devices = exported(
        CollectionField(
            title=_(u"The HWSubmissionDevice records for this submission."),
            value_type=Reference(schema=Interface)))


class IHWSubmissionForm(Interface):
    """The schema used to build the HW submission form."""

    date_created = Datetime(
        title=_(u'Date Created'), required=True)
    format = Choice(
        title=_(u'Format Version'), required=True,
        vocabulary=HWSubmissionFormat)
    private = Bool(
        title=_(u'Private Submission'), required=True)
    contactable = Bool(
        title=_(u'Contactable'), required=True)
    submission_key = ASCIILine(
        title=_(u'Unique Submission Key'), required=True,
        constraint=validate_new_submission_key)
    emailaddress = TextLine(
            title=_(u'Email address'), required=True,
            constraint=validate_email_address)
    distribution = TextLine(
        title=_(u'Distribution'), required=True)
    distroseries = TextLine(
        title=_(u'Distribution Release'), required=True)
    architecture = TextLine(
        title=_(u'Processor Architecture'), required=True)
    system = TextLine(
        title=_(u'System name'), required=True)
    submission_data = Bytes(
        title=_(u'Submission data'), required=True)


class IHWSubmissionSet(Interface):
    """The set of HWDBSubmissions."""

    def createSubmission(date_created, format, private, contactable,
                         submission_key, emailaddress, distroarchseries,
                         raw_submission, filename, filesize, system):
        """Store submitted raw hardware information in a Librarian file.

        If a submission with an identical submission_key already exists,
        an HWSubmissionKeyNotUnique exception is raised."""

    def getBySubmissionKey(submission_key, user=None):
        """Return the submission with the given submission key, or None.

        If a submission is marked as private, it is only returned if
        user == HWSubmission.owner, of if user is an admin.
        """

    def getByFingerprintName(name, user=None):
        """Return the submissions for the given system fingerprint string.

        If a submission is marked as private, it is only returned if
        user == HWSubmission.owner, or if user is an admin.
        """

    def getByOwner(owner, user=None):
        """Return the submissions for the given person.

        If a submission is marked as private, it is only returned if
        user == HWSubmission.owner, or if user is an admin.
        """

    def submissionIdExists(submission_key):
        """Return True, if a record with ths ID exists, else return False."""

    def getByStatus(status, user=None):
        """Return the submissions with the given status.

        :param status: A status as enumerated in
            `HWSubmissionProcessingStatus`.
        :param user: The `IPerson` running the query.
        :return: The submissions having the given status.

        If no user is specified, only public submissions are returned.
        If a regular user is specified, public submissions and private
        submissions owned by the user are returned.
        For admins and for the janitor, all submissions with the given
        status are returned.
        """

    def search(user=None, device=None, driver=None, distribution=None,
               distroseries=None, architecture=None, owner=None):
        """Return the submissions matiching the given parmeters.

        :param user: The `IPerson` running the query. Private submissions
            are returned only if the person running the query is the
            owner or an admin.
        :param device: Limit results to submissions containing this
            `IHWDevice`.
        :param driver: Limit results to submissions containing devices
            that use this `IHWDriver`.
        :param distribution: Limit results to submissions made for
            this `IDistribution`.
        :param distroseries: Limit results to submissions made for
            this `IDistroSeries`.
        :param architecture: Limit results to submissions made for
            a specific architecture.
        :param owner: Limit results to submissions from this person.

        Only one of :distribution: or :distroseries: may be supplied.
        """

    def numSubmissionsWithDevice(bus=None, vendor_id=None, product_id=None,
                                 driver_name=None, package_name=None,
                                 distro_target=None):
        """Count the number of submissions mentioning a device or a driver.

        :return: A tuple (submissions_with_device, all_submissions)
            where submissions_with_device is the number of submissions having
            the given device or driver and matching the distro_target
            criterion and where all_submissions is the number of submissions
            matching the distro_target criterion.
        :param bus: The `HWBus` of the device (optional).
        :param vendor_id: The vendor ID of the device (optional).
        :param product_id: The product ID of the device (optional).
        :param driver_name: The name of the driver used for the device
            (optional).
        :param package_name: The name of the package the driver is a part of.
            (optional).
        :param distro_target: Limit the count to submissions made for the
            given distribution, distroseries or distroarchseries.
            (optional).

        At least each of bus, vendor_id, product_id must not be None or
        driver_name must not be None.
        """

    def numOwnersOfDevice(bus=None, vendor_id=None, product_id=None,
                          driver_name=None, package_name=None,
                          distro_target=None):
        """The number of people owning a device or using a driver.

        :return: A tuple (device_owners, all_hardware_reporters)
            where device_owners is the number of people who made a HWDB
            submission containing the given device or driver, optionally
            limited to submissions made for the given distro_target.
            all_hardware_reporters is the number of persons who made
            a HWDB submission, optionally limited to submission made
            on the given distro_target installation.
        :param bus: The `HWBus` of the device (optional).
        :param vendor_id: The vendor ID of the device (optional).
        :param product_id: The product ID of the device (optional).
        :param driver_name: The name of the driver used for the device
            (optional).
        :param package_name: The name of the package the driver is a part of.
            (optional).
        :param distro_target: Limit the count to submissions made for the
            given distribution, distroseries or distroarchseries.
            (optional).

        At least each of bus, vendor_id, product_id must not be None or
        driver_name must not be None.
        """

    def deviceDriverOwnersAffectedByBugs(
        bus=None, vendor_id=None, product_id=None, driver_name=None,
        package_name=None, bug_ids=None, bug_tags=None, affected_by_bug=False,
        subscribed_to_bug=False, user=None):
        """Return persons affected by given bugs and owning a given device.

        :param bus: The `HWBus` of the device.
        :param vendor_id: The vendor ID of the device.
        :param product_id: The product ID of the device.
        :param driver_name: Limit the search to devices controlled by the
            given driver.
        :param package_name: Limit the search to devices controlled by a
            driver from the given package.
        :param bug_ids: A sequence of bug IDs for which affected device
            owners are looked up.
        :param bug_tags: A sequence of bug tags.
        :param affected_by_bug: If True, those persons are looked up that
            have marked themselves as being affected by a one of the bugs
            matching the bug criteria.
        :param subscribed_to_bug: If True, those persons are looked up that
            are subscribed to a bug matching one of the bug criteria.
        :param user: The person making the query.

        `bug_ids` must be a non-empty sequence of bug IDs, or `bug_tags`
        must be a non-empty sequence of bug tags.

        The parameters `bus`, `vendor_id`, `product_id` must not be None, or
        `driver_name` must not be None.

        By default, only those persons are returned which have reported a
        bug matching the given bug conditions.

        Owners of private submissions are returned only if user is the
        owner of the private submission or if user is an admin.
        """

    def hwInfoByBugRelatedUsers(
        bug_ids=None, bug_tags=None, affected_by_bug=False,
        subscribed_to_bug=False, user=None):
        """Return a list of owners and devices related to given bugs.

        Actually returns a list of tuples where the tuple is of the form,
        (person name, bus name, vendor id, product id).`

        :param bug_ids: A sequence of bug IDs for which affected
            are looked up.
        :param bug_tags: A sequence of bug tags
        :param affected_by_bug: If True, those persons are looked up that
            have marked themselves as being affected by a one of the bugs
            matching the bug criteria.
        :param subscribed_to_bug: If True, those persons are looked up that
            are subscribed to a bug matching one of the bug criteria.
        :param user: The person making the query.
        """


class IHWSystemFingerprint(Interface):
    """Identifiers of a computer system."""

    fingerprint = Attribute(u'A unique identifier of a system')


class IHWSystemFingerprintSet(Interface):
    """The set of HWSystemFingerprints."""

    def getByName(fingerprint):
        """Lookup an IHWSystemFingerprint by its value.

        Return None, if a fingerprint `fingerprint` does not exist."""

    def createFingerprint(fingerprint):
        """Create an entry in the fingerprint list.

        Return the new entry."""

class IHWDriver(Interface):
    """Information about a device driver."""
    export_as_webservice_entry()

    id = exported(
        Int(title=u'Driver ID', required=True, readonly=True))

    package_name = exported(
        TextLine(
            title=u'Package Name', required=False,
            description=_("The name of the package written without spaces in "
                          "lowercase letters and numbers."),
            default=u''))

    name = exported(
        TextLine(
            title=u'Driver Name', required=True,
            description=_("The name of the driver written without spaces in "
                          "lowercase letters and numbers.")))

    license = exported(
        Choice(
            title=u'License of the Driver', required=False,
            vocabulary=License))
    @operation_parameters(
        distribution=Reference(
            IDistribution,
            title=u'A Distribution',
            description=
                u'If specified, the result set is limited to sumbissions '
                'made for the given distribution.',
            required=False),
        distroseries=Reference(
            IDistroSeries,
            title=u'A Distribution Series',
            description=
                u'If specified, the result set is limited to sumbissions '
                'made for the given distribution series.',
            required=False),
        architecture = TextLine(
            title=u'A processor architecture',
            description=
                u'If specified, the result set is limited to sumbissions '
                'made for the given architecture.',
            required=False),
        owner = copy_field(IHWSubmission['owner']))
    @operation_returns_collection_of(IHWSubmission)
    @export_read_operation()
    def getSubmissions(distribution=None, distroseries=None,
                       architecture=None, owner=None):
        """List all submissions which mention this driver.

        :param distribution: Limit results to submissions for this
            `IDistribution`.
        :param distroseries: Limit results to submissions for this
            `IDistroSeries`.
        :param architecture: Limit results to submissions for this
            architecture.
        :param owner: Limit results to submissions from this person.

        Only submissions matching all given criteria are returned.
        Only one of :distribution: or :distroseries: may be supplied.
        """


class IHWDriverSet(Interface):
    """The set of device drivers."""

    def create(package_name, name, license):
        """Create a new IHWDriver instance.

        :param package_name: The name of the packages containing the driver.
        :param name: The name of the driver.
        :param license: The license of the driver.
        :return: The new IHWDriver instance.
        """

    def getByPackageAndName(package_name, name):
        """Return an IHWDriver instance for the given parameters.

        :param package_name: The name of the packages containing the driver.
        :param name: The name of the driver.
        :return: An IHWDriver instance or None, if no record exists for
            the given parameters.
        """

    def getOrCreate(package_name, name, license=None):
        """Return an IHWDriver instance or create one.

        :param package_name: The name of the packages containing the driver.
        :param name: The name of the driver.
        :param license: The license of the driver.
        :return: An IHWDriver instance or None, if no record exists for
            the given parameters.
        """

    def search(package_name=None, name=None):
        """Return the drivers matching the given parameters.

        :param package_name: The name of the packages containing the driver.
            If package_name is not given or None, the result set is
            not limited to a specific package name.
            If package_name == '', those records are returned where
            record.package_name == '' or record.package_name is None.
            Otherwise only records matching the given name are returned.
        :param name: The name of the driver.
            If name is not given or None, the result set is not limited to
            a specific driver name.
            Otherwise only records matching the given name are returned.
        :return: A sequence of IHWDriver instances.
        """

    def getByID(id):
        """Return an IHWDriver record with the given database ID.

        :param id: The database ID.
        :return: An IHWDriver instance.
        """

    def all_driver_names():
        """Return all known distinct driver names appearing in HWDriver."""

    def all_package_names():
        """Return all known distinct package names appearing in HWDriver."""


class IHWDriverName(Interface):
    """A driver name as appearing in `IHWDriver`.
    """
    export_as_webservice_entry()

    name = exported(
        TextLine(
            title=u'Driver Name', required=True, readonly=True,
            description=_("The name of a driver as it appears in "
                          "IHWDriver.")))


class IHWDriverPackageName(Interface):
    """A driver name as appearing in `IHWDriver`.
    """
    export_as_webservice_entry()

    package_name = exported(
        TextLine(
            title=u'Package Name', required=True, readonly=True,
            description=_("The name of a package as it appears in "
                          "IHWDriver.")))


# Identification of a hardware device.
#
# In theory, a tuple (bus, vendor ID, product ID) should identify
# a device unambiguously. In practice, there are several cases where
# this tuple can identify more than one device:
#
# - A USB chip or chipset may be used in different devices.
#   A real world example:
#     - Plustek sold different scanner models with the USB ID
#       0x7b3/0x0017. Some of these scanners have for example a
#       different maximum scan size.
#
# Hence we identify a device by tuple (bus, vendor ID, product ID,
# variant). In the example above, we might use (HWBus.USB, '0x7b3',
# '0x0017', 'OpticPro UT12') and (HWBus.USB, '0x7b3', '0x0017',
# 'OpticPro UT16')

class HWBus(DBEnumeratedType):
    """The bus that connects a device to a computer."""

    SYSTEM = DBItem(0, 'System')

    PCI = DBItem(1, 'PCI')

    USB = DBItem(2, 'USB')

    IEEE1394 = DBItem(3, 'IEEE1394')

    SCSI = DBItem(4, 'SCSI')

    PARALLEL = DBItem(5, 'Parallel Port')

    SERIAL = DBItem(6, 'Serial port')

    IDE = DBItem(7, 'IDE')

    ATA = DBItem(8, 'ATA')

    FLOPPY = DBItem(9, 'Floppy')

    IPI = DBItem(10, 'IPI')

    SATA = DBItem(11, 'SATA')

    SAS = DBItem(12, 'SAS')

    PCCARD = DBItem(13, 'PC Card (32 bit)')

    PCMCIA = DBItem(14, 'PCMCIA (16 bit)')


class IHWVendorName(Interface):
    """A list of vendor names."""
    name = TextLine(title=u'Vendor Name', required=True)


class IHWVendorNameSet(Interface):
    """The set of vendor names."""
    def create(name):
        """Create and return a new vendor name.

        :return: A new IHWVendorName instance.

        An IntegrityError is raised, if the name already exists.
        """

    def getByName(name):
        """Return the IHWVendorName record for the given name.

        :param name: The vendor name.
        :return: An IHWVendorName instance where IHWVendorName.name==name
            or None, if no such instance exists.
        """


class IHWVendorID(Interface):
    """A list of vendor IDs for different busses associated with vendor names.
    """
    export_as_webservice_entry()
    id = exported(
        Int(title=u'The Database ID', required=True, readonly=True))

    bus = exported(
        Choice(
            title=u'The bus that connects a device to a computer',
            required=True, vocabulary=HWBus))

    vendor_id_for_bus = exported(
        TextLine(title=u'Vendor ID', required=True),
        exported_as='vendor_id')

    vendor_name = Attribute('Vendor Name')


class IHWVendorIDSet(Interface):
    """The set of vendor IDs."""
    def create(bus, vendor_id, name):
        """Create a vendor ID.

        :param bus: the HWBus instance for this bus.
        :param vendor_id: a string containing the bus ID. Numeric IDs
            are represented as a hexadecimal string, prepended by '0x'.
        :param name: The IHWVendorName instance with the vendor name.
        :return: A new IHWVendorID instance.
        """

    def getByBusAndVendorID(bus, vendor_id):
        """Return an IHWVendorID instance for the given bus and vendor_id.

        :param bus: An HWBus instance.
        :param vendor_id: A string containing the vendor ID. Numeric IDs
            must be represented as a hexadecimal string, prepended by '0x'.
        :return: The found IHWVendorID instance or None, if no instance
            for the given bus and vendor ID exists.
        """

    def get(id):
        """Return an IHWVendorID record with the given database ID.

        :param id: The database ID.
        :return: An IHWVendorID instance.
        """

    def idsForBus(bus):
        """Return all known IHWVendorID records with the given bus.

        :param bus: A HWBus instance.
        :return: A sequence of IHWVendorID instances.
        """


class IHWDeviceClass(Interface):
    """The capabilities of a device."""
    export_as_webservice_entry()

    id = Int(title=u'Device class ID', required=True, readonly=True)
    device = Reference(schema=Interface)
    main_class = exported(
        Int(
            title=u'The main class of this device', required=True,
            readonly=True))
    sub_class = exported(
        Int(
            title=u'The sub class of this device', required=False,
            readonly=True))

    @export_destructor_operation()
    def delete():
        """Delete this record."""


class IHWDeviceClassSet(Interface):
    """The set of IHWDeviceClass records."""

    def get(id):
        """Return an `IHWDeviceClass` record with the given database ID.

        :param id: The database ID.
        :return: An `IHWDeviceClass` instance.
        """


VENDOR_ID_DESCRIPTION = u"""Allowed values of the vendor ID depend on the
bus of the device.

Vendor IDs of PCI, PCCard and USB devices are hexadecimal string
representations of 16 bit integers in the format '0x01ab': The prefix
'0x', followed by exactly 4 digits; where a digit is one of the
characters 0..9, a..f. The characters A..F are not allowed.

SCSI vendor IDs are strings with exactly 8 characters. Shorter names are
right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.
"""

PRODUCT_ID_DESCRIPTION = u"""Allowed values of the product ID depend on the
bus of the device.

Product IDs of PCI, PCCard and USB devices are hexadecimal string
representations of 16 bit integers in the format '0x01ab': The prefix
'0x', followed by exactly 4 digits; where a digit is one of the
characters 0..9, a..f. The characters A..F are not allowed.

SCSI product IDs are strings with exactly 16 characters. Shorter names are
right-padded with space (0x20) characters.

IDs for other buses may be arbitrary strings.
"""


class IHWDevice(Interface):
    """Core information to identify a device."""
    export_as_webservice_entry()

    id = exported(
        Int(title=u'Device ID', required=True, readonly=True))

    bus_vendor = Attribute(u'Ths bus and vendor of the device')

    bus_product_id = exported(
        TextLine(title=u'The product identifier of the device',
                 required=True, description=PRODUCT_ID_DESCRIPTION))

    variant = exported(
        TextLine(title=u'A string that distiguishes different '
                        'devices with identical vendor/product IDs',
                 required=True))

    name = exported(
        TextLine(title=u'The human readable name of the device.',
                 required=True))

    submissions = Int(title=u'The number of submissions with the device',
                      required=True)

    bus = exported(
        Choice(title=u'The bus of the device.', vocabulary=HWBus,
               readonly=True))

    vendor_id = exported(
        TextLine(title=u'The vendor iD.', readonly=True,
                 description=VENDOR_ID_DESCRIPTION))

    vendor_name = exported(
        TextLine(title=u'The vendor name.', readonly=True))

    @operation_parameters(
        driver=Reference(
            IHWDriver,
            title=u'A driver used for this device in a submission',
            description=
                u'If specified, the result set is limited to sumbissions '
                'made for the given distribution, distroseries or '
                'distroarchseries.',
            required=False),
        distribution=Reference(
            IDistribution,
            title=u'A Distribution',
            description=
                u'If specified, the result set is limited to sumbissions '
                'made for the given distribution.',
            required=False),
        distroseries=Reference(
            IDistroSeries,
            title=u'A Distribution Series',
            description=
                u'If specified, the result set is limited to sumbissions '
                'made for the given distribution series.',
            required=False),
        architecture = TextLine(
            title=u'A processor architecture',
            description=
                u'If specified, the result set is limited to sumbissions '
                'made for the given architecture.',
            required=False),
        owner = copy_field(IHWSubmission['owner']))
    @operation_returns_collection_of(IHWSubmission)
    @export_read_operation()
    def getSubmissions(driver=None, distribution=None,
                       distroseries=None, architecture=None, owner=None):
        """List all submissions which mention this device.

        :param driver: Limit results to devices that use the given
            `IHWDriver`.
        :param distribution: Limit results to submissions for this
            `IDistribution`.
        :param distroseries: Limit results to submissions for this
            `IDistroSeries`.
        :param architecture: Limit results to submissions for this
            architecture.
        :param owner: Limit results to submissions from this person.

        Only submissions matching all given criteria are returned.
        Only one of :distribution: or :distroseries: may be supplied.
        """

    drivers = exported(
        CollectionField(
            title=_(u"The IHWDriver records related to this device."),
            value_type=Reference(schema=IHWDriver)))

    classes = exported(
        CollectionField(
            title=_(u"The device classes this device belongs to."),
            value_type=Reference(schema=IHWDeviceClass)))

    @operation_parameters(
        main_class=copy_field(IHWDeviceClass['main_class']),
        sub_class=copy_field(IHWDeviceClass['sub_class']))
    @export_write_operation()
    @operation_returns_entry(IHWDeviceClass)
    def getOrCreateDeviceClass(main_class, sub_class=None):
        """Return an `IHWDeviceClass` record or create a new one.

        :param main_class: The main class to be added.
        :param sub_class: The sub-class to added (otpional).
        :return: An `IHWDeviceClass` record.

        main_class and sub_class are integers specifying the class
        of the device, or, in the case of USB devices, the class
        of an interface.

        `IHWDeviceClass` records must be unique; if this method is called
        to create a new record with data of an already existing record,
        the existing record is returned.
        """

    @operation_parameters(
        main_class=copy_field(IHWDeviceClass['main_class']),
        sub_class=copy_field(IHWDeviceClass['sub_class']))
    @export_write_operation()
    def removeDeviceClass(main_class, sub_class=None):
        """Add an `IHWDeviceClass` record.

        :param main_class: The main class to be added.
        :param sub_class: The sub-class to added.
        """


# Fix cyclic reference.
IHWDeviceClass['device'].schema = IHWDevice


class IHWDeviceSet(Interface):
    """The set of devices."""

    def create(bus, vendor_id, product_id, product_name, variant=None):
        """Create a new device entry.

        :param bus: A bus name as enumerated in HWBus.
        :param vendor_id: The vendor ID for the bus.
        :param product_id: The product ID.
        :param product_name: The human readable product name.
        :param variant: A string that allows to distinguish different devices
                        with identical product/vendor IDs.
        :return: A new IHWDevice instance.
        """

    def getByDeviceID(bus, vendor_id, product_id, variant=None):
        """Return an IHWDevice record.

        :param bus: The bus name of the device as enumerated in HWBus.
        :param vendor_id: The vendor ID of the device.
        :param product_id: The product ID of the device.
        :param variant: A string that allows to distinguish different devices
                        with identical product/vendor IDs.
        :return: An IHWDevice instance.
        """

    def getOrCreate(bus, vendor_id, product_id, product_name, variant=None):
        """Return an IHWDevice record or create one.

        :param bus: The bus name of the device as enumerated in HWBus.
        :param vendor_id: The vendor ID of the device.
        :param product_id: The product ID of the device.
        :param product_name: The human readable product name.
        :param variant: A string that allows to distinguish different devices
                        with identical product/vendor IDs.
        :return: An IHWDevice instance.

        Return an existing IHWDevice record matching the given
        parameters or create a new one, if no existing record
        matches.
        """

    def getByID(self, id):
        """Return an IHWDevice record with the given database ID.

        :param id: The database ID.
        :return: An IHWDevice instance.
        """

    def search(bus, vendor_id, product_id=None):
        """Return HWDevice records matching the given parameters.

        :param vendor_id: The vendor ID of the device.
        :param product_id: The product ID of the device.
        :return: A sequence of IHWDevice instances.
        """


class IHWDeviceNameVariant(Interface):
    """Variants of a device name.

    We identify devices by (bus, vendor_id, product_id[, variant]),
    but many OEM products are sold by different vendors under different
    names. Users might want to look up device data by giving the
    vendor and product name as seen in a store; this table provides
    the "alias names" required for such a lookup.
    """
    vendor_name = Attribute(u'Vendor Name')

    product_name = TextLine(title=u'Product Name', required=True)

    device = Attribute(u'The device which has this name')

    submissions = Int(
        title=u'The number of submissions with this name variant',
        required=True)


class IHWDeviceNameVariantSet(Interface):
    """The set of device name variants."""

    def create(device, vendor_name, product_name):
        """Create a new IHWDeviceNameVariant instance.

        :param device: An IHWDevice instance.
        :param vendor_name: The alternative vendor name for the device.
        :param product_name: The alternative product name for the device.
        :return: The new IHWDeviceNameVariant.
        """


class IHWDeviceDriverLink(Interface):
    """Link a device with a driver."""

    device = Attribute(u'The Device.')

    driver = Attribute(u'The Driver.')


class IHWDeviceDriverLinkSet(Interface):
    """The set of device driver links."""

    def create(device, driver):
        """Create a new IHWDeviceDriver instance.

        :param device: The IHWDevice instance to be linked.
        :param driver: The IHWDriver instance to be linked.
        :return: The new IHWDeviceDriver instance.
        """

    def getByDeviceAndDriver(device, driver):
        """Return an IHWDeviceDriver instance.

        :param device: An IHWDevice instance.
        :param driver: An IHWDriver instance.
        :return: The IHWDeviceDriver instance matching the given
            parameters or None, if no existing instance matches.
        """
    def getOrCreate(device, driver):
        """Return an IHWDeviceDriverLink record or create one.

        :param device: The IHWDevice instance to be linked.
        :param driver: The IHWDriver instance to be linked.
        :return: An IHWDeviceDriverLink instance.

        Return an existing IHWDeviceDriverLink record matching te given
        parameters or create a new one, if no exitsing record
        matches.
        """


class IHWSubmissionDevice(Interface):
    """Link a submission to a IHWDeviceDriver row."""
    export_as_webservice_entry()

    id = exported(
        Int(title=u'HWSubmissionDevice ID', required=True, readonly=True))

    device_driver_link = Attribute(u'A device and driver appearing in a '
                                    'submission.')

    submission = Attribute(u'The submission the device and driver are '
                            'mentioned in.')

    parent = exported(
        # This is a reference to IHWSubmissionDevice itself, but we can
        # access the class only when the class has been defined.
        Reference(Interface, required=True))

    hal_device_id = exported(
        Int(
            title=u'The ID of the HAL node of this device in the submitted '
                'data',
            required=True))

    device = exported(
        Reference(
            IHWDevice,
            title=u'The device'))

    driver = exported(
        Reference(
            IHWDriver,
            title=u'The driver used for this device in this submission'))


# Fix cyclic references.
IHWSubmissionDevice['parent'].schema = IHWSubmissionDevice
IHWSubmission['devices'].value_type.schema = IHWSubmissionDevice


class IHWSubmissionDeviceSet(Interface):
    """The set of IHWSubmissionDevices."""

    def create(device_driver_link, submission, parent):
        """Create a new IHWSubmissionDevice instance.

        :param device_driver_link: An IHWDeviceDriverLink instance.
        :param submission: The submission the device/driver combination
            is mentioned in.
        :param parent: The parent of this device in the device tree in
            the submission.
        :return: The new IHWSubmissionDevice instance.
        """

    def getDevices(submission):
        """Return the IHWSubmissionDevice records of a submission

        :return: A sequence of IHWSubmissionDevice records.
        :param submission: An IHWSubmission instance.
        """

    def get(id):
        """Return an IHWSubmissionDevice record with the given database ID.

        :param id: The database ID.
        :return: An IHWSubmissionDevice instance.
        """

    def numDevicesInSubmissions(
        bus=None, vendor_id=None, product_id=None, driver_name=None,
        package_name=None, distro_target=None):
        """Count how often a device or a driver appears in HWDB submissions.

        :return: The number how often the given device appears in HWDB
            submissions.
        :param bus: The `HWBus` of the device (optional).
        :param vendor_id: The vendor ID of the device (optional).
        :param product_id: The product ID of the device (optional).
        :param driver_name: Limit the count to devices controlled by the given
            driver (optional).
        :param package_name: Limit the count to devices controlled by a driver
            from the given package (optional).
        :param distro_target: Limit the count to devices appearing in HWDB
            submissions made for the given distribution, distroseries
            or distroarchseries (optional).

        At least each of bus, vendor_id, product_id must not be None or
        driver_name must not be None.
        """


class IHWSubmissionBug(Interface):
    """Link a HWDB submission to a bug."""

    submission = Attribute(u'The HWDB submission referenced in a bug '
                              'report.')

    bug = Attribute(u'The bug the HWDB submission is referenced in.')


class IHWSubmissionBugSet(Interface):
    """The set of IHWSubmissionBugs."""

    def create(hwsubmission, bug):
        """Create a new IHWSubmissionBug instance.

        :return: The new IHWSubmissionBug instance.
        :param hwsubmission: An IHWSubmission instance.
        :param bug: An IBug instance.
        """

    def remove(hwsubmission, bug):
        """Remove the link between `hwsubmission` and `bug`.

        :param hwsubmission: An IHWSubmission instance.
        :param bug: An IBug instance.
        """

    def submissionsForBug(bug, user=None):
        """Return the HWDB submissions linked to the bug `bug`.

        :return: A sequence of HWDB submissions linked to `bug`.
        :param user: The user making the request.

        Only those submissions are returned which the user can access.
        Public submissions are always included; private submisisons only
        if the user is the owner or an admin.
        """


class IHWDBApplication(ILaunchpadApplication):
    """Hardware database application application root."""

    export_as_webservice_entry('hwdb')

    @operation_parameters(
        bus=Choice(
            title=u'The device bus', vocabulary=HWBus, required=True),
        vendor_id=TextLine(
            title=u'The vendor ID', required=True,
            description=VENDOR_ID_DESCRIPTION),
        product_id=TextLine(
            title=u'The product ID', required=False,
            description=PRODUCT_ID_DESCRIPTION))
    @operation_returns_collection_of(IHWDevice)
    @export_read_operation()
    def devices(bus, vendor_id, product_id=None):
        """Return the set of devices."""

    @operation_parameters(
        package_name=TextLine(
            title=u'The name of the package containing the driver.',
            required=False,
            description=
                u'If package_name is omitted, all driver records '
                'returned, optionally limited to those matching the '
                'parameter name. If package_name is '' (empty string), '
                'those records are returned where package_name is '' or '
                'None.'),
        name=TextLine(
            title=u'The name of the driver.', required=False,
            description=
                u'If name is omitted, all driver records are '
                'returned, optionally limited to those matching the '
                'parameter package_name.'))
    @operation_returns_collection_of(IHWDriver)
    @export_read_operation()
    def drivers(package_name=None, name=None):
        """Return the set of drivers."""

    @operation_parameters(
        bus=Choice(
            title=u'A Device Bus.', vocabulary=HWBus, required=True))
    @operation_returns_collection_of(IHWVendorID)
    @export_read_operation()
    def vendorIDs(bus):
        """Return the known vendor IDs for the given bus.

        :param bus: A `HWBus` value.
        :return: A list of strings with vendor IDs fr this bus,
        """

    driver_names = exported(
        CollectionField(
            title=u'Driver Names',
            description=
                u'All known distinct driver names appearing in HWDriver',
            value_type=Reference(schema=IHWDriverName),
            readonly=True))

    package_names = exported(
        CollectionField(
            title=u'Package Names',
            description=
                u'All known distinct package names appearing in HWDriver.',
            value_type=Reference(schema=IHWDriverPackageName),
            readonly=True))

    @operation_parameters(
        bus=Choice(
            title=u'The device bus', vocabulary=HWBus, required=False),
        vendor_id=TextLine(
            title=u'The vendor ID', description=VENDOR_ID_DESCRIPTION,
             required=False),
        product_id=TextLine(
            title=u'The product ID', description=PRODUCT_ID_DESCRIPTION,
            required=False),
        driver_name=TextLine(
            title=u'A driver name', required=False,
            description=u'If specified, the count is limited to devices '
                        'controlled by this driver.'),
        package_name=TextLine(
            title=u'A package name', required=False,
            description=u'If specified, the count is limited to devices '
                        u'controlled by a driver from this package.'),
        distribution=Reference(
            IDistribution,
            title=u'A Distribution',
            description=(
                u'If specified, the result set is limited to submissions '
                u'made for this distribution.'),
            required=False),
        distroseries=Reference(
            IDistroSeries,
            title=u'A Distribution Series',
            description=(
                u'If specified, the result set is limited to submissions '
                u'made for the given distribution series.'),
            required=False),
        distroarchseries=Reference(
            IDistroArchSeries,
            title=u'A Distribution Series',
            description=(
                u'If specified, the result set is limited to submissions '
                u'made for the given distroarchseries.'),
            required=False))
    @export_read_operation()
    def numSubmissionsWithDevice(
        bus=None, vendor_id=None, product_id=None, driver_name=None,
        package_name=None, distribution=None, distroseries=None,
        distroarchseries=None):
        """Count the number of submissions mentioning a device  or a driver.

        Returns a dictionary {'submissions_with_device: n1,
        'all_submissions': n2}, where submissions_with_device is the number
        of submissions having the given device or driver and matching the
        distro target criterion and where all_submissions is the number of
        submissions matching the distro target criterion.

        :param bus: The `HWBus` of the device (optional).
        :param vendor_id: The vendor ID of the device (optional).
        :param product_id: The product ID of the device (optional).
        :param driver_name: The name of the driver used for the device
            (optional).
        :param package_name: The name of the package the driver is a part of.
            (optional).
        :param distribution: Limit the count to submissions made for the
            given distribution, distroseries or distroarchseries.
            (optional).
        :param distroseries: Limit the count to submissions made for the
            given distroseries.
            (optional).
        :param distroarchseries: Limit the count to submissions made for the
            given distroarchseries.
            (optional).

        You may specify at most one of the parameters distribution,
        distroseries or distroarchseries.

        At least each of bus, vendor_id, product_id must not be None or
        driver_name must not be None.
        """

    @operation_parameters(
        bus=Choice(
            title=u'The device bus', vocabulary=HWBus, required=False),
        vendor_id=TextLine(
            title=u'The vendor ID', description=VENDOR_ID_DESCRIPTION,
             required=False),
        product_id=TextLine(
            title=u'The product ID', description=PRODUCT_ID_DESCRIPTION,
            required=False),
        driver_name=TextLine(
            title=u'A driver name', required=False,
            description=u'If specified, the count is limited to devices '
                        u'controlled by this driver.'),
        package_name=TextLine(
            title=u'A package name', required=False,
            description=u'If specified, the count is limited to devices '
                        u'controlled by a driver from this package.'),
        distribution=Reference(
            IDistribution,
            title=u'A Distribution',
            description=(
                u'If specified, the result set is limited to submissions '
                u'made for this distribution.'),
            required=False),
        distroseries=Reference(
            IDistroSeries,
            title=u'A Distribution Series',
            description=(
                u'If specified, the result set is limited to submissions '
                u'made for the given distribution series.'),
            required=False),
        distroarchseries=Reference(
            IDistroArchSeries,
            title=u'A Distribution Series',
            description=(
                u'If specified, the result set is limited to submissions '
                u'made for the given distroarchseries.'),
            required=False))
    @export_read_operation()
    def numOwnersOfDevice(
        bus=None, vendor_id=None, product_id=None, driver_name=None,
        package_name=None, distribution=None, distroseries=None,
        distroarchseries=None):
        """The number of people owning a device or using a driver.

        Returns a dictionary {'owners': n1, 'all_submitters': n2}
        where owners is the number of people who made a HWDB
        submission containing the given device or driver, optionally
        limited to submissions made for the given distro target.
        all_submitters is the number of persons who made
        a HWDB submission, optionally limited to submission made
        on the given distro target installation.

        :param bus: The `HWBus` of the device (optional).
        :param vendor_id: The vendor ID of the device (optional).
        :param product_id: The product ID of the device (optional).
        :param driver_name: The name of the driver used for the device
            (optional).
        :param package_name: The name of the package the driver is a part of.
            (optional).
        :param distribution: Limit the count to submissions made for the
            given distribution, distroseries or distroarchseries.
            (optional).
        :param distroseries: Limit the count to submissions made for the
            given distroseries.
            (optional).
        :param distroarchseries: Limit the count to submissions made for the
            given distroarchseries.
            (optional).

        You may specify at most one of the parameters distribution,
        distroseries or distroarchseries.

        At least each of bus, vendor_id, product_id must not be None or
        driver_name must not be None.
        """

    @operation_parameters(
        bus=Choice(
            title=u'The device bus', vocabulary=HWBus, required=False),
        vendor_id=TextLine(
            title=u'The vendor ID', description=VENDOR_ID_DESCRIPTION,
             required=False),
        product_id=TextLine(
            title=u'The product ID', description=PRODUCT_ID_DESCRIPTION,
            required=False),
        driver_name=TextLine(
            title=u'A driver name', required=False,
            description=u'If specified, the count is limited to devices '
                        u'controlled by this driver.'),
        package_name=TextLine(
            title=u'A package name', required=False,
            description=u'If specified, the count is limited to devices '
                        u'controlled by a driver from this package.'),
        distribution=Reference(
            IDistribution,
            title=u'A Distribution',
            description=(
                u'If specified, the result set is limited to submissions '
                u'made for this distribution.'),
            required=False),
        distroseries=Reference(
            IDistroSeries,
            title=u'A Distribution Series',
            description=(
                u'If specified, the result set is limited to submissions '
                u'made for the given distribution series.'),
            required=False),
        distroarchseries=Reference(
            IDistroArchSeries,
            title=u'A Distribution Series',
            description=(
                u'If specified, the result set is limited to submissions '
                u'made for the given distroarchseries.'),
            required=False))
    @export_read_operation()
    def numDevicesInSubmissions(
        bus=None, vendor_id=None, product_id=None, driver_name=None,
        package_name=None, distribution=None, distroseries=None,
        distroarchseries=None):
        """Count how often a device or a driver appears in HWDB submissions.

        :return: The number how often the given device appears in HWDB
            submissions.
        :param bus: The `HWBus` of the device (optional).
        :param vendor_id: The vendor ID of the device (optional).
        :param product_id: The product ID of the device (optional).
        :param driver_name: Limit the count to devices controlled by the given
            driver (optional).
        :param package_name: Limit the count to devices controlled by a driver
            from the given package (optional).
        :param distribution: Limit the count to submissions made for the
            given distribution, distroseries or distroarchseries.
            (optional).
        :param distroseries: Limit the count to submissions made for the
            given distroseries.
            (optional).
        :param distroarchseries: Limit the count to submissions made for the
            given distroarchseries.
            (optional).

        You may specify at most one of the parameters distribution,
        distroseries or distroarchseries.

        At least each of bus, vendor_id, product_id must not be None or
        driver_name must not be None.
        """

    @operation_parameters(
        bus=Choice(
            title=u'The device bus', vocabulary=HWBus, required=False),
        vendor_id=TextLine(
            title=u'The vendor ID', description=VENDOR_ID_DESCRIPTION,
             required=False),
        product_id=TextLine(
            title=u'The product ID', description=PRODUCT_ID_DESCRIPTION,
            required=False),
        driver_name=TextLine(
            title=u'A driver name', required=False,
            description=u'If specified, the search is limited to devices '
                        u'controlled by this driver.'),
        package_name=TextLine(
            title=u'A package name', required=False,
            description=u'If specified, the search is limited to devices '
                        u'controlled by a driver from this package.'),
        bug_ids=List(title=u'A set of bug IDs',
             description=u'Search submitters, subscribers or affected users '
                         u'of bugs with these IDs.',
             value_type=Int(),
             required=False),
        bug_tags=List(title=u'A set of bug tags',
             description=u'Search submitters, subscribers or affected users '
                         u'of bugs having one of these tags.',
             value_type=TextLine(),
             required=False),
        affected_by_bug=Bool(
            title=u'Search for users affected by a bug',
            description=u'If true, those device owners are looked up which '
                        u'are affected by one of the selected bugs.',
            required=False),
        subscribed_to_bug=Bool(
            title=u'Search for users who subscribed to a bug',
            description=u'If true, those device owners are looked up which '
                        u'to one of the selected bugs.',
            required=False))
    @call_with(user=REQUEST_USER)
    @operation_returns_collection_of(IPerson)
    @export_read_operation()
    def deviceDriverOwnersAffectedByBugs(
        bus, vendor_id, product_id, driver_name=None, package_name=None,
        bug_ids=None, bug_tags=None, affected_by_bug=False,
        subscribed_to_bug=False, user=None):
        """Return persons affected by given bugs and owning a given device.

        :param bus: The `HWBus` of the device.
        :param vendor_id: The vendor ID of the device.
        :param product_id: The product ID of the device.
        :param driver_name: Limit the search to devices controlled by the
            given driver.
        :param package_name: Limit the search to devices controlled by a
            driver from the given package.
        :param bug_ids: A sequence of bug IDs for which affected
            are looked up.
        :param bug_tags: A sequence of bug tags
        :param affected_by_bug: If True, those persons are looked up that
            have marked themselves as being affected by a one of the bugs
            matching the bug criteria.
        :param subscribed_to_bug: If True, those persons are looked up that
            are subscribed to a bug matching one of the bug criteria.
        :param user: The person making the query.

        bug_ids must be a non-empty sequence of bug IDs, or bug_tags
        must be a non-empty sequence of bug tags.

        The parameters bus, vendor_id, product_id must not be None, or
        driver_name must not be None.

        By default, only those persons are returned which have reported a
        bug matching the given bug conditions.

        Owners of private submissions are returned only if user is the
        owner of the private submission or if user is an admin.
        """

    @operation_parameters(
        bug_ids=List(title=u'A set of bug IDs',
             description=u'Search for devices and their owners related to '
                         u'bugs with these IDs.',
             value_type=Int(),
             required=False),
        bug_tags=List(title=u'A set of bug tags',
             description=u'Search for devices and their owners related to '
                         u'bugs having one of these tags.',
             value_type=TextLine(),
             required=False),
        affected_by_bug=Bool(
            title=u'Search for users affected by a bug',
            description=u'If true, those device owners are looked up which '
                        u'are affected by one of the selected bugs.',
            required=False),
        subscribed_to_bug=Bool(
            title=u'Search for users who subscribed to a bug',
            description=u'If true, those device owners are looked up which '
                        u'to one of the selected bugs.',
            required=False))
    @call_with(user=REQUEST_USER)
    @export_read_operation()
    def hwInfoByBugRelatedUsers(
        bug_ids=None, bug_tags=None, affected_by_bug=False,
        subscribed_to_bug=False, user=None):
        """Return a list of owners and devices related to given bugs.

        Actually returns a list of tuples where the tuple is of the form,
        (person name, bus name, vendor id, product id).`

        :param bug_ids: A sequence of bug IDs for which affected
            are looked up.
        :param bug_tags: A sequence of bug tags
        :param affected_by_bug: If True, those persons are looked up that
            have marked themselves as being affected by a one of the bugs
            matching the bug criteria.
        :param subscribed_to_bug: If True, those persons are looked up that
            are subscribed to a bug matching one of the bug criteria.
        :param user: The person making the query.
        """


class IllegalQuery(Exception):
    """Exception raised when trying to run an illegal submissions query."""
    webservice_error(400) #Bad request.

class ParameterError(Exception):
    """Exception raised when a method parameter does not match a constrint."""
    webservice_error(400) #Bad request.