Skip to content

oarepo_oaipmh_harvester.views

oarepo_oaipmh_harvester.views

UI views - the public /about/harvest page listing the harvesters.

The page is rendered from oarepo_oaipmh_harvester/about_harvest.html (override it in the instance's templates/oarepo_oaipmh_harvester/ folder). It gets harvesters - a list of (harvester, stats, can_manage) ordered by the harvester name, stats having last_harvested, records and failed (records whose last harvest has errors), and can_manage telling whether the current user may open the harvester in the administration (administration access or harvest manager of the harvester) - links are shown then.

about_harvest() -> str

Render the list of harvesters with their configuration and statistics.

Source code in oarepo_oaipmh_harvester/views.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def about_harvest() -> str:
    """Render the list of harvesters with their configuration and statistics."""
    record = OAIHarvestedRecord
    stats = {
        harvester_id: {"last_harvested": last_harvested, "records": records, "failed": failed}
        for harvester_id, last_harvested, records, failed in db.session.query(
            record.harvester_id,
            func.max(record.harvested_at),
            func.count(),
            func.count().filter(record.has_errors.is_(True)),
        ).group_by(record.harvester_id)
    }
    empty: dict[str, Any] = {"last_harvested": None, "records": 0, "failed": 0}
    harvesters = [(h, stats.get(h.id, empty), _can_manage(h)) for h in OAIHarvester.query.order_by(OAIHarvester.name)]
    return render_template("oarepo_oaipmh_harvester/about_harvest.html", harvesters=harvesters)

create_ui_blueprint(_app: Flask) -> Blueprint

UI blueprint with the /about/harvest page and the package's templates.

Source code in oarepo_oaipmh_harvester/views.py 
52
53
54
55
56
def create_ui_blueprint(_app: Flask) -> Blueprint:
    """UI blueprint with the `/about/harvest` page and the package's templates."""
    blueprint = Blueprint("oarepo_oaipmh_harvester_ui", __name__, template_folder="templates")
    blueprint.add_url_rule("/about/harvest", view_func=about_harvest)
    return blueprint