-
Notifications
You must be signed in to change notification settings - Fork 153
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into 9455-orgbug-the-other-names-json-not-saved-i…
…n-the-db-for-new-ror-orgs-added-in-db
- Loading branch information
Showing
24 changed files
with
888 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
19 changes: 19 additions & 0 deletions
19
orcid-core/src/main/resources/org/orcid/core/template/papi_rate_limit_email.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| <#import "email_macros.ftl" as emailMacros /> | ||
| Dear ${emailName}, | ||
|
|
||
| This is an important message to let you know that you have exceeded our daily Public API usage limit with your integration: | ||
|
|
||
| Client Name: ${clientName} | ||
| Client ID: ${clientId} | ||
|
|
||
| Please remember that the ORCID Public API is free for non-commercial use by individuals as stated in the Public APIs Terms of Service (https://info.orcid.org/public-client-terms-of-service/). By “non-commercial” we mean that you may not charge any re-use fees for the Public API, and you may not make use of the Public API in connection with any revenue-generating product or service | ||
|
|
||
| If you need access to an ORCID API for commercial use, need a higher usage quota, organizational administration of your API credentials, or the ability to write data to or access Trusted Party data in ORCID records, our Member API (https://info.orcid.org/documentation/features/member-api/) is available to ORCID member organizations. | ||
|
|
||
| To minimize any disruption to your ORCID integration in the future, we would recommend that you reach out to our Engagement Team by replying to this email to discuss our ORCID membership options. | ||
|
|
||
| Warm Regards, | ||
| ORCID Support Team | ||
| https://support.orcid.org | ||
| <@emailMacros.msg "email.common.you_have_received_this_email" /> | ||
| <#include "email_footer.ftl"/> |
36 changes: 36 additions & 0 deletions
36
orcid-core/src/main/resources/org/orcid/core/template/papi_rate_limit_email_html.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| <#import "email_macros.ftl" as emailMacros /> | ||
| <#escape x as x?html> | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <title>${subject}</title> | ||
| </head> | ||
| <body> | ||
| <div style="padding: 20px; padding-top: 10px; width: 700px; margin: auto;"> | ||
| <img src="https://orcid.org/sites/all/themes/orcid/img/orcid-logo.png" alt="ORCID.org"/> | ||
| <hr /> | ||
| <span style="font-family: arial, helvetica, sans-serif; font-size: 15px; color: #494A4C; font-weight: bold;">Dear ${emailName},</span> | ||
| <p style="font-family: arial, helvetica, sans-serif;font-size: 15px;color: #494A4C; white-space: pre;">This is an important message to let you know that you have exceeded our daily Public API usage limit with your integration:</p> | ||
| <p style="font-family: arial, helvetica, sans-serif;font-size: 15px;color: #494A4C; white-space: pre;">Client Name: ${clientName}</p> | ||
| <p style="font-family: arial, helvetica, sans-serif;font-size: 15px;color: #494A4C; white-space: pre;">Client ID: ${clientId}</p> | ||
| <br/> | ||
| <p style="font-family: arial, helvetica, sans-serif;font-size: 15px;color: #494A4C; white-space: pre;">Please remember that the ORCID Public API is free for non-commercial use by individuals as stated in the Public APIs Terms of Service (https://info.orcid.org/public-client-terms-of-service/). By “non-commercial” we mean that you may not charge any re-use fees for the Public API, and you may not make use of the Public API in connection with any revenue-generating product or service.</p> | ||
| <p style="font-family: arial, helvetica, sans-serif;font-size: 15px;color: #494A4C; white-space: pre;">If you need access to an ORCID API for commercial use, need a higher usage quota, organizational administration of your API credentials, or the ability to write data to or access Trusted Party data in ORCID records, our Member API (https://info.orcid.org/documentation/features/member-api/) is available to ORCID member organizations.</p> | ||
| <p style="font-family: arial, helvetica, sans-serif;font-size: 15px;color: #494A4C; white-space: pre;">To minimize any disruption to your ORCID integration in the future, we would recommend that you reach out to our Engagement Team by replying to this email to discuss our ORCID membership options. | ||
| <br/> | ||
| <p style="font-family: arial, helvetica, sans-serif;font-size: 15px;color: #494A4C; white-space: pre;"> | ||
| Warm Regards, | ||
| ORCID Support Team | ||
| https://support.orcid.org | ||
| </p> | ||
|
|
||
| <p style="font-family: arial, helvetica, sans-serif;font-size: 15px;color: #494A4C;"> | ||
| <@emailMacros.msg "email.common.you_have_received_this_email" /> | ||
| </p> | ||
| <p style="font-family: arial, helvetica, sans-serif;font-size: 15px;color: #494A4C;"> | ||
| <#include "email_footer_html.ftl"/> | ||
| </p> | ||
| </div> | ||
| </body> | ||
| </html> | ||
| </#escape> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 15 additions & 0 deletions
15
orcid-persistence/src/main/java/org/orcid/persistence/dao/PublicApiDailyRateLimitDao.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| package org.orcid.persistence.dao; | ||
|
|
||
| import java.time.LocalDate; | ||
|
|
||
| import org.orcid.persistence.jpa.entities.PublicApiDailyRateLimitEntity; | ||
|
|
||
| public interface PublicApiDailyRateLimitDao extends GenericDao<PublicApiDailyRateLimitEntity, Long> { | ||
|
|
||
| PublicApiDailyRateLimitEntity findByClientIdAndRequestDate(String clientId, LocalDate requestDate); | ||
| PublicApiDailyRateLimitEntity findByIpAddressAndRequestDate(String ipAddress, LocalDate requestDate); | ||
| int countClientRequestsWithLimitExceeded(LocalDate requestDate, int limit); | ||
| int countAnonymousRequestsWithLimitExceeded(LocalDate requestDate, int limit); | ||
| boolean updatePublicApiDailyRateLimit(PublicApiDailyRateLimitEntity papiRateLimitingEntity, boolean isClient); | ||
|
|
||
| } |
126 changes: 126 additions & 0 deletions
126
...sistence/src/main/java/org/orcid/persistence/dao/impl/PublicApiDailyRateLimitDaoImpl.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| package org.orcid.persistence.dao.impl; | ||
|
|
||
| import java.time.LocalDate; | ||
| import java.time.LocalDateTime; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| import javax.persistence.Query; | ||
|
|
||
| import org.orcid.persistence.dao.PublicApiDailyRateLimitDao; | ||
| import org.orcid.persistence.jpa.entities.PublicApiDailyRateLimitEntity; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import org.springframework.transaction.annotation.Transactional; | ||
|
|
||
| public class PublicApiDailyRateLimitDaoImpl extends GenericDaoImpl<PublicApiDailyRateLimitEntity, Long> implements PublicApiDailyRateLimitDao { | ||
| private static final Logger LOG = LoggerFactory.getLogger(PublicApiDailyRateLimitDaoImpl.class); | ||
|
|
||
| public PublicApiDailyRateLimitDaoImpl() { | ||
| super(PublicApiDailyRateLimitEntity.class); | ||
| } | ||
|
|
||
| @Override | ||
| public PublicApiDailyRateLimitEntity findByClientIdAndRequestDate(String clientId, LocalDate requestDate) { | ||
| Query nativeQuery = entityManager.createNativeQuery("SELECT * FROM public_api_daily_rate_limit p client_id=:clientId and requestDate=:requestDate", | ||
| PublicApiDailyRateLimitEntity.class); | ||
| nativeQuery.setParameter("clientId", clientId); | ||
| nativeQuery.setParameter("requestDate", requestDate); | ||
| List<PublicApiDailyRateLimitEntity> papiRateList = (List<PublicApiDailyRateLimitEntity>) nativeQuery.getResultList(); | ||
| if (papiRateList != null && papiRateList.size() > 0) { | ||
| if (papiRateList.size() > 1) { | ||
| LOG.warn("Found more than one entry for the daily papi rate limiting the client: " + clientId + " and request date: " + requestDate.toString()); | ||
| } | ||
| return (PublicApiDailyRateLimitEntity) papiRateList.get(0); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public PublicApiDailyRateLimitEntity findByIpAddressAndRequestDate(String ipAddress, LocalDate requestDate) { | ||
| String baseQuery = "SELECT * FROM public_api_daily_rate_limit p where p.ip_address=:ipAddress and p.request_date=:requestDate"; | ||
|
|
||
| Query nativeQuery = entityManager.createNativeQuery(baseQuery, PublicApiDailyRateLimitEntity.class); | ||
| nativeQuery.setParameter("ipAddress", ipAddress); | ||
| nativeQuery.setParameter("requestDate", requestDate); | ||
|
|
||
| List<PublicApiDailyRateLimitEntity> papiRateList = (List<PublicApiDailyRateLimitEntity>) nativeQuery.getResultList(); | ||
| if (papiRateList != null && papiRateList.size() > 0) { | ||
| LOG.debug("found results ...."); | ||
| if (papiRateList.size() > 1) { | ||
| LOG.warn("Found more than one entry for the daily papi rate limiting, the IP Address: " + ipAddress + " and request date: " + requestDate.toString()); | ||
| } | ||
| return (PublicApiDailyRateLimitEntity) papiRateList.get(0); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| public int countClientRequestsWithLimitExceeded(LocalDate requestDate, int limit) { | ||
| Query nativeQuery = entityManager.createNativeQuery( | ||
| "SELECT count(*) FROM public_api_daily_rate_limit p WHERE NOT ((p.client_id = '' OR p.client_id IS NULL)) and p.request_date=:requestDate and p.request_count >=:requestCount"); | ||
| nativeQuery.setParameter("requestDate", requestDate); | ||
| nativeQuery.setParameter("requestCount", limit); | ||
| List<java.math.BigInteger> tsList = nativeQuery.getResultList(); | ||
| if (tsList != null && !tsList.isEmpty()) { | ||
| return tsList.get(0).intValue(); | ||
| } | ||
| return 0; | ||
|
|
||
| } | ||
|
|
||
| public int countAnonymousRequestsWithLimitExceeded(LocalDate requestDate, int limit) { | ||
| Query nativeQuery = entityManager.createNativeQuery( | ||
| "SELECT count(*) FROM public_api_daily_rate_limit p WHERE ((p.client_id = '' OR p.client_id IS NULL)) and p.request_date=:requestDate and p.request_count >=:requestCount"); | ||
| nativeQuery.setParameter("requestDate", requestDate); | ||
| nativeQuery.setParameter("requestCount", limit); | ||
| List<java.math.BigInteger> tsList = nativeQuery.getResultList(); | ||
| if (tsList != null && !tsList.isEmpty()) { | ||
| return tsList.get(0).intValue(); | ||
| } | ||
| return 0; | ||
| } | ||
|
|
||
| @Override | ||
| @Transactional | ||
| public boolean updatePublicApiDailyRateLimit(PublicApiDailyRateLimitEntity papiRateLimitingEntity, boolean isClient) { | ||
| Query query; | ||
| if (isClient) { | ||
| query = entityManager.createNativeQuery("update public_api_daily_rate_limit set request_count = :requestCount, last_modified = now() where " | ||
| + "client_id = :clientId and request_date =:requestDate"); | ||
| query.setParameter("clientId", papiRateLimitingEntity.getClientId()); | ||
| } else { | ||
| query = entityManager.createNativeQuery("update public_api_daily_rate_limit set request_count = :requestCount, last_modified = now() where " | ||
| + "ip_address = :ipAddress and request_date =:requestDate"); | ||
| query.setParameter("ipAddress", papiRateLimitingEntity.getIpAddress()); | ||
| } | ||
| query.setParameter("requestCount", papiRateLimitingEntity.getRequestCount()); | ||
| query.setParameter("requestDate", papiRateLimitingEntity.getRequestDate().toString()); | ||
| return query.executeUpdate() > 0; | ||
| } | ||
|
|
||
| @Override | ||
| @Transactional | ||
| public void persist(PublicApiDailyRateLimitEntity papiRateLimitingEntity) { | ||
| String insertQuery = "INSERT INTO public_api_daily_rate_limit " + "(id, client_id, ip_address, request_count, request_date, date_created, last_modified)" | ||
| + " VALUES ( NEXTVAL('papi_daily_limit_seq'), :clientId , :ipAddress, :requestCount," + " :requestDate, now(), now())"; | ||
|
|
||
| Query query = entityManager.createNativeQuery(insertQuery); | ||
| query.setParameter("clientId", papiRateLimitingEntity.getClientId()); | ||
| query.setParameter("ipAddress", papiRateLimitingEntity.getIpAddress()); | ||
| query.setParameter("requestCount", papiRateLimitingEntity.getRequestCount()); | ||
| query.setParameter("requestDate", papiRateLimitingEntity.getRequestDate()); | ||
| query.executeUpdate(); | ||
| return; | ||
| } | ||
|
|
||
| private static String logQueryWithParams(String baseQuery, Map<String, Object> params) { | ||
| for (Map.Entry<String, Object> entry : params.entrySet()) { | ||
| String paramPlaceholder = ":" + entry.getKey(); | ||
| String paramValue = (entry.getValue() instanceof String) ? "'" + entry.getValue() + "'" : entry.getValue().toString(); | ||
| baseQuery = baseQuery.replace(paramPlaceholder, paramValue); | ||
| } | ||
| return baseQuery; | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.