-
Notifications
You must be signed in to change notification settings - Fork 2k
/
get.py
3232 lines (2515 loc) · 110 KB
/
get.py
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
# encoding: utf-8
'''API functions for searching for and getting data from CKAN.'''
from __future__ import annotations
import uuid
import logging
import json
import socket
from typing import (Container, Optional,
Union, Any, cast, Type)
from ckan.common import config, asbool, aslist
import sqlalchemy
from sqlalchemy import text
import ckan
import ckan.lib.dictization
import ckan.logic as logic
import ckan.logic.action
import ckan.logic.schema
import ckan.lib.dictization.model_dictize as model_dictize
import ckan.lib.jobs as jobs
import ckan.lib.navl.dictization_functions
import ckan.model as model
import ckan.model.misc as misc
import ckan.plugins as plugins
import ckan.lib.search as search
from ckan.model.follower import ModelFollowingModel
from ckan.lib.search.query import solr_literal
import ckan.lib.plugins as lib_plugins
import ckan.lib.datapreview as datapreview
import ckan.authz as authz
from ckan.common import _
from ckan.types import ActionResult, Context, DataDict, Query, Schema
log = logging.getLogger('ckan.logic')
# Define some shortcuts
# Ensure they are module-private so that they don't get loaded as available
# actions in the action API.
_validate = ckan.lib.navl.dictization_functions.validate
_table_dictize = ckan.lib.dictization.table_dictize
_check_access = logic.check_access
NotFound = logic.NotFound
NotAuthorized = logic.NotAuthorized
ValidationError = logic.ValidationError
_get_or_bust = logic.get_or_bust
_select = sqlalchemy.sql.select
_or_ = sqlalchemy.or_
_and_ = sqlalchemy.and_
_func = sqlalchemy.func
_case = sqlalchemy.case
_null = sqlalchemy.null
@logic.validate(ckan.logic.schema.default_pagination_schema)
def package_list(context: Context, data_dict: DataDict) -> ActionResult.PackageList:
'''Return a list of the names of the site's datasets (packages).
:param limit: if given, the list of datasets will be broken into pages of
at most ``limit`` datasets per page and only one page will be returned
at a time (optional)
:type limit: int
:param offset: when ``limit`` is given, the offset to start
returning packages from
:type offset: int
:rtype: list of strings
'''
model = context["model"]
api = context.get("api_version", 1)
_check_access('package_list', context, data_dict)
package_table = model.package_table
col = (package_table.c["id"]
if api == 2 else package_table.c["name"])
query = _select(col)
query = query.where(_and_(
package_table.c["state"] == 'active',
package_table.c["private"] == False,
))
query = query.order_by(col)
limit = data_dict.get('limit')
if limit:
query = query.limit(limit)
offset = data_dict.get('offset')
if offset:
query = query.offset(offset)
## Returns the first field in each result record
return context["session"].scalars(
query
).all()
@logic.validate(ckan.logic.schema.default_package_list_schema)
def current_package_list_with_resources(
context: Context, data_dict: DataDict) -> ActionResult.CurrentPackageListWithResources:
'''Return a list of the site's datasets (packages) and their resources.
The list is sorted most-recently-modified first.
:param limit: if given, the list of datasets will be broken into pages of
at most ``limit`` datasets per page and only one page will be returned
at a time (optional)
:type limit: int
:param offset: when ``limit`` is given, the offset to start
returning packages from
:type offset: int
:param page: when ``limit`` is given, which page to return,
Deprecated: use ``offset``
:type page: int
:rtype: list of dictionaries
'''
limit = data_dict.get('limit')
offset = data_dict.get('offset', 0)
user = context['user']
if not 'offset' in data_dict and 'page' in data_dict:
log.warning('"page" parameter is deprecated. '
'Use the "offset" parameter instead')
page = data_dict['page']
if limit:
offset = (page - 1) * limit
else:
offset = 0
_check_access('current_package_list_with_resources', context, data_dict)
search = package_search(context, {
'q': '', 'rows': limit, 'start': offset,
'include_private': authz.is_sysadmin(user) })
return search.get('results', [])
def member_list(context: Context, data_dict: DataDict) -> ActionResult.MemberList:
'''Return the members of a group.
The user must have permission to 'get' the group.
:param id: the id or name of the group
:type id: string
:param object_type: restrict the members returned to those of a given type,
e.g. ``'user'`` or ``'package'`` (optional, default: ``None``)
:type object_type: string
:param capacity: restrict the members returned to those with a given
capacity, e.g. ``'member'``, ``'editor'``, ``'admin'``, ``'public'``,
``'private'`` (optional, default: ``None``)
:type capacity: string
:rtype: list of (id, type, capacity) tuples
:raises: :class:`ckan.logic.NotFound`: if the group doesn't exist
'''
_check_access('member_list', context, data_dict)
model = context['model']
group = model.Group.get(_get_or_bust(data_dict, 'id'))
if not group:
raise NotFound
obj_type = data_dict.get('object_type', None)
capacity = data_dict.get('capacity', None)
# User must be able to update the group to remove a member from it
_check_access('group_show', context, data_dict)
q = model.Session.query(model.Member)
if obj_type:
q = model.Member.all(obj_type)
q = q.filter(model.Member.group_id == group.id).\
filter(model.Member.state == "active")
if capacity:
q = q.filter(model.Member.capacity == capacity)
trans = authz.roles_trans()
def translated_capacity(capacity: str):
try:
return trans[capacity]
except KeyError:
return capacity
return [(m.table_id, m.table_name, translated_capacity(m.capacity))
for m in q.all()]
def package_collaborator_list(context: Context,
data_dict: DataDict) -> ActionResult.PackageCollaboratorList:
'''Return the list of all collaborators for a given package.
Currently you must be an Admin on the package owner organization to
manage collaborators.
Note: This action requires the collaborators feature to be enabled with
the :ref:`ckan.auth.allow_dataset_collaborators` configuration option.
:param id: the id or name of the package
:type id: string
:param capacity: (optional) If provided, only users with this capacity are
returned
:type capacity: string
:returns: a list of collaborators, each a dict including the package and
user id, the capacity and the last modified date
:rtype: list of dictionaries
'''
model = context['model']
package_id = _get_or_bust(data_dict, 'id')
package = model.Package.get(package_id)
if not package:
raise NotFound(_('Package not found'))
_check_access('package_collaborator_list', context, data_dict)
if not authz.check_config_permission('allow_dataset_collaborators'):
raise ValidationError({
'message': _('Dataset collaborators not enabled')
})
capacity = data_dict.get('capacity')
allowed_capacities = authz.get_collaborator_capacities()
if capacity and capacity not in allowed_capacities:
raise ValidationError(
{'message': _('Capacity must be one of "{}"').format(', '.join(
allowed_capacities))})
q = model.Session.query(model.PackageMember).\
filter(model.PackageMember.package_id == package.id)
if capacity:
q = q.filter(model.PackageMember.capacity == capacity)
collaborators = q.all()
return [collaborator.as_dict() for collaborator in collaborators]
def package_collaborator_list_for_user(
context: Context, data_dict: DataDict) -> ActionResult.PackageCollaboratorListForUser:
'''Return a list of all package the user is a collaborator in
Note: This action requires the collaborators feature to be enabled with
the :ref:`ckan.auth.allow_dataset_collaborators` configuration option.
:param id: the id or name of the user
:type id: string
:param capacity: (optional) If provided, only packages where the user
has this capacity are returned
:type capacity: string
:returns: a list of packages, each a dict including the package id, the
capacity and the last modified date
:rtype: list of dictionaries
'''
model = context['model']
user_id = _get_or_bust(data_dict, 'id')
if not authz.check_config_permission('allow_dataset_collaborators'):
raise ValidationError({
'message': _('Dataset collaborators not enabled')})
_check_access('package_collaborator_list_for_user', context, data_dict)
user = model.User.get(user_id)
if not user:
raise NotAuthorized(_('Not allowed to retrieve collaborators'))
capacity = data_dict.get('capacity')
allowed_capacities = authz.get_collaborator_capacities()
if capacity and capacity not in allowed_capacities:
raise ValidationError(
{'message': _('Capacity must be one of "{}"').format(', '.join(
allowed_capacities))})
q = model.Session.query(model.PackageMember).\
filter(model.PackageMember.user_id == user.id)
if capacity:
q = q.filter(model.PackageMember.capacity == capacity)
collaborators = q.all()
out: list[dict[str, str]] = []
for collaborator in collaborators:
out.append({
'package_id': collaborator.package_id,
'capacity': collaborator.capacity,
'modified': collaborator.modified.isoformat(),
})
return out
def _group_or_org_list(
context: Context, data_dict: DataDict, is_org: bool = False):
model = context['model']
api = context.get('api_version')
groups = data_dict.get('groups')
group_type = data_dict.get('type', 'group')
ref_group_by = 'id' if api == 2 else 'name'
pagination_dict = {}
limit = data_dict.get('limit')
if limit:
pagination_dict['limit'] = data_dict['limit']
offset = data_dict.get('offset')
if offset:
pagination_dict['offset'] = data_dict['offset']
if pagination_dict:
pagination_dict, errors = _validate(
data_dict, ckan.logic.schema.default_pagination_schema(), context)
if errors:
raise ValidationError(errors)
sort = data_dict.get('sort') or config.get('ckan.default_group_sort')
q = data_dict.get('q', '').strip()
all_fields = asbool(data_dict.get('all_fields', None))
if all_fields:
# all_fields is really computationally expensive, so need a tight limit
try:
max_limit = config.get(
'ckan.group_and_organization_list_all_fields_max')
except ValueError:
max_limit = 25
else:
try:
max_limit = config.get('ckan.group_and_organization_list_max')
except ValueError:
max_limit = 1000
if limit is None or int(limit) > max_limit:
limit = max_limit
# order_by deprecated in ckan 1.8
# if it is supplied and sort isn't use order_by and raise a warning
order_by = data_dict.get('order_by', '')
if order_by:
log.warn('`order_by` deprecated please use `sort`')
if not data_dict.get('sort'):
sort = order_by
# if the sort is packages and no sort direction is supplied we want to do a
# reverse sort to maintain compatibility.
if sort.strip() in ('packages', 'package_count'):
sort = 'package_count desc'
sort_info = _unpick_search(sort,
allowed_fields=['name', 'packages',
'package_count', 'title'],
total=1)
if sort_info and sort_info[0][0] == 'package_count':
query = model.Session.query(model.Group.id,
model.Group.name,
sqlalchemy.func.count(model.Group.id))
query = query.filter(model.Member.group_id == model.Group.id) \
.filter(model.Member.table_id == model.Package.id) \
.filter(model.Member.table_name == 'package') \
.filter(model.Package.state == 'active')
else:
query = model.Session.query(model.Group.id,
model.Group.name)
query = query.filter(model.Group.state == 'active')
if groups:
groups = aslist(groups, sep=",")
query = query.filter(model.Group.name.in_(groups))
if q:
q = u'%{0}%'.format(q)
query = query.filter(_or_(
model.Group.name.ilike(q),
model.Group.title.ilike(q),
model.Group.description.ilike(q),
))
query = query.filter(model.Group.is_organization == is_org)
query = query.filter(model.Group.type == group_type)
if sort_info:
sort_field = sort_info[0][0]
sort_direction = sort_info[0][1]
sort_model_field: Any = sqlalchemy.func.count(model.Group.id)
if sort_field == 'package_count':
query = query.group_by(model.Group.id, model.Group.name)
elif sort_field == 'name':
sort_model_field = model.Group.name
elif sort_field == 'title':
sort_model_field = model.Group.title
if sort_direction == 'asc':
query = query.order_by(sqlalchemy.asc(sort_model_field))
else:
query = query.order_by(sqlalchemy.desc(sort_model_field))
if limit:
query = query.limit(limit)
if offset:
query = query.offset(offset)
groups = query.all()
if all_fields:
action = 'organization_show' if is_org else 'group_show'
group_list = []
for group in groups:
data_dict['id'] = group.id
for key in ('include_extras', 'include_users',
'include_groups', 'include_followers'):
if key not in data_dict:
data_dict[key] = False
group_list.append(logic.get_action(action)(context, data_dict))
else:
group_list = [getattr(group, ref_group_by) for group in groups]
return group_list
def group_list(context: Context, data_dict: DataDict) -> ActionResult.GroupList:
'''Return a list of the names of the site's groups.
:param type: the type of group to list (optional, default: ``'group'``),
See docs for :py:class:`~ckan.plugins.interfaces.IGroupForm`
:type type: string
:param order_by: the field to sort the list by, must be ``'name'`` or
``'packages'`` (optional, default: ``'name'``) Deprecated use sort.
:type order_by: string
:param sort: sorting of the search results. Optional. Default:
"title asc" string of field name and sort-order. The allowed fields are
'name', 'package_count' and 'title'
:type sort: string
:param limit: the maximum number of groups returned (optional)
Default: ``1000`` when all_fields=false unless set in site's
configuration ``ckan.group_and_organization_list_max``
Default: ``25`` when all_fields=true unless set in site's
configuration ``ckan.group_and_organization_list_all_fields_max``
:type limit: int
:param offset: when ``limit`` is given, the offset to start
returning groups from
:type offset: int
:param groups: a list of names of the groups to return, if given only
groups whose names are in this list will be returned (optional)
:type groups: list of strings
:param all_fields: return group dictionaries instead of just names. Only
core fields are returned - get some more using the include_* options.
Returning a list of packages is too expensive, so the `packages`
property for each group is deprecated, but there is a count of the
packages in the `package_count` property.
(optional, default: ``False``)
:type all_fields: bool
:param include_dataset_count: if all_fields, include the full package_count
(optional, default: ``True``)
:type include_dataset_count: bool
:param include_extras: if all_fields, include the group extra fields
(optional, default: ``False``)
:type include_extras: bool
:param include_groups: if all_fields, include the groups the groups are in
(optional, default: ``False``).
:type include_groups: bool
:param include_users: if all_fields, include the group users
(optional, default: ``False``).
:type include_users: bool
:rtype: list of strings
'''
_check_access('group_list', context, data_dict)
return _group_or_org_list(context, data_dict)
def organization_list(context: Context,
data_dict: DataDict) -> ActionResult.OrganizationList:
'''Return a list of the names of the site's organizations.
:param type: the type of organization to list (optional,
default: ``'organization'``),
See docs for :py:class:`~ckan.plugins.interfaces.IGroupForm`
:type type: string
:param order_by: the field to sort the list by, must be ``'name'`` or
``'packages'`` (optional, default: ``'name'``) Deprecated use sort.
:type order_by: string
:param sort: sorting of the search results. Optional. Default:
"title asc" string of field name and sort-order. The allowed fields are
'name', 'package_count' and 'title'
:type sort: string
:param limit: the maximum number of organizations returned (optional)
Default: ``1000`` when all_fields=false unless set in site's
configuration ``ckan.group_and_organization_list_max``
Default: ``25`` when all_fields=true unless set in site's
configuration ``ckan.group_and_organization_list_all_fields_max``
:type limit: int
:param offset: when ``limit`` is given, the offset to start
returning organizations from
:type offset: int
:param organizations: a list of names of the groups to return,
if given only groups whose names are in this list will be
returned (optional)
:type organizations: list of strings
:param all_fields: return group dictionaries instead of just names. Only
core fields are returned - get some more using the include_* options.
Returning a list of packages is too expensive, so the `packages`
property for each group is deprecated, but there is a count of the
packages in the `package_count` property.
(optional, default: ``False``)
:type all_fields: bool
:param include_dataset_count: if all_fields, include the full package_count
(optional, default: ``True``)
:type include_dataset_count: bool
:param include_extras: if all_fields, include the organization extra fields
(optional, default: ``False``)
:type include_extras: bool
:param include_groups: if all_fields, include the organizations the
organizations are in
(optional, default: ``False``)
:type include_groups: bool
:param include_users: if all_fields, include the organization users
(optional, default: ``False``).
:type include_users: bool
:rtype: list of strings
'''
_check_access('organization_list', context, data_dict)
data_dict['groups'] = data_dict.pop('organizations', [])
data_dict.setdefault('type', 'organization')
return _group_or_org_list(context, data_dict, is_org=True)
def group_list_authz(context: Context,
data_dict: DataDict) -> ActionResult.GroupListAuthz:
'''Return the list of groups that the user is authorized to edit.
:param available_only: remove the existing groups in the package
(optional, default: ``False``)
:type available_only: bool
:param am_member: if ``True`` return only the groups the logged-in user is
a member of, otherwise return all groups that the user is authorized to
edit (for example, sysadmin users are authorized to edit all groups)
(optional, default: ``False``)
:type am_member: bool
:returns: list of dictized groups that the user is authorized to edit
:rtype: list of dicts
'''
model = context['model']
user = context['user']
available_only = data_dict.get('available_only', False)
am_member = data_dict.get('am_member', False)
_check_access('group_list_authz', context, data_dict)
sysadmin = authz.is_sysadmin(user)
roles = authz.get_roles_with_permission('manage_group')
if not roles:
return []
user_id = authz.get_user_id_for_username(user, allow_none=True)
if not user_id:
return []
group_ids: list[str] = []
if not sysadmin or am_member:
q: Any = model.Session.query(model.Member.group_id) \
.filter(model.Member.table_name == 'user') \
.filter(
model.Member.capacity.in_(roles)
).filter(model.Member.table_id == user_id) \
.filter(model.Member.state == 'active')
group_ids = []
for row in q:
group_ids.append(row.group_id)
if not group_ids:
return []
q = model.Session.query(model.Group) \
.filter(model.Group.is_organization == False) \
.filter(model.Group.state == 'active')
if not sysadmin or am_member:
q = q.filter(model.Group.id.in_(group_ids))
groups = q.all()
if available_only:
package = context.get('package')
if package:
groups = set(groups) - set(package.get_groups())
group_list = model_dictize.group_list_dictize(groups, context,
with_package_counts=asbool(data_dict.get('include_dataset_count')),
with_member_counts=asbool(data_dict.get('include_member_count')))
return group_list
def organization_list_for_user(context: Context,
data_dict: DataDict) -> ActionResult.OrganizationListForUser:
'''Return the organizations that the user has a given permission for.
Specifically it returns the list of organizations that the currently
authorized user has a given permission (for example: "manage_group")
against.
By default this returns the list of organizations that the currently
authorized user is member of, in any capacity.
When a user becomes a member of an organization in CKAN they're given a
"capacity" (sometimes called a "role"), for example "member", "editor" or
"admin".
Each of these roles has certain permissions associated with it. For example
the admin role has the "admin" permission (which means they have permission
to do anything). The editor role has permissions like "create_dataset",
"update_dataset" and "delete_dataset". The member role has the "read"
permission.
This function returns the list of organizations that the authorized user
has a given permission for. For example the list of organizations that the
user is an admin of, or the list of organizations that the user can create
datasets in. This takes account of when permissions cascade down an
organization hierarchy.
:param id: the name or id of the user to get the organization list for
(optional, defaults to the currently authorized user (logged in or via
API key))
:type id: string
:param permission: the permission the user has against the
returned organizations, for example ``"read"`` or ``"create_dataset"``
(optional, default: ``"manage_group"``)
:type permission: string
:param include_dataset_count: include the package_count in each org
(optional, default: ``False``)
:type include_dataset_count: bool
:returns: list of organizations that the user has the given permission for
:rtype: list of dicts
'''
model = context['model']
if data_dict.get('id'):
user_obj = model.User.get(data_dict['id'])
if not user_obj:
raise NotFound
user = user_obj.name
else:
user = context['user']
_check_access('organization_list_for_user', context, data_dict)
sysadmin = authz.is_sysadmin(user)
orgs_q = model.Session.query(model.Group) \
.filter(model.Group.is_organization == True) \
.filter(model.Group.state == 'active')
if sysadmin:
orgs_and_capacities = [(org, 'admin') for org in orgs_q.all()]
else:
# for non-Sysadmins check they have the required permission
permission = data_dict.get('permission', 'manage_group')
roles = authz.get_roles_with_permission(permission)
if not roles:
return []
user_id = authz.get_user_id_for_username(user, allow_none=True)
if not user_id:
return []
q: Query[tuple[model.Member, model.Group]] = model.Session.query(model.Member, model.Group) \
.filter(model.Member.table_name == 'user') \
.filter(
model.Member.capacity.in_(roles)
) \
.filter(model.Member.table_id == user_id) \
.filter(model.Member.state == 'active') \
.join(model.Group)
group_ids: set[str] = set()
roles_that_cascade = cast(
"list[str]",
authz.check_config_permission('roles_that_cascade_to_sub_groups')
)
group_ids_to_capacities: dict[str, str] = {}
for member, group in q.all():
if member.capacity in roles_that_cascade:
children_group_ids = [
grp_tuple[0] for grp_tuple
in group.get_children_group_hierarchy(type='organization')
]
for group_id in children_group_ids:
group_ids_to_capacities[group_id] = member.capacity
group_ids |= set(children_group_ids)
group_ids_to_capacities[group.id] = member.capacity
group_ids.add(group.id)
if not group_ids:
return []
orgs_q = orgs_q.filter(model.Group.id.in_(group_ids))
orgs_and_capacities = [
(org, group_ids_to_capacities[org.id]) for org in orgs_q.all()]
context['with_capacity'] = True
orgs_list = model_dictize.group_list_dictize(orgs_and_capacities, context,
with_package_counts=asbool(data_dict.get('include_dataset_count')),
with_member_counts=asbool(data_dict.get('include_member_count')))
return orgs_list
def license_list(context: Context, data_dict: DataDict) -> ActionResult.LicenseList:
'''Return the list of licenses available for datasets on the site.
:rtype: list of dictionaries
'''
model = context["model"]
_check_access('license_list', context, data_dict)
license_register = model.Package.get_license_register()
licenses = license_register.values()
licenses = [l.license_dictize() for l in licenses]
return licenses
def tag_list(context: Context,
data_dict: DataDict) -> ActionResult.TagList:
'''Return a list of the site's tags.
By default only free tags (tags that don't belong to a vocabulary) are
returned. If the ``vocabulary_id`` argument is given then only tags
belonging to that vocabulary will be returned instead.
:param query: a tag name query to search for, if given only tags whose
names contain this string will be returned (optional)
:type query: string
:param vocabulary_id: the id or name of a vocabulary, if give only tags
that belong to this vocabulary will be returned (optional)
:type vocabulary_id: string
:param all_fields: return full tag dictionaries instead of just names
(optional, default: ``False``)
:type all_fields: bool
:rtype: list of dictionaries
'''
model = context['model']
vocab_id_or_name = data_dict.get('vocabulary_id')
query = data_dict.get('query') or data_dict.get('q')
if query:
query = query.strip()
all_fields = data_dict.get('all_fields', None)
_check_access('tag_list', context, data_dict)
if query:
tags, _count = _tag_search(context, data_dict)
else:
tags = model.Tag.all(vocab_id_or_name)
if tags:
if all_fields:
tag_list: Union[
list[dict[str, Any]], list[str]
] = model_dictize.tag_list_dictize(tags, context)
else:
tag_list = [tag.name for tag in tags]
else:
tag_list = []
return tag_list
def user_list(
context: Context, data_dict: DataDict
) -> ActionResult.UserList:
'''Return a list of the site's user accounts.
:param q: filter the users returned to those whose names contain a string
(optional)
:type q: string
:param email: filter the users returned to those whose email match a
string (optional) (you must be a sysadmin to use this filter)
:type email: string
:param order_by: which field to sort the list by (optional, default:
``'display_name'``). Users can be sorted by ``'id'``, ``'name'``,
``'fullname'``, ``'display_name'``, ``'created'``, ``'about'``,
``'sysadmin'`` or ``'number_created_packages'``.
:type order_by: string
:param all_fields: return full user dictionaries instead of just names.
(optional, default: ``True``)
:type all_fields: bool
:param include_site_user: add site_user to the result
(optional, default: ``False``)
:type include_site_user: bool
:rtype: list of user dictionaries. User properties include:
``number_created_packages`` which excludes datasets which are private
or draft state.
'''
model = context['model']
_check_access('user_list', context, data_dict)
q = data_dict.get('q', '')
email = data_dict.get('email')
order_by = data_dict.get('order_by', 'display_name')
all_fields = asbool(data_dict.get('all_fields', True))
if all_fields:
query: 'Query[Any]' = model.Session.query(
model.User,
model.User.name.label('name'),
model.User.fullname.label('fullname'),
model.User.about.label('about'),
model.User.email.label('email'),
model.User.created.label('created'),
_select(_func.count(model.Package.id)).where(
model.Package.creator_user_id == model.User.id,
model.Package.state == 'active',
model.Package.private == False,
).label('number_created_packages')
)
else:
query = model.Session.query(model.User.name)
if not asbool(data_dict.get('include_site_user', False)):
site_id = config.get('ckan.site_id')
query = query.filter(model.User.name != site_id)
if q:
query = model.User.search(q, query, user_name=context.get('user'))
if email:
query = query.filter_by(email=email)
order_by_field = None
if order_by == 'edits':
raise ValidationError({
'message': 'order_by=edits is no longer supported'
})
elif order_by == 'number_created_packages':
order_by_field = order_by
elif order_by != 'display_name':
try:
order_by_field = getattr(model.User, order_by)
except AttributeError:
pass
if order_by == 'display_name' or order_by_field is None:
query = query.order_by(
_case((_or_(
model.User.fullname.is_(None),
model.User.fullname == ''
), model.User.name), else_=model.User.fullname)
)
elif order_by_field == 'number_created_packages' \
or order_by_field == 'fullname' \
or order_by_field == 'about' or order_by_field == 'sysadmin':
query = query.order_by(order_by_field, model.User.name)
else:
query = query.order_by(order_by_field)
# Filter deleted users
query = query.filter(model.User.state != model.State.DELETED)
## hack for pagination
if context.get('return_query'):
return query
users_list: ActionResult.UserList = []
if all_fields:
for user in query.all():
result_dict: Any = model_dictize.user_dictize(user[0], context)
users_list.append(result_dict)
else:
for user in query.all():
users_list.append(user[0])
return users_list
def package_relationships_list(context: Context,
data_dict: DataDict) -> ActionResult.PackageRelationshipsList:
'''Return a dataset (package)'s relationships.
:param id: the id or name of the first package
:type id: string
:param id2: the id or name of the second package
:type id2: string
:param rel: relationship as string see
:py:func:`~ckan.logic.action.create.package_relationship_create` for
the relationship types (optional)
:rtype: list of dictionaries
'''
##TODO needs to work with dictization layer
model = context['model']
api = context.get('api_version')
id = _get_or_bust(data_dict, "id")
id2 = data_dict.get("id2")
rel = data_dict.get("rel")
ref_package_by = 'id' if api == 2 else 'name'
pkg1 = model.Package.get(id)
pkg2 = None
if not pkg1:
raise NotFound('First package named in request was not found.')
if id2:
pkg2 = model.Package.get(id2)
if not pkg2:
raise NotFound('Second package named in address was not found.')
if rel == 'relationships':
rel = None
_check_access('package_relationships_list', context, data_dict)
# TODO: How to handle this object level authz?
# Currently we don't care
relationships = pkg1.get_relationships(with_package=pkg2, type=rel)
if rel and not relationships:
raise NotFound('Relationship "%s %s %s" not found.'
% (id, rel, id2))
relationship_dicts = [
rel.as_dict(pkg1, ref_package_by=ref_package_by)
for rel in relationships]
return relationship_dicts
def package_show(context: Context, data_dict: DataDict) -> ActionResult.PackageShow:
'''Return the metadata of a dataset (package) and its resources.
:param id: the id or name of the dataset
:type id: string
:param use_default_schema: use default package schema instead of
a custom schema defined with an IDatasetForm plugin (default: ``False``)
:type use_default_schema: bool
:param include_plugin_data: Include the internal plugin data object
(sysadmin only, optional, default:``False``)
:type: include_plugin_data: bool
:rtype: dictionary
'''
model = context['model']
user_obj = context.get('auth_user_obj')
context['session'] = model.Session
name_or_id = data_dict.get("id") or _get_or_bust(data_dict, 'name_or_id')
include_plugin_data = asbool(data_dict.get('include_plugin_data', False))
if user_obj and user_obj.is_authenticated:
include_plugin_data = (
user_obj.sysadmin # type: ignore
and include_plugin_data
)
if include_plugin_data:
context['use_cache'] = False
pkg = model.Package.get(
name_or_id,
for_update=context.get('for_update', False))
if pkg is None:
raise NotFound
context['package'] = pkg
_check_access('package_show', context, data_dict)