Skip to content

oarepo_oaipmh_harvester.administration.record.views

oarepo_oaipmh_harvester.administration.record.views

Views for administration of harvested OAI Records.

OAIHarvesterPermissionsMixin

Mixin to add OAI harvester permissions to views.

Source code in oarepo_oaipmh_harvester/administration/record/views.py 
52
53
54
55
class OAIHarvesterPermissionsMixin:
    """Mixin to add OAI harvester permissions to views."""

    decorators = (oai_record_permissions_decorator,)

RecordListView

Bases: OAIHarvesterPermissionsMixin, AdminResourceListView

Configuration for OAI-PMH sets list view.

Source code in oarepo_oaipmh_harvester/administration/record/views.py 
 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
class RecordListView(OAIHarvesterPermissionsMixin, AdminResourceListView):
    """Configuration for OAI-PMH sets list view."""

    api_endpoint = "/oai/harvest/records"
    extension_name = "oarepo_oaipmh_harvester"
    name = "oarepo_oaipmh_harvest_records"
    url = "/oarepo/harvest/records"

    resource_config = "oai_record_resource"
    search_request_headers: Mapping[str, str] = {"Accept": "application/invenio-administration-detail+json"}
    title = "OAI-PMH Harvester Records"
    category = "Site management"
    pid_path = "id"
    icon = "exchange"
    order = 1
    menu_label = "OAI-PMH Harvester Records"

    actions: Mapping[str, dict[str, Any]] = {
        "harvest": {
            "text": "Re-harvest",
            "order": 1,
            "payload_schema": None,
        }
    }

    display_search = True
    display_delete = False
    display_edit = False
    display_create = False

    item_field_list: Mapping[str, dict[str, Any]] = {
        "oai_identifier": {"text": _("OAI Identifier"), "order": 1, "width": 2},
        "record_pid": {
            "text": _("Record ID"),
            "order": 2,
            "width": 2,
            "escape": True,
        },
        "title": {"text": _("Record Title"), "order": 3, "width": 6},
        "datestamp": {"text": _("Datestamp"), "order": 4},
        "harvested_at": {"text": _("Harvested at"), "order": 5},
        "deleted": {"text": _("Deleted"), "order": 6, "width": 1},
        "has_errors": {"text": _("Has errors"), "order": 7, "width": 1},
        "manual": {"text": _("Manual"), "order": 8, "width": 1},
    }

    search_config_name = "OAI_RECORD_SEARCH"
    search_facets_config_name = "OAI_RECORD_FACETS"
    search_sort_config_name = "OAI_RECORD_SORT_OPTIONS"

RecordDetailView

Bases: OAIHarvesterPermissionsMixin, AdminResourceDetailView

Configuration for OAI-PMH sets detail view.

Source code in oarepo_oaipmh_harvester/administration/record/views.py 
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
class RecordDetailView(OAIHarvesterPermissionsMixin, AdminResourceDetailView):
    """Configuration for OAI-PMH sets detail view."""

    url = "/oarepo/harvest/records/<path:pid_value>"
    api_endpoint = "/oai/harvest/records/"
    request_headers: Mapping[str, str] = {"Accept": "application/invenio-administration-detail+json"}
    name = "oarepo_oaipmh_records_detail"
    resource_config = "oai_record_resource"
    title = "OAI-PMH Harvester Record"
    extension_name = "oarepo_oaipmh_harvester"

    display_delete = False
    display_edit = False

    list_view_name = "oarepo_oaipmh_harvest_records"
    pid_path = "id"

    actions: Mapping[str, dict[str, Any]] = {
        "harvest": {
            "text": "Re-harvest",
            "order": 1,
            "payload_schema": None,
        }
    }

    item_field_list: Mapping[str, dict[str, Any]] = {
        "title": {"text": _("Record Title"), "order": -1},
        "oai_identifier": {"text": _("OAI Identifier"), "order": 1, "width": 3},
        "record_id_with_link": {
            "text": _("Record ID"),
            "order": 2,
            "width": 3,
            "escape": True,
        },
        "datestamp": {"text": _("Datestamp"), "order": 3},
        "harvested_at": {"text": _("Harvested at"), "order": 3, "width": 1},
        "deleted": {"text": _("Deleted"), "order": 5},
        "has_errors": {"text": _("Has errors"), "order": 6},
        "errors": {"text": _("Errors"), "order": 7, "escape": True},
        "original_data": {"text": _("Original data"), "order": 8, "escape": True},
        "transformed_data": {"text": _("Transformed data"), "order": 9, "escape": True},
    }

oai_record_permissions_decorator(view: Callable[P, R_co]) -> Callable[P, R_co]

Decorate view to check permissions for OAI record views.

Source code in oarepo_oaipmh_harvester/administration/record/views.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
def oai_record_permissions_decorator[**P, R_co](
    view: Callable[P, R_co],
) -> Callable[P, R_co]:
    """Decorate view to check permissions for OAI record views."""

    @functools.wraps(view)
    def wrapper(*args: P.args, **kwargs: P.kwargs) -> R_co:
        """Check permissions for OAI record views."""
        # get all harvesters and their managers
        manager_needs = set()
        for md in OAIHarvester.query.all():
            for manager in md.harvest_managers or []:
                if "user" in manager:
                    manager_needs.add(harvest_manager_need(manager))
        oai_record_permission = Permission(administration_access_action, *manager_needs)

        return cast(
            "R_co",
            oai_record_permission.require(http_exception=403)(view)(*args, **kwargs),
        )

    return wrapper