This is a preview release of the v4 API. This will become the current version of the API
- in July 2024. Please review the below timeline and migration notes, and upgrade your integrations
+
+
This is the current version of the DOAJ API
+
Please review the below timeline and migration notes, and upgrade your integrations
as soon as possible.
-
Documentation for the existing current API (v3) is available here
+
Documentation for the previous version of the API (v3) is available here
This new version of the API introduces significant performance improvements on the bulk article upload endpoint (/api/bulk/articles).
-
This change is not backwards compatible with the existing API version, so if you rely on bulk article uploads, you will need to upgrade your integrations to use the new version.
+
This change is not backwards compatible with the previous API version, so if you rely on bulk article uploads, you will need to upgrade your integrations to use the new version.
This upgrade affects only the /api/bulk/articles endpoint. If you do not use this feature, your API integrations will continue to work normally.
-
The bulk articles endpoint will change from a synchronous upload to an asynchronous one. In the new version, you will upload a batch of articles to be ingested, and the system will respond immediately with an "Accepted" response, and a link to a status endpoint which will track the import progress of your request. This has been done for several reasons:
+
The bulk articles endpoint has changed from a synchronous upload to an asynchronous one. In this new version, you upload a batch of articles to be ingested, and the system will respond immediately with an "Accepted" response, and a link to a status endpoint which will track the import progress of your request. This has been done for several reasons:
- It is consistent with the manual bulk upload approach we have in the user interface
- It allows us to manage the performance of the API better
@@ -38,16 +38,9 @@ API
Timeline
- - 18 June 2024 - v4 of the API will be released and available at the base URL /api/v4. It will not replace the existing current API version (v3). If you are reliant on the bulk article upload, you should:
-
- - Try out the new bulk endpoint; upgrade your integrations immediately if feasible.
- - If upgrading your integrations in the short term is not feasible, you should fix your existing integration to point to /api/v3, which will continue to work in the medium term.
-
-
+ - 18th July 2024 The v4 API became the "current" API version and is available at /api AND /api/v4. At this point, old integrations with the bulk article upload have ceased to work, and you must switch to using /api/v3 if you want to get it to work again. If you wish to continue using this feature long-term, you must upgrade your integrations.
- - Approximately 1 month after 18th June 2024 (exact date to be confirmed) The v4 API will become the "current" API version and will be available at /api AND /api/v4. At this point, old integrations with the bulk article upload will cease to work, and you must switch to using /api/v3 if you want to get it to work again. If you wish to continue using this feature long-term, you must upgrade your integrations.
-
- - Approximately 6 months after 18th June 2024 (exact date to be confirmed) All previous API versions (v1, v2 and v3) will cease to support bulk article uploads, and if you wish to use this feature, you must use the v4 API. All other backwards-compatible API features in those previous versions of the API will continue to work as normal.
+ - Early 2025 (exact date to be confirmed) All previous API versions (v1, v2 and v3) will cease to support bulk article uploads, and if you wish to use this feature, you must use the v4 API. All other backwards-compatible API features in those previous versions of the API will continue to work as normal.
diff --git a/portality/templates/data/publisher-supporters.html b/portality/templates/data/publisher-supporters.html
index 74e7aa8c38..fd6f08dd60 100644
--- a/portality/templates/data/publisher-supporters.html
+++ b/portality/templates/data/publisher-supporters.html
@@ -1,7 +1,9 @@
- {% for i in data.publisher_supporters %}
- -
- {{ i.name }}
-
- {% endfor %}
+ {% if data.publisher_supporters %}
+ {% for i in data.publisher_supporters %}
+ -
+ {{ i.name }}
+
+ {% endfor %}
+ {% endif %}
\ No newline at end of file
diff --git a/portality/templates/doaj/index.html b/portality/templates/doaj/index.html
index 2b2fb8cd36..499450abfa 100644
--- a/portality/templates/doaj/index.html
+++ b/portality/templates/doaj/index.html
@@ -52,7 +52,7 @@ DOAJ in numbers
{% set source = search_query_source(term=[{"bibjson.apc.has_apc":False},{"bibjson.other_charges.has_other_charges":False}]) %}
{{ statistics.no_apc }}
- journals without fees
+ journals without APCs
diff --git a/portality/upgrade.py b/portality/upgrade.py
index 09ecc436be..26149b7ce4 100644
--- a/portality/upgrade.py
+++ b/portality/upgrade.py
@@ -2,10 +2,12 @@
~~Migrations:Framework~~
# FIXME: this script requires more work if it's to be used for specified source and target clusters
"""
-import json, os, dictdiffer
-from datetime import datetime, timedelta
-from copy import deepcopy
+import dictdiffer
+import json
+import os
from collections import OrderedDict
+from copy import deepcopy
+from datetime import timedelta
from typing import TypedDict, List, Dict
from portality import models
@@ -13,7 +15,7 @@
from portality.lib import plugin, dates
from portality.lib.dataobj import DataStructureException
from portality.lib.seamless import SeamlessException
-from portality.dao import ScrollTimeoutException
+from portality.models.datalog_journal_added import DatalogJournalAdded
MODELS = {
"journal": models.Journal, # ~~->Journal:Model~~
@@ -21,7 +23,8 @@
"suggestion": models.Suggestion, # ~~->Application:Model~~
"application": models.Application,
"account": models.Account, # ~~->Account:Model~~
- "background_job": models.BackgroundJob # ~~->BackgroundJob:Model~~
+ "background_job": models.BackgroundJob, # ~~->BackgroundJob:Model~~
+ 'datalog_journal_added': DatalogJournalAdded,
}
@@ -34,7 +37,12 @@ def upgrade_article(self, article):
class UpgradeType(TypedDict):
type: str # name / key of the MODELS class
action: str # default is update
- query: dict # ES query to use to find the records to upgrade
+
+ """
+ ES query to use to find the records to upgrade
+ default is match_all if query is None
+ """
+ query: dict
keepalive: str # ES keepalive time for the scroll, default 1m
scroll_size: int # ES scroll size, default 1000
diff --git a/portality/view/doaj.py b/portality/view/doaj.py
index 711549e17f..ed083446c2 100644
--- a/portality/view/doaj.py
+++ b/portality/view/doaj.py
@@ -39,11 +39,17 @@ def login():
def cookie_consent():
cont = request.values.get("continue")
if cont is not None:
- resp = redirect(cont)
+ # Only permit relative path redirects, to prevent phishing by supplying a full URI to a different domain
+ parsed_redirect = urllib.parse.urlparse(cont)
+ if parsed_redirect.netloc != '':
+ abort(400)
+ else:
+ resp = redirect(cont)
else:
resp = make_response()
# set a cookie that lasts for one year
- resp.set_cookie(app.config.get("CONSENT_COOKIE_KEY"), Messages.CONSENT_COOKIE_VALUE, max_age=31536000, samesite=None, secure=True)
+ resp.set_cookie(app.config.get("CONSENT_COOKIE_KEY"),
+ Messages.CONSENT_COOKIE_VALUE, max_age=31536000, samesite=None, secure=True)
return resp
@@ -145,7 +151,7 @@ def search_post():
#############################################
-# FIXME: this should really live somewhere else more appropirate to who can access it
+# FIXME: this should really live somewhere else more appropriate to who can access it
@blueprint.route("/journal/readonly/", methods=["GET"])
@login_required
@ssl_required
@@ -286,6 +292,7 @@ def find_toc_journal_by_identifier(identifier):
def is_issn_by_identifier(identifier):
return len(identifier) == 9
+
def find_correct_redirect_identifier(identifier, bibjson) -> str:
"""
return None if identifier is correct and no redirect is needed
@@ -345,6 +352,7 @@ def toc(identifier=None):
def toc_articles_legacy(identifier=None):
return redirect(url_for('doaj.toc_articles', identifier=identifier, volume=1, issue=1), 301)
+
@blueprint.route("/toc//articles")
def toc_articles(identifier=None):
journal = find_toc_journal_by_identifier(identifier)
@@ -356,7 +364,6 @@ def toc_articles(identifier=None):
return render_template('doaj/toc_articles.html', journal=journal, bibjson=bibjson )
-
#~~->Article:Page~~
@blueprint.route("/article/")
def article_page(identifier=None):
diff --git a/setup.py b/setup.py
index 48c059b4b5..ff411fe26d 100644
--- a/setup.py
+++ b/setup.py
@@ -5,7 +5,7 @@
setup(
name='doaj',
- version='6.7.3',
+ version='6.8.1',
packages=find_packages(),
install_requires=[
"awscli==1.20.50",