From 533b165e3c23f9a1bfebac7c70a0044f7575fc0c Mon Sep 17 00:00:00 2001 From: "francesco.mangiacrapa" Date: Fri, 17 Feb 2023 17:07:34 +0100 Subject: [PATCH] Sample Esquilino Client, implemented --- .project | 6 + .pydevproject | 5 + .settings/org.eclipse.core.resources.prefs | 2 + IAM_Token_Client.py | 59 ++++++ JSON_Reader.py | 36 ++++ URL_Reader_Util.py | 20 ++ main.py | 235 +++++++++++++++++++++ 7 files changed, 363 insertions(+) create mode 100644 .pydevproject create mode 100644 .settings/org.eclipse.core.resources.prefs create mode 100644 IAM_Token_Client.py create mode 100644 JSON_Reader.py create mode 100644 URL_Reader_Util.py create mode 100644 main.py diff --git a/.project b/.project index f72d58f..058b321 100644 --- a/.project +++ b/.project @@ -5,7 +5,13 @@ + + org.python.pydev.PyDevBuilder + + + + org.python.pydev.pythonNature diff --git a/.pydevproject b/.pydevproject new file mode 100644 index 0000000..2b04565 --- /dev/null +++ b/.pydevproject @@ -0,0 +1,5 @@ + + + Default + python interpreter + diff --git a/.settings/org.eclipse.core.resources.prefs b/.settings/org.eclipse.core.resources.prefs new file mode 100644 index 0000000..41d50f5 --- /dev/null +++ b/.settings/org.eclipse.core.resources.prefs @@ -0,0 +1,2 @@ +eclipse.preferences.version=1 +encoding/main.py=utf-8 diff --git a/IAM_Token_Client.py b/IAM_Token_Client.py new file mode 100644 index 0000000..3341e3f --- /dev/null +++ b/IAM_Token_Client.py @@ -0,0 +1,59 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# @author: Giancarlo Panichi +# revisited by @author: Francesco Mangiacrapa + +# Created on 2023/02/01 +# +import requests +import urllib.parse + + +class IAM_Token_Client: + + def __init__(self, iamURL, the_clientId, the_clientSecret): + self.iamURL = iamURL + self.clientId = the_clientId + self.clientSecret = the_clientSecret + print('IAM URL: ' + self.iamURL) + #print('ClientId: ' + self.clientId) + #print('ClientSecret: ' + self.clientSecret) + + def getAccessToken(self): + #print("getAccessToken()") + + loginheaders = {'Accept': 'application/json', 'Content-Type': 'application/x-www-form-urlencoded'} + logindata = {'grant_type': 'client_credentials', 'client_id': self.clientId, 'client_secret': self.clientSecret} + + # Get Access Token by client_id + resp1 = requests.post(self.iamURL, data=logindata, headers=loginheaders) + jwt1 = resp1.json() + #print("Resp AccessToken: ", jwt1) + accessToken = jwt1["access_token"] + return accessToken + + def getUmaToken(self, gcube_context): + print("getUmaToken()") + context = gcube_context + + #print('Context: ' + context) + + context = urllib.parse.quote(context, safe='') + #print('Context safe: ' + context) + + accessToken = self.getAccessToken() + + umaheaders = {'Accept': 'application/json', 'Content-Type': 'application/x-www-form-urlencoded'} + umadata = {'grant_type': 'urn:ietf:params:oauth:grant-type:uma-ticket', 'audience': context} + + # Get UMA token for context + umaheaders["Authorization"] = "Bearer " + accessToken + resp2 = requests.post(self.iamURL, data=umadata, headers=umaheaders) + jwt2 = resp2.json() + #print("Resp UmaToken: ", jwt2) + umaToken = jwt2["access_token"] + return umaToken + + def __str__(self): + return 'IAMExample' diff --git a/JSON_Reader.py b/JSON_Reader.py new file mode 100644 index 0000000..b97c485 --- /dev/null +++ b/JSON_Reader.py @@ -0,0 +1,36 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# @author: Francesco Mangiacrapa +# +# Created on 2023/02/16 +# + +import json + +from URL_Reader_Util import URL_Reader + + +class JSON_Reader: + + def __init__(self, json_file_url): + try: + f = URL_Reader.read_file(json_file_url) + # returns JSON object as + # a dictionary + self.data = json.load(f) + except Exception as e: + print("Something went wrong %s" % e) + finally: + f.close() + + @staticmethod + def pretty_print_json(json_data, indent=2): + print("Json Data: \n%s" % json.dumps(json_data, indent=indent)) + + @staticmethod + def to_json(text): + return json.loads(text) + + def __str__(self): + return 'JSON_Reader' diff --git a/URL_Reader_Util.py b/URL_Reader_Util.py new file mode 100644 index 0000000..57be799 --- /dev/null +++ b/URL_Reader_Util.py @@ -0,0 +1,20 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# @author: Francesco Mangiacrapa +# +# Created on 2023/02/16 +# + +from urllib.request import urlopen + + +class URL_Reader: + + @staticmethod + def read_file(link): + try: + print("Reading the url: %s" % link) + return urlopen(link) + except Exception as e: + print("Something went wrong %s" % e) diff --git a/main.py b/main.py new file mode 100644 index 0000000..7fff735 --- /dev/null +++ b/main.py @@ -0,0 +1,235 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# @author: Francesco Mangiacrapa +# +# Created on 2023/02/16 +# +import requests +from JSON_Reader import JSON_Reader +from IAM_Token_Client import IAM_Token_Client + +# Test files URLs are located here +folder_test_files_url = 'https://code-repo.d4science.org/gCubeSystem/geoportal-esquilino-sample-python-client/raw/branch/master/test_files/' +dataset_json_filename = 'test_dataset_esquilino.json' +pdf_filename = 'file-example_PDF_1MB.pdf' +image_filenames = ['arco-di-san-vito.jpg', 'piazza_esquilino.jpg'] +shapefile_filename = 'area_di_scavo.shp' + +# The KC client UMA TOKEN +service_Client_ID = '' +service_Client_Secret = '' +gcube_context = '/d4science.research-infrastructures.eu/gCubeApps/Esquiline' + +# EndPoints +# D4Science IAM +IAM_URL = 'https://accounts.d4science.org/auth/realms/d4science/protocol/openid-connect/token' +# The Geoportal Service endpoint +geoportal_service_endpoint = 'https://geoportal-cms.int.d4science.net//geoportal-service/srv' + +# The UCD ID +UCD_ID = 'esquilino' + + +def request_UMA_Token(): + itr = IAM_Token_Client(IAM_URL, service_Client_ID, service_Client_Secret) + service_uma_token = itr.getUmaToken(gcube_context) + # print("Uma token is: %s" % service_uma_token) + return "Bearer " + service_uma_token + + +class Geoportal_Client_Esquilino(): + + def __init__(self): + self.init_sample_filesets_for_esquilino() + + def init_sample_filesets_for_esquilino(self): + self.fileset_fonteInformazione = { + "toSetAccess": { + "_policy": "OPEN", + "_license": "CCBYSA.4.0" + }, + "clashOption": "REPLACE_EXISTING", + "fieldDefinitionPath": "$.fonteInformazione._children[?(@.filesetIta)]", + "parentPath": "$.fonteInformazione", + "fieldName": "filesetIta", + "streams": [{"url": folder_test_files_url + pdf_filename, + "filename": pdf_filename}] + } + + self.fileset_documentazioneScientifica = { + "toSetAccess": { + "_policy": "OPEN", + "_license": "CCBYSA.4.0" + }, + "clashOption": "REPLACE_EXISTING", + "fieldDefinitionPath": "$.documentazioneScientifica._children[?(@.fileset)]", + "parentPath": "$.documentazioneScientifica", + "fieldName": "fileset", + "streams": [{"url": folder_test_files_url + pdf_filename, + "filename": pdf_filename}] + } + + self.fileset_datiAltimetrici = { + "toSetAccess": { + "_policy": "OPEN", + "_license": "CCBYSA.4.0" + }, + "clashOption": "REPLACE_EXISTING", + "fieldDefinitionPath": "$.datiAltimetrici._children[?(@.fileset)]", + "parentPath": "$.datiAltimetrici", + "fieldName": "fileset", + "streams": [{"url": folder_test_files_url + shapefile_filename, + "filename": shapefile_filename}] + } + + self.fileset_planimetria = { + "toSetAccess": { + "_policy": "OPEN", + "_license": "CCBYSA.4.0" + }, + "clashOption": "REPLACE_EXISTING", + "fieldDefinitionPath": "$.planimetria._children[?(@.fileset)]", + "parentPath": "$.planimetria", + "fieldName": "fileset", + "streams": [{"url": folder_test_files_url + shapefile_filename, + "filename": shapefile_filename}] + } + + def build_step(self, step_id): + step = { + "stepID": step_id + } + + return step + + # immaginiRappresentative' is managed as an Array by definition in the Esquilino UCD Model + def build_image_fileset(self, image_index, image_filename): + fileset_immagineRappresentativa = { + "toSetAccess": { + "_policy": "OPEN", + "_license": "CCBYSA.4.0" + }, + "clashOption": "REPLACE_EXISTING", + "fieldDefinitionPath": "$.immaginiRappresentative._children[?(@.fileset)]", + "parentPath": "$.immaginiRappresentative[{}]".format(image_index), + "fieldName": "fileset", + "streams": [{"url": folder_test_files_url + image_filename, + "filename": image_filename}] + } + + return fileset_immagineRappresentativa + + def get_ucd(self, ucd_id): + print("\nget_ucd()") + request_url = geoportal_service_endpoint + "/ucd/" + ucd_id + payload = "" + headers = { + 'Content-Type': 'application/json; charset=utf-8', + 'Authorization': request_UMA_Token() + } + print("calling: " + request_url) + return requests.request("GET", request_url, headers=headers, data=payload) + + def get_project(self, ucd_id, project_id): + print("\nget_project()") + request_url = geoportal_service_endpoint + "/projects/" + ucd_id + "/" + project_id + payload = "" + headers = { + 'Content-Type': 'application/json; charset=utf-8', + 'Authorization': request_UMA_Token() + } + print("calling: " + request_url) + return requests.request("GET", request_url, headers=headers, data=payload) + + def create_project(self, ucd_id, json_data): + print("\ncreate_project()") + request_url = geoportal_service_endpoint + "/projects/" + ucd_id + headers = { + 'Content-Type': 'application/json; charset=utf-8', + 'Authorization': request_UMA_Token() + } + print("calling: " + request_url) + print("json_data: " + str(json_data)) + return requests.post(request_url, headers=headers, json=json_data) + + def registrer_fileset(self, ucd_id, project_id, json_data): + print("\nregistrer_fileset()") + request_url = geoportal_service_endpoint + "/projects/" + ucd_id + "/registerFiles/" + project_id + headers = { + 'Content-Type': 'application/json; charset=utf-8', + 'Authorization': request_UMA_Token() + } + print("calling: " + request_url) + print("json_data: " + str(json_data)) + return requests.post(request_url, headers=headers, json=json_data) + + def perform_step(self, ucd_id, project_id, json_data): + print("\nperform_step()") + request_url = geoportal_service_endpoint + "/projects/" + ucd_id + "/step/" + project_id + headers = { + 'Content-Type': 'application/json; charset=utf-8', + 'Authorization': request_UMA_Token() + } + print("calling: " + request_url) + print("json_data: " + str(json_data)) + return requests.post(request_url, headers=headers, json=json_data) + + +def main(): + json_esquilino_url = folder_test_files_url + dataset_json_filename; + json_reader = JSON_Reader(json_esquilino_url) + print("\n\nREAD TEST ESQUILINO JSON") + JSON_Reader.pretty_print_json(json_reader.data, 3) + + gce = Geoportal_Client_Esquilino() + + # print("\n\nRead UCD for id "+UCD_ID) + # response = gce.get_ucd(UCD_ID) + # print("\n\nRequest UCD response for %s" % UCD_ID) + # print("Response code is %s" % response.status_code) + # JSON_Reader.pretty_print_json(response.json(), 3) + + print("\n\nCreate a Project for %s" % UCD_ID) + response = gce.create_project(UCD_ID, json_reader.data) + print("Response code is %s" % response.status_code) + print("Created the Project, response is: %s" % response.json()) + + # Reading the project_id from the response (just created Project) + json_data = JSON_Reader.to_json(response.text) + project_id = json_data["_id"] + + # Registering FILESETS for + # Fonte Informazione + response = gce.registrer_fileset(UCD_ID, project_id, gce.fileset_fonteInformazione) + print("Response code is %s" % response.status_code) + # Documentazione Scientifica + response = gce.registrer_fileset(UCD_ID, project_id, gce.fileset_documentazioneScientifica) + print("Response code is %s" % response.status_code) + # Immagini + image_1 = gce.build_image_fileset(0, image_filenames[0]) + response = gce.registrer_fileset(UCD_ID, project_id, image_1) + print("Response code is %s" % response.status_code) + image_2 = gce.build_image_fileset(1, image_filenames[1]) + response = gce.registrer_fileset(UCD_ID, project_id, image_2) + print("Response code is %s" % response.status_code) + # Dati Altimetrici + response = gce.registrer_fileset(UCD_ID, project_id, gce.fileset_datiAltimetrici) + print("Response code is %s" % response.status_code) + # Planimetria + response = gce.registrer_fileset(UCD_ID, project_id, gce.fileset_planimetria) + print("Response code is %s" % response.status_code) + + # Performing STEP PUBLISH + step_publish = gce.build_step("PUBLISH") + response = gce.perform_step(UCD_ID, project_id, step_publish) + print("Response code is %s" % response.status_code) + + # project_id = "" + # print("\n\nRead a Project for ucd "+UCD_ID+" and project "+project_id) + # response = gce.get_project(UCD_ID, project_id) + # print("Response code is %s" % response.status_code) + # print("\n\nCreate a Project response %s" % response.json()) + + +main()