CatalogueRevamping
/
docker-ckan
14
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Initial commit

This commit is contained in:
Emanuel Marzini 2024-04-13 08:48:15 +02:00
commit 4aec1a7efd
214 changed files with 11414 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

85
.env.example Normal file
View File

@ -0,0 +1,85 @@
# Container names
NGINX_CONTAINER_NAME=nginx
REDIS_CONTAINER_NAME=redis
POSTGRESQL_CONTAINER_NAME=db
SOLR_CONTAINER_NAME=solr
DATAPUSHER_CONTAINER_NAME=datapusher
CKAN_CONTAINER_NAME=ckan
WORKER_CONTAINER_NAME=ckan-worker
# Host Ports
CKAN_PORT_HOST=5000
NGINX_PORT_HOST=81
NGINX_SSLPORT_HOST=8443
# CKAN databases
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
POSTGRES_DB=postgres
POSTGRES_HOST=db
CKAN_DB_USER=ckandbuser
CKAN_DB_PASSWORD=ckandbpassword
CKAN_DB=ckandb
DATASTORE_READONLY_USER=datastore_ro
DATASTORE_READONLY_PASSWORD=datastore
DATASTORE_DB=datastore
CKAN_SQLALCHEMY_URL=postgresql://ckandbuser:ckandbpassword@db/ckandb
CKAN_DATASTORE_WRITE_URL=postgresql://ckandbuser:ckandbpassword@db/datastore
CKAN_DATASTORE_READ_URL=postgresql://datastore_ro:datastore@db/datastore
# Test database connections
TEST_CKAN_SQLALCHEMY_URL=postgres://ckan:ckan@db/ckan_test
TEST_CKAN_DATASTORE_WRITE_URL=postgresql://ckan:ckan@db/datastore_test
TEST_CKAN_DATASTORE_READ_URL=postgresql://datastore_ro:datastore@db/datastore_test
# Dev settings
USE_HTTPS_FOR_DEV=false
# CKAN core
CKAN_VERSION=2.10.0
CKAN_SITE_ID=default
CKAN_SITE_URL=https://localhost:8443
CKAN_PORT=5000
CKAN_PORT_HOST=5000
CKAN___BEAKER__SESSION__SECRET=CHANGE_ME
# See https://docs.ckan.org/en/latest/maintaining/configuration.html#api-token-settings
CKAN___API_TOKEN__JWT__ENCODE__SECRET=string:CHANGE_ME
CKAN___API_TOKEN__JWT__DECODE__SECRET=string:CHANGE_ME
CKAN_SYSADMIN_NAME=ckan_admin
CKAN_SYSADMIN_PASSWORD=test1234
CKAN_SYSADMIN_EMAIL=your_email@example.com
CKAN_STORAGE_PATH=/var/lib/ckan
CKAN_SMTP_SERVER=smtp.corporateict.domain:25
CKAN_SMTP_STARTTLS=True
CKAN_SMTP_USER=user
CKAN_SMTP_PASSWORD=pass
CKAN_SMTP_MAIL_FROM=ckan@localhost
TZ=UTC
# Solr
SOLR_IMAGE_VERSION=2.10-solr9
CKAN_SOLR_URL=http://solr:8983/solr/ckan
TEST_CKAN_SOLR_URL=http://solr:8983/solr/ckan
# Redis
REDIS_VERSION=6
CKAN_REDIS_URL=redis://redis:6379/1
TEST_CKAN_REDIS_URL=redis://redis:6379/1
# Datapusher
DATAPUSHER_VERSION=0.0.20
CKAN_DATAPUSHER_URL=http://datapusher:8800
CKAN__DATAPUSHER__CALLBACK_URL_BASE=http://ckan:5000
DATAPUSHER_REWRITE_RESOURCES=True
DATAPUSHER_REWRITE_URL=http://ckan:5000
# NGINX
NGINX_PORT=80
NGINX_SSLPORT=443
# Extensions
CKAN__PLUGINS="envvars image_view text_view recline_view datastore datapusher"
CKAN__HARVEST__MQ__TYPE=redis
CKAN__HARVEST__MQ__HOSTNAME=redis
CKAN__HARVEST__MQ__PORT=6379
CKAN__HARVEST__MQ__REDIS_DB=1

48
.github/workflows/build.yml vendored Normal file
View File

@ -0,0 +1,48 @@
name: Build CKAN Docker
on:
# Trigger the workflow on push or pull request,
# but only for the master branch
push:
branches:
- master
pull_request:
branches:
- master
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
- name: Set up QEMU
uses: docker/setup-qemu-action@v1
- name: NGINX build
uses: docker/build-push-action@v2
with:
context: ./nginx
file: ./nginx/Dockerfile
push: false
tags: kowhai/ckan-docker-nginx:test-build-only
- name: PostgreSQL build
uses: docker/build-push-action@v2
with:
context: ./postgresql
file: ./postgresql/Dockerfile
push: false
tags: kowhai/ckan-docker-postgresql:test-build-only
- name: CKAN build
uses: docker/build-push-action@v2
with:
context: ./ckan
file: ./ckan/Dockerfile
push: false
tags: kowhai/ckan-docker-ckan:test-build-only

10
.gitignore vendored Executable file
View File

@ -0,0 +1,10 @@
# generic
.DS_Store
.vagrant
# code & config
_service-provider/*
_solr/schema.xml
_src/*
local/*
.env

287
README.md Normal file
View File

@ -0,0 +1,287 @@
# Docker Compose setup for CKAN
* [Overview](#overview)
* [Installing Docker](#installing-docker)
* [docker compose vs docker-compose](#docker-compose-vs-docker-compose)
* [Install CKAN plus dependencies](#install-ckan-plus-dependencies)
* [Development mode](#development-mode)
* [Create an extension](#create-an-extension)
* [Running HTTPS on development mode](#running-https-on-development-mode)
* [CKAN images](#ckan-images)
* [Extending the base images](#extending-the-base-images)
* [Applying patches](#applying-patches)
* [Debugging with pdb](#pdb)
* [Datastore and Datapusher](#Datastore-and-datapusher)
* [NGINX](#nginx)
* [The ckanext-envvars extension](#envvars)
* [The CKAN_SITE_URL parameter](#CKAN_SITE_URL)
* [Changing the base image](#Changing-the-base-image)
* [Replacing DataPusher with XLoader](#Replacing-DataPusher-with-XLoader)
## 1. Overview
This is a set of configuration and setup files to run a CKAN site.
The CKAN images used are from the official CKAN [ckan-docker](https://github.com/ckan/ckan-docker-base) repo
The non-CKAN images are as follows:
* DataPusher: CKAN's [pre-configured DataPusher image](https://github.com/ckan/ckan-base/tree/main/datapusher).
* PostgreSQL: Official PostgreSQL image. Database files are stored in a named volume.
* Solr: CKAN's [pre-configured Solr image](https://github.com/ckan/ckan-solr). Index data is stored in a named volume.
* Redis: standard Redis image
* NGINX: latest stable nginx image that includes SSL and Non-SSL endpoints
The site is configured using environment variables that you can set in the `.env` file.
## 2. Installing Docker
Install Docker by following the following instructions: [Install Docker Engine on Ubuntu](https://docs.docker.com/engine/install/ubuntu/)
To verify a successful Docker installation, run `docker run hello-world` and `docker version`. These commands should output
versions for client and server.
## 3. docker compose *vs* docker-compose
All Docker Compose commands in this README will use the V2 version of Compose ie: `docker compose`. The older version (V1)
used the `docker-compose` command. Please see [Docker Compose](https://docs.docker.com/compose/compose-v2/) for
more information.
## 4. Install (build and run) CKAN plus dependencies
#### Base mode
Use this if you are a maintainer and will not be making code changes to CKAN or to CKAN extensions
Copy the included `.env.example` and rename it to `.env`. Modify it depending on your own needs.
Please note that when accessing CKAN directly (via a browser) ie: not going through NGINX you will need to make sure you have "ckan" set up
to be an alias to localhost in the local hosts file. Either that or you will need to change the `.env` entry for CKAN_SITE_URL
Using the default values on the `.env.example` file will get you a working CKAN instance. There is a sysadmin user created by default with the values defined in `CKAN_SYSADMIN_NAME` and `CKAN_SYSADMIN_PASSWORD`(`ckan_admin` and `test1234` by default). This should be obviously changed before running this setup as a public CKAN instance.
To build the images:
docker compose build
To start the containers:
docker compose up
This will start up the containers in the current window. By default the containers will log direct to this window with each container
using a different colour. You could also use the -d "detach mode" option ie: `docker compose up -d` if you wished to use the current
window for something else.
At the end of the container start sequence there should be 6 containers running
![Screenshot 2022-12-12 at 10 36 21 am](https://user-images.githubusercontent.com/54408245/207012236-f9571baa-4d99-4ffe-bd93-30b11c4829e0.png)
After this step, CKAN should be running at `CKAN_SITE_URL`.
#### Development mode
Use this mode if you are making code changes to CKAN and either creating new extensions or making code changes to existing extensions. This mode also uses the `.env` file for config options.
To develop local extensions use the `docker-compose.dev.yml` file:
To build the images:
docker compose -f docker-compose.dev.yml build
To start the containers:
docker compose -f docker-compose.dev.yml up
See [CKAN Images](#ckan-images) for more details of what happens when using development mode.
##### Create an extension
You can use the ckan [extension](https://docs.ckan.org/en/latest/extensions/tutorial.html#creating-a-new-extension) instructions to create a CKAN extension, only executing the command inside the CKAN container and setting the mounted `src/` folder as output:
docker compose -f docker-compose.dev.yml exec ckan-dev /bin/sh -c "ckan generate extension --output-dir /srv/app/src_extensions"
![Screenshot 2023-02-22 at 1 45 55 pm](https://user-images.githubusercontent.com/54408245/220623568-b4e074c7-6d07-4d27-ae29-35ce70961463.png)
The new extension files and directories are created in the `/srv/app/src_extensions/` folder in the running container. They will also exist in the local src/ directory as local `/src` directory is mounted as `/srv/app/src_extensions/` on the ckan container. You might need to change the owner of its folder to have the appropiate permissions.
##### Running HTTPS on development mode
Sometimes is useful to run your local development instance under HTTPS, for instance if you are using authentication extensions like [ckanext-saml2auth](https://github.com/keitaroinc/ckanext-saml2auth). To enable it, set the following in your `.env` file:
USE_HTTPS_FOR_DEV=true
and update the site URL setting:
CKAN_SITE_URL=https://localhost:5000
After recreating the `ckan-dev` container, you should be able to access CKAN at https://localhost:5000
## 5. CKAN images
![ckan images](https://user-images.githubusercontent.com/54408245/207079416-a01235af-2dea-4425-b6fd-f8c3687dd993.png)
The Docker image config files used to build your CKAN project are located in the `ckan/` folder. There are two Docker files:
* `Dockerfile`: this is based on `ckan/ckan-base:<version>`, a base image located in the DockerHub repository, that has CKAN installed along with all its dependencies, properly configured and running on [uWSGI](https://uwsgi-docs.readthedocs.io/en/latest/) (production setup)
* `Dockerfile.dev`: this is based on `ckan/ckan-base:<version>-dev` also located located in the DockerHub repository, and extends `ckan/ckan-base:<version>` to include:
* Any extension cloned on the `src` folder will be installed in the CKAN container when booting up Docker Compose (`docker compose up`). This includes installing any requirements listed in a `requirements.txt` (or `pip-requirements.txt`) file and running `python setup.py develop`.
* CKAN is started running this: `/usr/bin/ckan -c /srv/app/ckan.ini run -H 0.0.0.0`.
* Make sure to add the local plugins to the `CKAN__PLUGINS` env var in the `.env` file.
* Any custom changes to the scripts run during container start up can be made to scripts in the `setup/` directory. For instance if you wanted to change the port on which CKAN runs you would need to make changes to the Docker Compose yaml file, and the `start_ckan.sh.override` file. Then you would need to add the following line to the Dockerfile ie: `COPY setup/start_ckan.sh.override ${APP_DIR}/start_ckan.sh`. The `start_ckan.sh` file in the locally built image would override the `start_ckan.sh` file included in the base image
## 6. Extending the base images
You can modify the docker files to build your own customized image tailored to your project, installing any extensions and extra requirements needed. For example here is where you would update to use a different CKAN base image ie: `ckan/ckan-base:<new version>`
To perform extra initialization steps you can add scripts to your custom images and copy them to the `/docker-entrypoint.d` folder (The folder should be created for you when you build the image). Any `*.sh` and `*.py` file in that folder will be executed just after the main initialization script ([`prerun.py`](https://github.com/ckan/ckan-docker-base/blob/main/ckan-2.9/base/setup/prerun.py)) is executed and just before the web server and supervisor processes are started.
For instance, consider the following custom image:
```
ckan
├── docker-entrypoint.d
│ └── setup_validation.sh
├── Dockerfile
└── Dockerfile.dev
```
We want to install an extension like [ckanext-validation](https://github.com/frictionlessdata/ckanext-validation) that needs to create database tables on startup time. We create a `setup_validation.sh` script in a `docker-entrypoint.d` folder with the necessary commands:
```bash
#!/bin/bash
# Create DB tables if not there
ckan -c /srv/app/ckan.ini validation init-db
```
And then in our `Dockerfile.dev` file we install the extension and copy the initialization scripts:
```Dockerfile
FROM ckan/ckan-base:2.9.7-dev
RUN pip install -e git+https://github.com/frictionlessdata/ckanext-validation.git#egg=ckanext-validation && \
pip install -r https://raw.githubusercontent.com/frictionlessdata/ckanext-validation/master/requirements.txt
COPY docker-entrypoint.d/* /docker-entrypoint.d/
```
NB: There are a number of extension examples commented out in the Dockerfile.dev file
## 7. Applying patches
When building your project specific CKAN images (the ones defined in the `ckan/` folder), you can apply patches
to CKAN core or any of the built extensions. To do so create a folder inside `ckan/patches` with the name of the
package to patch (ie `ckan` or `ckanext-??`). Inside you can place patch files that will be applied when building
the images. The patches will be applied in alphabetical order, so you can prefix them sequentially if necessary.
For instance, check the following example image folder:
```
ckan
├── patches
│ ├── ckan
│ │ ├── 01_datasets_per_page.patch
│ │ ├── 02_groups_per_page.patch
│ │ ├── 03_or_filters.patch
│ └── ckanext-harvest
│ └── 01_resubmit_objects.patch
├── setup
├── Dockerfile
└── Dockerfile.dev
```
## 8. pdb
Add these lines to the `ckan-dev` service in the docker-compose.dev.yml file
![pdb](https://user-images.githubusercontent.com/54408245/179964232-9e98a451-5fe9-4842-ba9b-751bcc627730.png)
Debug with pdb (example) - Interact with `docker attach $(docker container ls -qf name=ckan)`
command: `python -m pdb /usr/lib/ckan/venv/bin/ckan --config /srv/app/ckan.ini run --host 0.0.0.0 --passthrough-errors`
## 9. Datastore and datapusher
The Datastore database and user is created as part of the entrypoint scripts for the db container. There is also a Datapusher container
running the latest version of Datapusher.
## 10. NGINX
The base Docker Compose configuration uses an NGINX image as the front-end (ie: reverse proxy). It includes HTTPS running on port number 8443. A "self-signed" SSL certificate is generated as part of the ENTRYPOINT. The NGINX `server_name` directive and the `CN` field in the SSL certificate have been both set to 'localhost'. This should obviously not be used for production.
Creating the SSL cert and key files as follows:
`openssl req -new -newkey rsa:4096 -days 365 -nodes -x509 -subj "/C=DE/ST=Berlin/L=Berlin/O=None/CN=localhost" -keyout ckan-local.key -out ckan-local.crt`
The `ckan-local.*` files will then need to be moved into the nginx/setup/ directory
## 11. envvars
The ckanext-envvars extension is used in the CKAN Docker base repo to build the base images.
This extension checks for environmental variables conforming to an expected format and updates the corresponding CKAN config settings with its value.
For the extension to correctly identify which env var keys map to the format used for the config object, env var keys should be formatted in the following way:
All uppercase
Replace periods ('.') with two underscores ('__')
Keys must begin with 'CKAN' or 'CKANEXT', if they do not you can prepend them with '`CKAN___`'
For example:
* `CKAN__PLUGINS="envvars image_view text_view recline_view datastore datapusher"`
* `CKAN__DATAPUSHER__CALLBACK_URL_BASE=http://ckan:5000`
* `CKAN___BEAKER__SESSION__SECRET=CHANGE_ME`
These parameters can be added to the `.env` file
For more information please see [ckanext-envvars](https://github.com/okfn/ckanext-envvars)
## 12. CKAN_SITE_URL
For convenience the CKAN_SITE_URL parameter should be set in the .env file. For development it can be set to http://localhost:5000 and non-development set to https://localhost:8443
## 13. Manage new users
1. Create a new user from the Docker host, for example to create a new user called 'admin'
`docker exec -it <container-id> ckan -c ckan.ini user add admin email=admin@localhost`
To delete the 'admin' user
`docker exec -it <container-id> ckan -c ckan.ini user remove admin`
2. Create a new user from within the ckan container. You will need to get a session on the running container
`ckan -c ckan.ini user add admin email=admin@localhost`
To delete the 'admin' user
`ckan -c ckan.ini user remove admin`
## 14. Changing the base image
The base image used in the CKAN Dockerfile and Dockerfile.dev can be changed so a different DockerHub image is used eg: ckan/ckan-base:2.9.9
could be used instead of ckan/ckan-base:2.10.1
## 15. Replacing DataPusher with XLoader
Check out the wiki page for this: https://github.com/ckan/ckan-docker/wiki/Replacing-DataPusher-with-XLoader
Copying and License
-------------------
This material is copyright (c) 2006-2023 Open Knowledge Foundation and contributors.
It is open and licensed under the GNU Affero General Public License (AGPL) v3.0
whose full text may be found at:
http://www.fsf.org/licensing/licenses/agpl-3.0.html

19
ckan/Dockerfile Normal file
View File

@ -0,0 +1,19 @@
FROM ckan/ckan-base:2.10.4
# Install any extensions needed by your CKAN instance
# See Dockerfile.dev for more details and examples
# Copy custom initialization scripts
COPY docker-entrypoint.d/* /docker-entrypoint.d/
# Apply any patches needed to CKAN core or any of the built extensions (not the
# runtime mounted ones)
COPY patches ${APP_DIR}/patches
RUN for d in $APP_DIR/patches/*; do \
if [ -d $d ]; then \
for f in `ls $d/*.patch | sort -g`; do \
cd $SRC_DIR/`basename "$d"` && echo "$0: Applying patch $f to $SRC_DIR/`basename $d`"; patch -p1 < "$f" ; \
done ; \
fi ; \
done

97
ckan/Dockerfile.dev Normal file
View File

@ -0,0 +1,97 @@
FROM ckan/ckan-dev:2.10.4
RUN pip install --upgrade pip
ENV PROJ_DIR=/usr
RUN apk add proj proj-dev
RUN apk add proj-util
# Install any extensions needed by your CKAN instance
# - Make sure to add the plugins to CKAN__PLUGINS in the .env file
# - Also make sure all provide all extra configuration options, either by:
# * Adding them to the .env file (check the ckanext-envvars syntax for env vars), or
# * Adding extra configuration scripts to /docker-entrypoint.d folder) to update
# the CKAN config file (ckan.ini) with the `ckan config-tool` command
#
# See README > Extending the base images for more details
#
# For instance:
#
### XLoader ###
#RUN pip3 install -e 'git+https://github.com/ckan/ckanext-xloader.git@master#egg=ckanext-xloader' && \
# pip3 install -r ${APP_DIR}/src/ckanext-xloader/requirements.txt && \
# pip3 install -U requests[security]
### Harvester ###
#RUN pip3 install -e 'git+https://github.com/ckan/ckanext-harvest.git@master#egg=ckanext-harvest' && \
# pip3 install -r ${APP_DIR}/src/ckanext-harvest/pip-requirements.txt
# will also require gather_consumer and fetch_consumer processes running (please see https://github.com/ckan/ckanext-harvest)
RUN pip install -e git+https://github.com/ckan/ckanext-harvest.git@v1.5.6#egg=ckanext-harvest \
pip install -r https://raw.githubusercontent.com/ckan/ckanext-harvest/v1.5.6/requirements.txt
### Scheming ###
#RUN pip3 install -e 'git+https://github.com/ckan/ckanext-scheming.git@master#egg=ckanext-scheming'
### Pages ###
#RUN pip3 install -e git+https://github.com/ckan/ckanext-pages.git#egg=ckanext-pages
### DCAT ###
RUN pip install -e git+https://github.com/ckan/ckanext-dcat.git@v1.6.0#egg=ckanext-dcat && \
pip install -r https://raw.githubusercontent.com/ckan/ckanext-dcat/v1.6.0/requirements.txt
### SPATIAL ###
RUN pip install pyproj==3.6.1
RUN pip install geos
RUN apk add py3-pip
RUN pip install pymap3d
RUN apk --update add build-base libxslt-dev
RUN apk add --virtual .build-deps \
--repository http://dl-cdn.alpinelinux.org/alpine/edge/testing \
--repository http://dl-cdn.alpinelinux.org/alpine/edge/main \
gcc libc-dev geos-dev geos && \
runDeps="$(scanelf --needed --nobanner --recursive /usr/local \
| awk '{ gsub(/,/, "\nso:", $2); print "so:" $2 }' \
| xargs -r apk info --installed \
| sort -u)" && \
apk add --virtual .rundeps $runDeps
RUN geos-config --cflags
#RUN pip install --disable-pip-version-check shapely
#RUN apk del build-base python3-dev && \
# rm -rf /var/cache/apk/*
RUN apk add --no-cache python3-dev libstdc++ && \
apk add --no-cache g++ && \
ln -s /usr/include/locale.h /usr/include/xlocale.h && \
pip3 install numpy && \
pip3 install pandas
RUN pip install shapely
RUN pip install -e git+https://github.com/ckan/ckanext-spatial.git@v2.1.1#egg=ckanext-spatial
RUN pip install -r https://raw.githubusercontent.com/ckan/ckanext-spatial/v2.1.1/requirements.txt
RUN pip install WebHelpers2 \
pip install xmltodict \
pip install pyqrcode
# Clone the extension(s) your are writing for your own project in the `src` folder
# to get them mounted in this image at runtime
# Copy custom initialization scripts
COPY docker-entrypoint.d/* /docker-entrypoint.d/
# Apply any patches needed to CKAN core or any of the built extensions (not the
# runtime mounted ones)
COPY patches ${APP_DIR}/patches
RUN for d in $APP_DIR/patches/*; do \
if [ -d $d ]; then \
for f in `ls $d/*.patch | sort -g`; do \
cd $SRC_DIR/`basename "$d"` && echo "$0: Applying patch $f to $SRC_DIR/`basename $d`"; patch -p1 < "$f" ; \
done ; \
fi ; \
done

12
ckan/docker-entrypoint.d/01_setup_datapusher.sh Normal file
View File

@ -0,0 +1,12 @@
#!/bin/bash
if [[ $CKAN__PLUGINS == *"datapusher"* ]]; then
# Datapusher settings have been configured in the .env file
# Set API token if necessary
if [ -z "$CKAN__DATAPUSHER__API_TOKEN" ] ; then
echo "Set up ckan.datapusher.api_token in the CKAN config file"
ckan config-tool $CKAN_INI "ckan.datapusher.api_token=$(ckan -c $CKAN_INI user token add ckan_admin datapusher | tail -n 1 | tr -d '\t')"
fi
else
echo "Not configuring DataPusher"
fi

4
ckan/docker-entrypoint.d/README.md Normal file
View File

@ -0,0 +1,4 @@
Use scripts in this folder to run extra initialization steps in your custom CKAN images.
Any file with `.sh` or `.py` extension will be executed just after the main initialization
script (`prerun.py`) is executed and just before the web server and supervisor processes are
started.

1
ckan/patches/00_test_test.patch Normal file
View File

@ -0,0 +1 @@
test

212
ckan/setup/prerun.py.override Normal file
View File

@ -0,0 +1,212 @@
import os
import sys
import subprocess
import psycopg2
try:
from urllib.request import urlopen
from urllib.error import URLError
except ImportError:
from urllib2 import urlopen
from urllib2 import URLError
import time
import re
import json
ckan_ini = os.environ.get("CKAN_INI", "/srv/app/ckan.ini")
RETRY = 5
def update_plugins():
plugins = os.environ.get("CKAN__PLUGINS", "")
print(("[prerun] Setting the following plugins in {}:".format(ckan_ini)))
print(plugins)
cmd = ["ckan", "config-tool", ckan_ini, "ckan.plugins = {}".format(plugins)]
subprocess.check_output(cmd, stderr=subprocess.STDOUT)
print("[prerun] Plugins set.")
def check_main_db_connection(retry=None):
conn_str = os.environ.get("CKAN_SQLALCHEMY_URL")
if not conn_str:
print("[prerun] CKAN_SQLALCHEMY_URL not defined, not checking db")
return check_db_connection(conn_str, retry)
def check_datastore_db_connection(retry=None):
conn_str = os.environ.get("CKAN_DATASTORE_WRITE_URL")
if not conn_str:
print("[prerun] CKAN_DATASTORE_WRITE_URL not defined, not checking db")
return check_db_connection(conn_str, retry)
def check_db_connection(conn_str, retry=None):
if retry is None:
retry = RETRY
elif retry == 0:
print("[prerun] Giving up after 5 tries...")
sys.exit(1)
try:
connection = psycopg2.connect(conn_str)
except psycopg2.Error as e:
print(str(e))
print("[prerun] Unable to connect to the database, waiting...")
time.sleep(10)
check_db_connection(conn_str, retry=retry - 1)
else:
connection.close()
def check_solr_connection(retry=None):
if retry is None:
retry = RETRY
elif retry == 0:
print("[prerun] Giving up after 5 tries...")
sys.exit(1)
url = os.environ.get("CKAN_SOLR_URL", "")
search_url = '{url}/schema/name?wt=json'.format(url=url)
try:
connection = urlopen(search_url)
except URLError as e:
print(str(e))
print("[prerun] Unable to connect to solr, waiting...")
time.sleep(10)
check_solr_connection(retry=retry - 1)
else:
import re
conn_info = connection.read()
schema_name = json.loads(conn_info)
if 'ckan' in schema_name['name']:
print('[prerun] Succesfully connected to solr and CKAN schema loaded')
else:
print('[prerun] Succesfully connected to solr, but CKAN schema not found')
def init_db():
db_command = ["ckan", "-c", ckan_ini, "db", "init"]
print("[prerun] Initializing or upgrading db - start")
try:
subprocess.check_output(db_command, stderr=subprocess.STDOUT)
print("[prerun] Initializing or upgrading db - end")
except subprocess.CalledProcessError as e:
if "OperationalError" in e.output:
print(e.output)
print("[prerun] Database not ready, waiting a bit before exit...")
time.sleep(5)
sys.exit(1)
else:
print(e.output)
raise e
def init_datastore_db():
conn_str = os.environ.get("CKAN_DATASTORE_WRITE_URL")
if not conn_str:
print("[prerun] Skipping datastore initialization")
return
datastore_perms_command = ["ckan", "-c", ckan_ini, "datastore", "set-permissions"]
connection = psycopg2.connect(conn_str)
cursor = connection.cursor()
print("[prerun] Initializing datastore db - start")
try:
datastore_perms = subprocess.Popen(
datastore_perms_command, stdout=subprocess.PIPE
)
perms_sql = datastore_perms.stdout.read()
# Remove internal pg command as psycopg2 does not like it
perms_sql = re.sub(b'\\\\connect "(.*)"', b"", perms_sql)
cursor.execute(perms_sql)
for notice in connection.notices:
print(notice)
connection.commit()
print("[prerun] Initializing datastore db - end")
print(datastore_perms.stdout.read())
except psycopg2.Error as e:
print("[prerun] Could not initialize datastore")
print(str(e))
except subprocess.CalledProcessError as e:
if "OperationalError" in e.output:
print(e.output)
print("[prerun] Database not ready, waiting a bit before exit...")
time.sleep(5)
sys.exit(1)
else:
print(e.output)
raise e
finally:
cursor.close()
connection.close()
def create_sysadmin():
name = os.environ.get("CKAN_SYSADMIN_NAME")
password = os.environ.get("CKAN_SYSADMIN_PASSWORD")
email = os.environ.get("CKAN_SYSADMIN_EMAIL")
if name and password and email:
# Check if user exists
command = ["ckan", "-c", ckan_ini, "user", "show", name]
out = subprocess.check_output(command)
if b"User:None" not in re.sub(b"\s", b"", out):
print("[prerun] Sysadmin user exists, skipping creation")
return
# Create user
command = [
"ckan",
"-c",
ckan_ini,
"user",
"add",
name,
"password=" + password,
"email=" + email,
]
subprocess.call(command)
print("[prerun] Created user {0}".format(name))
# Make it sysadmin
command = ["ckan", "-c", ckan_ini, "sysadmin", "add", name]
subprocess.call(command)
print("[prerun] Made user {0} a sysadmin".format(name))
if __name__ == "__main__":
maintenance = os.environ.get("MAINTENANCE_MODE", "").lower() == "true"
if maintenance:
print("[prerun] Maintenance mode, skipping setup...")
else:
check_main_db_connection()
init_db()
update_plugins()
check_datastore_db_connection()
init_datastore_db()
check_solr_connection()
create_sysadmin()

57
ckan/setup/start_ckan.sh.override Executable file
View File

@ -0,0 +1,57 @@
#!/bin/sh
# Add ckan.datapusher.api_token to the CKAN config file (updated with corrected value later)
ckan config-tool $CKAN_INI ckan.datapusher.api_token=xxx
# Set up the Secret key used by Beaker and Flask
# This can be overriden using a CKAN___BEAKER__SESSION__SECRET env var
if grep -E "beaker.session.secret ?= ?$" ckan.ini
then
echo "Setting beaker.session.secret in ini file"
ckan config-tool $CKAN_INI "beaker.session.secret=$(python3 -c 'import secrets; print(secrets.token_urlsafe())')"
ckan config-tool $CKAN_INI "WTF_CSRF_SECRET_KEY=$(python3 -c 'import secrets; print(secrets.token_urlsafe())')"
JWT_SECRET=$(python3 -c 'import secrets; print("string:" + secrets.token_urlsafe())')
ckan config-tool $CKAN_INI "api_token.jwt.encode.secret=${JWT_SECRET}"
ckan config-tool $CKAN_INI "api_token.jwt.decode.secret=${JWT_SECRET}"
fi
# Run the prerun script to init CKAN and create the default admin user
sudo -u ckan -EH python3 prerun.py
echo "Set up ckan.datapusher.api_token in the CKAN config file"
ckan config-tool $CKAN_INI "ckan.datapusher.api_token=$(ckan -c $CKAN_INI user token add ckan_admin datapusher | tail -n 1 | tr -d '\t')"
# Run any startup scripts provided by images extending this one
if [[ -d "/docker-entrypoint.d" ]]
then
for f in /docker-entrypoint.d/*; do
case "$f" in
*.sh) echo "$0: Running init file $f"; . "$f" ;;
*.py) echo "$0: Running init file $f"; python3 "$f"; echo ;;
*) echo "$0: Ignoring $f (not an sh or py file)" ;;
esac
echo
done
fi
# Set the common uwsgi options
UWSGI_OPTS="--plugins http,python \
--socket /tmp/uwsgi.sock \
--wsgi-file /srv/app/wsgi.py \
--module wsgi:application \
--uid 92 --gid 92 \
--http 0.0.0.0:5000 \
--master --enable-threads \
--lazy-apps \
-p 2 -L -b 32768 --vacuum \
--harakiri $UWSGI_HARAKIRI"
if [ $? -eq 0 ]
then
# Start supervisord
supervisord --configuration /etc/supervisord.conf &
# Start uwsgi
sudo -u ckan -EH uwsgi $UWSGI_OPTS
else
echo "[prerun] failed...not starting CKAN."
fi

99
ckan/setup/start_ckan_development.sh.override Executable file
View File

@ -0,0 +1,99 @@
#!/bin/sh
# Install any local extensions in the src_extensions volume
echo "Looking for local extensions to install..."
echo "Extension dir contents:"
ls -la $SRC_EXTENSIONS_DIR
for i in $SRC_EXTENSIONS_DIR/*
do
if [ -d $i ];
then
if [ -f $i/pip-requirements.txt ];
then
pip install -r $i/pip-requirements.txt
echo "Found requirements file in $i"
fi
if [ -f $i/requirements.txt ];
then
pip install -r $i/requirements.txt
echo "Found requirements file in $i"
fi
if [ -f $i/dev-requirements.txt ];
then
pip install -r $i/dev-requirements.txt
echo "Found dev-requirements file in $i"
fi
if [ -f $i/setup.py ];
then
cd $i
python3 $i/setup.py develop
echo "Found setup.py file in $i"
cd $APP_DIR
fi
# Point `use` in test.ini to location of `test-core.ini`
if [ -f $i/test.ini ];
then
echo "Updating \`test.ini\` reference to \`test-core.ini\` for plugin $i"
ckan config-tool $i/test.ini "use = config:../../src/ckan/test-core.ini"
fi
fi
done
# Set debug to true
echo "Enabling debug mode"
ckan config-tool $CKAN_INI -s DEFAULT "debug = true"
# Add ckan.datapusher.api_token to the CKAN config file (updated with corrected value later)
ckan config-tool $CKAN_INI ckan.datapusher.api_token=xxx
# Set up the Secret key used by Beaker and Flask
# This can be overriden using a CKAN___BEAKER__SESSION__SECRET env var
if grep -E "beaker.session.secret ?= ?$" ckan.ini
then
echo "Setting beaker.session.secret in ini file"
ckan config-tool $CKAN_INI "beaker.session.secret=$(python3 -c 'import secrets; print(secrets.token_urlsafe())')"
ckan config-tool $CKAN_INI "WTF_CSRF_SECRET_KEY=$(python3 -c 'import secrets; print(secrets.token_urlsafe())')"
JWT_SECRET=$(python3 -c 'import secrets; print("string:" + secrets.token_urlsafe())')
ckan config-tool $CKAN_INI "api_token.jwt.encode.secret=${JWT_SECRET}"
ckan config-tool $CKAN_INI "api_token.jwt.decode.secret=${JWT_SECRET}"
fi
# Update the plugins setting in the ini file with the values defined in the env var
echo "Loading the following plugins: $CKAN__PLUGINS"
ckan config-tool $CKAN_INI "ckan.plugins = $CKAN__PLUGINS"
# Update test-core.ini DB, SOLR & Redis settings
echo "Loading test settings into test-core.ini"
ckan config-tool $SRC_DIR/ckan/test-core.ini \
"sqlalchemy.url = $TEST_CKAN_SQLALCHEMY_URL" \
"ckan.datastore.write_url = $TEST_CKAN_DATASTORE_WRITE_URL" \
"ckan.datastore.read_url = $TEST_CKAN_DATASTORE_READ_URL" \
"solr_url = $TEST_CKAN_SOLR_URL" \
"ckan.redis.url = $TEST_CKAN_REDIS_URL"
# Run the prerun script to init CKAN and create the default admin user
sudo -u ckan -EH python3 prerun.py
echo "Set up ckan.datapusher.api_token in the CKAN config file"
ckan config-tool $CKAN_INI "ckan.datapusher.api_token=$(ckan -c $CKAN_INI user token add ckan_admin datapusher | tail -n 1 | tr -d '\t')"
# Run any startup scripts provided by images extending this one
if [[ -d "/docker-entrypoint.d" ]]
then
for f in /docker-entrypoint.d/*; do
case "$f" in
*.sh) echo "$0: Running init file $f"; . "$f" ;;
*.py) echo "$0: Running init file $f"; python3 "$f"; echo ;;
*) echo "$0: Ignoring $f (not an sh or py file)" ;;
esac
echo
done
fi
# Start supervisord
supervisord --configuration /etc/supervisord.conf &
# Start the development server with automatic reload
sudo -u ckan -EH ckan -c $CKAN_INI run -H 0.0.0.0

71
docker-compose.dev.yml Executable file
View File

@ -0,0 +1,71 @@
version: "3"
volumes:
ckan_storage:
pg_data:
solr_data:
services:
ckan-dev:
build:
context: ckan/
dockerfile: Dockerfile.dev
args:
- TZ=${TZ}
env_file:
- .env
depends_on:
db:
condition: service_healthy
solr:
condition: service_healthy
redis:
condition: service_healthy
ports:
- "0.0.0.0:${CKAN_PORT_HOST}:${CKAN_PORT}"
volumes:
- ckan_storage:/var/lib/ckan
- ./src:/srv/app/src_extensions
restart: unless-stopped
healthcheck:
test: ["CMD", "wget", "-qO", "/dev/null", "http://localhost:5000"]
datapusher:
image: ckan/ckan-base-datapusher:${DATAPUSHER_VERSION}
restart: unless-stopped
healthcheck:
test: ["CMD", "wget", "-qO", "/dev/null", "http://localhost:8800"]
db:
build:
context: postgresql/
environment:
- POSTGRES_USER
- POSTGRES_PASSWORD
- POSTGRES_DB
- CKAN_DB_USER
- CKAN_DB_PASSWORD
- CKAN_DB
- DATASTORE_READONLY_USER
- DATASTORE_READONLY_PASSWORD
- DATASTORE_DB
volumes:
- pg_data:/var/lib/postgresql/data
restart: unless-stopped
healthcheck:
test: ["CMD", "pg_isready", "-U", "${POSTGRES_USER}", "-d", "${POSTGRES_DB}"]
solr:
image: ckan/ckan-solr:${SOLR_IMAGE_VERSION}
volumes:
- solr_data:/var/solr
restart: unless-stopped
healthcheck:
test: ["CMD", "wget", "-qO", "/dev/null", "http://localhost:8983/solr/"]
redis:
image: redis:${REDIS_VERSION}
restart: unless-stopped
healthcheck:
test: ["CMD", "redis-cli", "-e", "QUIT"]

112
docker-compose.yml Executable file
View File

@ -0,0 +1,112 @@
version: "3"
volumes:
ckan_storage:
pg_data:
solr_data:
services:
nginx:
container_name: ${NGINX_CONTAINER_NAME}
build:
context: nginx/
dockerfile: Dockerfile
networks:
- webnet
- ckannet
depends_on:
ckan:
condition: service_healthy
ports:
- "0.0.0.0:${NGINX_SSLPORT_HOST}:${NGINX_SSLPORT}"
ckan:
container_name: ${CKAN_CONTAINER_NAME}
build:
context: ckan/
dockerfile: Dockerfile
args:
- TZ=${TZ}
networks:
- ckannet
- dbnet
- solrnet
- redisnet
env_file:
- .env
depends_on:
db:
condition: service_healthy
solr:
condition: service_healthy
redis:
condition: service_healthy
volumes:
- ckan_storage:/var/lib/ckan
restart: unless-stopped
healthcheck:
test: ["CMD", "wget", "-qO", "/dev/null", "http://localhost:5000"]
datapusher:
container_name: ${DATAPUSHER_CONTAINER_NAME}
networks:
- ckannet
- dbnet
image: ckan/ckan-base-datapusher:${DATAPUSHER_VERSION}
restart: unless-stopped
healthcheck:
test: ["CMD", "wget", "-qO", "/dev/null", "http://localhost:8800"]
db:
container_name: ${POSTGRESQL_CONTAINER_NAME}
build:
context: postgresql/
networks:
- dbnet
environment:
- POSTGRES_USER
- POSTGRES_PASSWORD
- POSTGRES_DB
- CKAN_DB_USER
- CKAN_DB_PASSWORD
- CKAN_DB
- DATASTORE_READONLY_USER
- DATASTORE_READONLY_PASSWORD
- DATASTORE_DB
volumes:
- pg_data:/var/lib/postgresql/data
restart: unless-stopped
healthcheck:
test: ["CMD", "pg_isready", "-U", "${POSTGRES_USER}", "-d", "${POSTGRES_DB}"]
solr:
container_name: ${SOLR_CONTAINER_NAME}
networks:
- solrnet
image: ckan/ckan-solr:${SOLR_IMAGE_VERSION}
volumes:
- solr_data:/var/solr
restart: unless-stopped
healthcheck:
test: ["CMD", "wget", "-qO", "/dev/null", "http://localhost:8983/solr/"]
redis:
container_name: ${REDIS_CONTAINER_NAME}
image: redis:${REDIS_VERSION}
networks:
- redisnet
restart: unless-stopped
healthcheck:
test: ["CMD", "redis-cli", "-e", "QUIT"]
networks:
webnet:
ckannet:
solrnet:
internal: true
dbnet:
internal: true
redisnet:
internal: true

23
nginx/Dockerfile Normal file
View File

@ -0,0 +1,23 @@
FROM nginx:stable-alpine
ENV NGINX_DIR=/etc/nginx
RUN apk update --no-cache && \
apk upgrade --no-cache && \
apk add --no-cache openssl
COPY setup/nginx.conf ${NGINX_DIR}/nginx.conf
COPY setup/index.html /usr/share/nginx/html/index.html
COPY setup/default.conf ${NGINX_DIR}/conf.d/
RUN mkdir -p ${NGINX_DIR}/certs
ENTRYPOINT \
openssl req \
-subj '/C=DE/ST=Berlin/L=Berlin/O=None/CN=localhost' \
-x509 -newkey rsa:4096 \
-nodes -keyout /etc/nginx/ssl/default_key.pem \
-keyout ${NGINX_DIR}/certs/ckan-local.key \
-out ${NGINX_DIR}/certs/ckan-local.crt \
-days 365 && \
nginx -g 'daemon off;'

30
nginx/setup/ckan-local.crt Normal file
View File

@ -0,0 +1,30 @@
-----BEGIN CERTIFICATE-----
MIIFIDCCAwgCCQDr3dGZoSvqMDANBgkqhkiG9w0BAQsFADBSMQswCQYDVQQGEwJE
RTEPMA0GA1UECAwGQmVybGluMQ8wDQYDVQQHDAZCZXJsaW4xDTALBgNVBAoMBE5v
bmUxEjAQBgNVBAMMCWxvY2FsaG9zdDAeFw0yMzAzMzEwMjM1MjZaFw0yNDAzMzAw
MjM1MjZaMFIxCzAJBgNVBAYTAkRFMQ8wDQYDVQQIDAZCZXJsaW4xDzANBgNVBAcM
BkJlcmxpbjENMAsGA1UECgwETm9uZTESMBAGA1UEAwwJbG9jYWxob3N0MIICIjAN
BgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEApej5FEF4lCOAmmUaAr67w6Go2XZO
crV2UoWbJQq+aC688XpSX5MaxBVK7r4MQGvwC0u/5aN50fyGQBWGeiY6/27MbGHA
fimLtGAmHf5ys4FYtD71YYV0ekUMvlTV1flV3gdM3JItlkXR8ukqIb6WlAGv4vS3
31QdoUyd7bGbCMmtDJ2ecnSlO5U0l9Udoqz4+cDPUMWMc1rXw9DfK/mzm+KR3iW+
QdWwbWj+Crd/aBKiofKIscq2svRfcVisxSbPr4ib1iMEAxes3nt2cBYNQe8H2OVh
SHbskKtaVgG5d+X+f/Mo+P6/1wrqY1JBgkegWkpcaz5mlT4tjsiudfmKsRRnKqHP
m5qohWBZxH2MDWX1ggJsziI546a5Y0lkvazql8QUd44X/vrWnx37sCn50Dj8DRAf
xtzNAC4doO+nIS+NC964yr6Ps4NrZE++WP5Ry6VUKhl46JSRkg6vtc27ZRrGn6LS
AmWU/Ob6/9UaPQkWZ3A/iDnkrkBflM6wdaD/EQmb5LLou84dhZCivqEJ6/5TdB3c
8w5muTQY2SLY9JmvECNQpfviD1IdXq7zqeH23L/hgE9i3GrYGWqGc9E3cjNht8Qt
hF7WbRaomzbjH6ChZTtiSEw3wtf6bTLKuJjWCBDbp+GypyfDWrvJI2UFVwtH5QMv
HYvxG4t+u+E6F2MCAwEAATANBgkqhkiG9w0BAQsFAAOCAgEAQcFH6iKXcErUuPJv
N+EdDfJh8CTvbqnp7SXOBQ2Q66NhsTZXPrpyOzT3APoeineWhwt7YZF59m02O1Ek
yS2qVEdAI9vDgmRvR6ryRsaEkLvnbhfTsBkN56c2oLTxqHBHooAyBKVIl0rSplW9
EYhZ9t+08QNd/2unEipgTMFUM+JIMMzseKDwrug97tGsCftIPeWddkPchT309Lwr
ECl2JsXX4t67oNR54hqRRvxyriSx/E8BF7rupsnaGNdNPPASoBbGVGEWumUutWMh
PzlkyOgpl5fZ44WqYOBvBeLGGPTkM3uoaySv6GNOAxFsXJfHXCq59TL93LRn4RKs
rik07ZabYa95JFAPUUSzMpplU4RCpE6r+MFceb1WMrDpK/4zoLLeIwmlwiHsrg/6
L0tN1/RLVQwvpxiVqlmETlyDmqFC+McURNU1ZJU2V8efQTWhDVnB7rNVefQsbTLN
5jaWiKMKQxva2Skf1jgVT9JOfYYCRlHpryOp9yIrqQqVxlaaDJz/Jm91Pt4QhCDj
VhSMDYVMFtE/ylMbB1qR3MJBw0xCCG4zdZpUzvFfR6/wQ5FZ4DvXsbYnsxX/JhgV
sTqxkdnhhR0UsxuHyxGWVPPxS+5IZdxVETcjrMVeaK9PAHyBBSI4DQHYIJWoyZ3m
y9oQx2IvfVXpGptadU5EKWM6210=
-----END CERTIFICATE-----

52
nginx/setup/ckan-local.key Normal file
View File

@ -0,0 +1,52 @@
-----BEGIN PRIVATE KEY-----
MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQCl6PkUQXiUI4Ca
ZRoCvrvDoajZdk5ytXZShZslCr5oLrzxelJfkxrEFUruvgxAa/ALS7/lo3nR/IZA
FYZ6Jjr/bsxsYcB+KYu0YCYd/nKzgVi0PvVhhXR6RQy+VNXV+VXeB0zcki2WRdHy
6SohvpaUAa/i9LffVB2hTJ3tsZsIya0MnZ5ydKU7lTSX1R2irPj5wM9QxYxzWtfD
0N8r+bOb4pHeJb5B1bBtaP4Kt39oEqKh8oixyray9F9xWKzFJs+viJvWIwQDF6ze
e3ZwFg1B7wfY5WFIduyQq1pWAbl35f5/8yj4/r/XCupjUkGCR6BaSlxrPmaVPi2O
yK51+YqxFGcqoc+bmqiFYFnEfYwNZfWCAmzOIjnjprljSWS9rOqXxBR3jhf++taf
HfuwKfnQOPwNEB/G3M0ALh2g76chL40L3rjKvo+zg2tkT75Y/lHLpVQqGXjolJGS
Dq+1zbtlGsafotICZZT85vr/1Ro9CRZncD+IOeSuQF+UzrB1oP8RCZvksui7zh2F
kKK+oQnr/lN0HdzzDma5NBjZItj0ma8QI1Cl++IPUh1ervOp4fbcv+GAT2LcatgZ
aoZz0TdyM2G3xC2EXtZtFqibNuMfoKFlO2JITDfC1/ptMsq4mNYIENun4bKnJ8Na
u8kjZQVXC0flAy8di/Ebi3674ToXYwIDAQABAoICAFZTZma3ujm6T0wGlwYeoCwm
jWi5OhBNgwdlJVicwn4K85zh/MJmFGM6gQbANDfA8eGuxGaELPqp3mCx0or0IXaO
/CbYpgP/MgXkkXDB2IS2JKWErMDVY8nK69qM4ca4OYmRWtjZ5oZuRdOSpq1wMYFJ
b28zzgiSB+jJqNLourZT2Yra6Hq9Xswl0nu+E/F09wdc34Izh+Ttu57Tq4uCHYZa
2XMxSFGREn+bRbPlzpEkQSLqw11fELkEljSv4xWiICZBenRtO8UwKG6K5xFjJ/rK
mNauY3QFDQopXpOpygsszMNejk8gnkkSEOsk/ZkAE9tnHbdffJjjBWlp2fzgnty1
72MwzlrinfOsYn6Ioe/mobGmedxQl4hiu6lI/Rl94C8HmycYRddQAg/55mTgZHBK
kUQCnqbLl9JLFiSwbL6YupkKGJeSPoXdzJcp4v+PT8a1QRDzdge8bwXQZJ59UhEu
EYJnYy79jBT8+UdTZxCYdmc3wuvUvOpxLihOEdr5+/6ZqQ0znoeTXNHxvzb43vRy
W7XgaP4pQH6/sD8mSRGHWNdG0hX9Fjc/C9rQzwMJwCAcGRTN7CjyOCMMbkmoCy5v
UDV22WzZqlUUZijuinLVV2Gn1WSXLWPSOJUFpiVgvrnycItroRoOfOAQOt20HnQu
b/R2P0xCKJCmHqBICpRhAoIBAQDZYD1ZMpvIX2ZyGkjUpy2Zm4ofly0mf/uzMnhv
y76aedZ+uSxlDLnlHTbL2sVOQhq6aRDYAWKYxekDf5FxZ8SXx11Dn/QHvGcZ/Hcl
LrhsGvVKPNPOMsXT8o0g7/BaS3hrzzOgHPRPl6dUZ78C4jX/KLjmNoqeO+FYqqB9
15yiGIDwJAanhoBOD7gonM9D9f3O6H5KzaDiggem+xSF3RVJyxPTWUEEa9hGZVcx
/QZuEe8W79x3Tk0L5I9/Lw6qfN/JFuN9BY4zTLGar6TtDN2LRIfHm+8eHVyFASxO
RqvTe9MfJwDRuwrULhaCtLjlLpU2HMjhZDlfG3z6EebulZJ1AoIBAQDDY7WEiksY
/5eCyWp1oWTxqnmNKhxD6vd1nRviDEpVTZ0lsHdtiKzpkiEXbvkKjbFbm7wEcsNx
HLKL4Q7Az89iR++dN4QkaqzsdnyRVc9W6UlUk5T2FqKoqsYcm0tG7fgIlXZ0PHgs
jG9cHXIne/QvFQ15xfAv/6bAi0rjfntGf47TaZT6Y56sQQ14OvYemjYviWiBaylQ
kbj3k+mAEGI8n71A2fWndk133HiLJ1EyWLUc8DEcB4kqwJHIYJGEYkwRWwoJmrS2
hRZVHsn9ar4qi/0UOodUtLpZXerfNPW/KmFCOcI1I7244UgWpOcRke19F2OOI+Eh
mOi4aJwVEJd3AoIBACKf4MW/eO7uuzu7khRFWM8Z5mNnyipSwn3lsSdllcO3WoIu
7rJd15J2F89a1ojDoMxGhgdSGSlqhNYo0Lr2o2rlt6ZY6R7+VJHgE/5ZNckKdj3P
+JDkp3w+K1quvWM0mEbb50Y+tm+jIWUhbVyBOcad7u3EjEnuEdP0wcGpwWpUat1V
b7Xph7BncpcNezpBCZ+Wit9RZ6oMujlPzxIPiB+L+Gl20xNoNjfoVn5A5nBL7QCD
TmO2ljEpw+2nSje/0kmOmsfERcVIFxYjmiqkHPnc/Z++59StKpqI+EyzlxUFqThS
FyBRIcVwXeeN79GZnOzUou677yOGFl8i0Nz5+C0CggEBAKTodd5snh92MVk4R/sK
AdmaCUckoICOQtdoh40M1HwUqqqRuuqerVnhdL6Dcfv/RQ7NbS3P8rZ4AxXeGIaR
njYUAt+NaKEXy+Uzx8UeSIXRFYwll1bwGc8De3vPcgRmeq47/6LxGnh2+tIjJCLB
EoHeYeZCMotAWWwu5EEHkmIY7OHwPcXq6JP3v7eXA/0mKM+MSMDaQh93Lkb+9teY
fGEwbRncG+KADbg5QyAnSfeVOR84dipzDckgiKo3Hvo9wHfxf5JFmXpm70deWhrh
yai9SBeXonrSomkkxEQpPbRfv4CWoRwak1kEAsTh3whMQsYORH9GNxAVL23dFMcO
ntcCggEBANhRGQvq1vxhnLkilwJ0EBocQ+KF8nZfzzOtQ194gPolRWpjVzDOeGc0
Us4omOreNpIXNYg9ELWMgm53viEoY3GMVt1kPPGwWW/JGeGv0kqr8aM3kWm5gc2H
eu/nM5JbOvUKxnruia9I8BvJeeTTVytRQbv4kojEkZagHKYoZJ+ox0Cx1UmXeVI/
vCufq4wqetJFNv05SNw7r+UObbc57BIPSvR3SGYmaZYkb8Wo/dZXF+vOAySnR8Go
3bihBMtzmspt9JQtPBDy84okQrojsfm8fyyMRZ/UtMrhvGYFd9bcMDsCY+jybRXa
E0CmRHNQumr+KBM8UT4YtWA+recgbtA=
-----END PRIVATE KEY-----

46
nginx/setup/default.conf Normal file
View File

@ -0,0 +1,46 @@
server {
#listen 80;
#listen [::]:80;
listen 443 ssl;
listen [::]:443 ssl;
server_name localhost;
ssl_certificate /etc/nginx/certs/ckan-local.crt;
ssl_certificate_key /etc/nginx/certs/ckan-local.key;
# TLS 1.2 & 1.3 only
ssl_protocols TLSv1.2 TLSv1.3;
# Disable weak ciphers
ssl_prefer_server_ciphers on;
ssl_ciphers 'ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256';
# SSL sessions
ssl_session_timeout 1d;
# ssl_session_cache dfine in stream and http
ssl_session_tickets off;
#access_log /var/log/nginx/host.access.log main;
location / {
proxy_pass http://ckan:5000/;
proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header Host $host;
#proxy_cache cache;
proxy_cache_bypass $cookie_auth_tkt;
proxy_no_cache $cookie_auth_tkt;
proxy_cache_valid 30m;
proxy_cache_key $host$scheme$proxy_host$request_uri;
}
error_page 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 421 422 423 424 425 426 428 429 431 451 500 501 502 503 504 505 506 507 508 510 511 /error.html;
# redirect server error pages to the static page /error.html
#
location = /error.html {
ssi on;
internal;
auth_basic off;
root /usr/share/nginx/html;
}
}

22
nginx/setup/index.html Normal file
View File

@ -0,0 +1,22 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>CKAN Docker NGINX landing page</title>
<style>
h1{
font-weight:lighter;
font-family: Arial, Helvetica, sans-serif;
}
</style>
</head>
<body>
<h2>
CKAN Docker NGINX landing page
</h2>
</body>
</html>

91
nginx/setup/nginx.conf Normal file
View File

@ -0,0 +1,91 @@
user nginx;
worker_processes auto;
error_log /var/log/nginx/error.log notice;
pid /var/run/nginx.pid;
events {
worker_connections 1024;
}
http {
include /etc/nginx/mime.types;
default_type application/octet-stream;
log_format main '$remote_addr - $remote_user [$time_local] "$request" '
'$status $body_bytes_sent "$http_referer" '
'"$http_user_agent" "$http_x_forwarded_for"';
access_log /var/log/nginx/access.log main;
sendfile on;
tcp_nopush on;
tcp_nodelay on;
types_hash_max_size 2048;
keepalive_timeout 65;
# Don't expose Nginx version
server_tokens off;
# Prevent clickjacking attacks
add_header X-Frame-Options "SAMEORIGIN";
# Mitigate Cross-Site scripting attack
add_header X-XSS-Protection "1; mode=block";
# Enable gzip encryption
gzip on;
proxy_cache_path /tmp/nginx_cache levels=1:2 keys_zone=cache:30m max_size=250m;
proxy_temp_path /tmp/nginx_proxy 1 2;
include /etc/nginx/conf.d/*.conf;
# Error status text
map $status $status_text {
400 'Bad Request';
401 'Unauthorized';
402 'Payment Required';
403 'Forbidden';
404 'Not Found';
405 'Method Not Allowed';
406 'Not Acceptable';
407 'Proxy Authentication Required';
408 'Request Timeout';
409 'Conflict';
410 'Gone';
411 'Length Required';
412 'Precondition Failed';
413 'Payload Too Large';
414 'URI Too Long';
415 'Unsupported Media Type';
416 'Range Not Satisfiable';
417 'Expectation Failed';
418 'I\'m a teapot';
421 'Misdirected Request';
422 'Unprocessable Entity';
423 'Locked';
424 'Failed Dependency';
425 'Too Early';
426 'Upgrade Required';
428 'Precondition Required';
429 'Too Many Requests';
431 'Request Header Fields Too Large';
451 'Unavailable For Legal Reasons';
500 'Internal Server Error';
501 'Not Implemented';
502 'Bad Gateway';
503 'Service Unavailable';
504 'Gateway Timeout';
505 'HTTP Version Not Supported';
506 'Variant Also Negotiates';
507 'Insufficient Storage';
508 'Loop Detected';
510 'Not Extended';
511 'Network Authentication Required';
default 'Something is wrong';
}
}

4
postgresql/Dockerfile Executable file
View File

@ -0,0 +1,4 @@
FROM postgres:12-alpine
# Include extra setup scripts (eg datastore)
COPY --chown=postgres:postgres docker-entrypoint-initdb.d /docker-entrypoint-initdb.d

1
postgresql/docker-entrypoint-initdb.d/.gitattributes vendored Normal file
View File

@ -0,0 +1 @@
*.sh text eol=lf

7
postgresql/docker-entrypoint-initdb.d/10_create_ckandb.sh Executable file
View File

@ -0,0 +1,7 @@
#!/bin/bash
set -e
psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" <<-EOSQL
CREATE ROLE "$CKAN_DB_USER" NOSUPERUSER CREATEDB CREATEROLE LOGIN PASSWORD '$CKAN_DB_PASSWORD';
CREATE DATABASE "$CKAN_DB" OWNER "$CKAN_DB_USER" ENCODING 'utf-8';
EOSQL

7
postgresql/docker-entrypoint-initdb.d/20_create_datastore.sh Executable file
View File

@ -0,0 +1,7 @@
#!/bin/bash
set -e
psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" <<-EOSQL
CREATE ROLE "$DATASTORE_READONLY_USER" NOSUPERUSER NOCREATEDB NOCREATEROLE LOGIN PASSWORD '$DATASTORE_READONLY_PASSWORD';
CREATE DATABASE "$DATASTORE_DB" OWNER "$CKAN_DB_USER" ENCODING 'utf-8';
EOSQL

7
postgresql/docker-entrypoint-initdb.d/30_setup_test_databases.sh Executable file
View File

@ -0,0 +1,7 @@
#!/bin/bash
set -e
psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" <<-EOSQL
CREATE DATABASE ckan_test OWNER "$CKAN_DB_USER" ENCODING 'utf-8';
CREATE DATABASE datastore_test OWNER "$CKAN_DB_USER" ENCODING 'utf-8';
EOSQL

5
src/ckanext-d4science/.coveragerc Normal file
View File

@ -0,0 +1,5 @@
[report]
omit =
*/site-packages/*
*/python?.?/*
ckan/*

48
src/ckanext-d4science/.github/workflows/test.yml vendored Normal file
View File

@ -0,0 +1,48 @@
name: Tests
on: [push, pull_request]
jobs:
test:
runs-on: ubuntu-latest
container:
# The CKAN version tag of the Solr and Postgres containers should match
# the one of the container the tests run on.
# You can switch this base image with a custom image tailored to your project
image: ckan/ckan-dev:2.10
services:
solr:
image: ckan/ckan-solr:2.10-solr9
postgres:
image: ckan/ckan-postgres-dev:2.10
env:
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
POSTGRES_DB: postgres
options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
redis:
image: redis:3
env:
CKAN_SQLALCHEMY_URL: postgresql://ckan_default:pass@postgres/ckan_test
CKAN_DATASTORE_WRITE_URL: postgresql://datastore_write:pass@postgres/datastore_test
CKAN_DATASTORE_READ_URL: postgresql://datastore_read:pass@postgres/datastore_test
CKAN_SOLR_URL: http://solr:8983/solr/ckan
CKAN_REDIS_URL: redis://redis:6379/1
steps:
- uses: actions/checkout@v4
- name: Install requirements
# Install any extra requirements your extension has here (dev requirements, other extensions etc)
run: |
pip install -r requirements.txt
pip install -r dev-requirements.txt
pip install -e .
- name: Setup extension
# Extra initialization steps
run: |
# Replace default path to CKAN core config file with the one on the container
sed -i -e 's/use = config:.*/use = config:\/srv\/app\/src\/ckan\/test-core.ini/' test.ini
ckan -c test.ini db init
- name: Run tests
run: pytest --ckan-ini=test.ini --cov=ckanext.d4science --disable-warnings ckanext/d4science

42
src/ckanext-d4science/.gitignore vendored Normal file
View File

@ -0,0 +1,42 @@
.ropeproject
node_modules
bower_components
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
# C extensions
*.so
# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
sdist/
*.egg-info/
.installed.cfg
*.egg
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.cache
nosetests.xml
coverage.xml
# Sphinx documentation
docs/_build/

661
src/ckanext-d4science/LICENSE Normal file
View File

@ -0,0 +1,661 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<http://www.gnu.org/licenses/>.

5
src/ckanext-d4science/MANIFEST.in Normal file
View File

@ -0,0 +1,5 @@
include README.rst
include LICENSE
include requirements.txt
recursive-include ckanext/d4science *.html *.json *.js *.less *.css *.mo *.yml
recursive-include ckanext/d4science/migration *.ini *.py *.mako

123
src/ckanext-d4science/README.md Normal file
View File

@ -0,0 +1,123 @@
[![Tests](https://github.com/d4science/ckanext-d4science/workflows/Tests/badge.svg?branch=main)](https://github.com/d4science/ckanext-d4science/actions)
# ckanext-d4science
**TODO:** Put a description of your extension here: What does it do? What features does it have? Consider including some screenshots or embedding a video!
## Requirements
**TODO:** For example, you might want to mention here which versions of CKAN this
extension works with.
If your extension works across different versions you can add the following table:
Compatibility with core CKAN versions:
| CKAN version | Compatible? |
| --------------- | ------------- |
| 2.6 and earlier | not tested |
| 2.7 | not tested |
| 2.8 | not tested |
| 2.9 | not tested |
Suggested values:
* "yes"
* "not tested" - I can't think of a reason why it wouldn't work
* "not yet" - there is an intention to get it working
* "no"
## Installation
**TODO:** Add any additional install steps to the list below.
For example installing any non-Python dependencies or adding any required
config settings.
To install ckanext-d4science:
1. Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate
2. Clone the source and install it on the virtualenv
git clone https://github.com/d4science/ckanext-d4science.git
cd ckanext-d4science
pip install -e .
pip install -r requirements.txt
3. Add `d4science` to the `ckan.plugins` setting in your CKAN
config file (by default the config file is located at
`/etc/ckan/default/ckan.ini`).
4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:
sudo service apache2 reload
## Config settings
None at present
**TODO:** Document any optional config settings here. For example:
# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.d4science.some_setting = some_default_value
## Developer installation
To install ckanext-d4science for development, activate your CKAN virtualenv and
do:
git clone https://github.com/d4science/ckanext-d4science.git
cd ckanext-d4science
python setup.py develop
pip install -r dev-requirements.txt
## Tests
To run the tests, do:
pytest --ckan-ini=test.ini
## Releasing a new version of ckanext-d4science
If ckanext-d4science should be available on PyPI you can follow these steps to publish a new version:
1. Update the version number in the `setup.py` file. See [PEP 440](http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers) for how to choose version numbers.
2. Make sure you have the latest version of necessary packages:
pip install --upgrade setuptools wheel twine
3. Create a source and binary distributions of the new version:
python setup.py sdist bdist_wheel && twine check dist/*
Fix any errors you get.
4. Upload the source distribution to PyPI:
twine upload dist/*
5. Commit any outstanding changes:
git commit -a
git push
6. Tag the new release of the project on GitHub with the version number from
the `setup.py` file. For example if the version number in `setup.py` is
0.0.1 then do:
git tag 0.0.1
git push --tags
## License
[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)

9
src/ckanext-d4science/ckanext/__init__.py Normal file
View File

@ -0,0 +1,9 @@
# encoding: utf-8
# this is a namespace package
try:
import pkg_resources
pkg_resources.declare_namespace(__name__)
except ImportError:
import pkgutil
__path__ = pkgutil.extend_path(__path__, __name__)

0
src/ckanext-d4science/ckanext/d4science/__init__.py Normal file
View File

0
src/ckanext-d4science/ckanext/d4science/assets/.gitignore vendored Normal file
View File

10
src/ckanext-d4science/ckanext/d4science/assets/script.js Normal file
View File

@ -0,0 +1,10 @@
ckan.module("d4science-module", function ($, _) {
"use strict";
return {
options: {
debug: false,
},
initialize: function () {},
};
});

5
src/ckanext-d4science/ckanext/d4science/assets/style.css Normal file
View File

@ -0,0 +1,5 @@
/*
body {
border-radius: 0;
}
*/

14
src/ckanext-d4science/ckanext/d4science/assets/webassets.yml Normal file
View File

@ -0,0 +1,14 @@
# d4science-js:
# filter: rjsmin
# output: ckanext-d4science/%(version)s-d4science.js
# contents:
# - js/d4science.js
# extra:
# preload:
# - base/main
# d4science-css:
# filter: cssrewrite
# output: ckanext-d4science/%(version)s-d4science.css
# contents:
# - css/d4science.css

20
src/ckanext-d4science/ckanext/d4science/cli.py Normal file
View File

@ -0,0 +1,20 @@
import click
@click.group(short_help="d4science CLI.")
def d4science():
"""d4science CLI.
"""
pass
@d4science.command()
@click.argument("name", default="d4science")
def command(name):
"""Docs.
"""
click.echo("Hello, {name}!".format(name=name))
def get_commands():
return [d4science]

9
src/ckanext-d4science/ckanext/d4science/helpers.py Normal file
View File

@ -0,0 +1,9 @@
def d4science_hello():
return "Hello, d4science!"
def get_helpers():
return {
"d4science_hello": d4science_hello,
}

0
src/ckanext-d4science/ckanext/d4science/i18n/.gitignore vendored Normal file
View File

25
src/ckanext-d4science/ckanext/d4science/logic/action.py Normal file
View File

@ -0,0 +1,25 @@
import ckan.plugins.toolkit as tk
import ckanext.d4science.logic.schema as schema
@tk.side_effect_free
def d4science_get_sum(context, data_dict):
tk.check_access(
"d4science_get_sum", context, data_dict)
data, errors = tk.navl_validate(
data_dict, schema.d4science_get_sum(), context)
if errors:
raise tk.ValidationError(errors)
return {
"left": data["left"],
"right": data["right"],
"sum": data["left"] + data["right"]
}
def get_actions():
return {
'd4science_get_sum': d4science_get_sum,
}

12
src/ckanext-d4science/ckanext/d4science/logic/auth.py Normal file
View File

@ -0,0 +1,12 @@
import ckan.plugins.toolkit as tk
@tk.auth_allow_anonymous_access
def d4science_get_sum(context, data_dict):
return {"success": True}
def get_auth_functions():
return {
"d4science_get_sum": d4science_get_sum,
}

11
src/ckanext-d4science/ckanext/d4science/logic/schema.py Normal file
View File

@ -0,0 +1,11 @@
import ckan.plugins.toolkit as tk
def d4science_get_sum():
not_empty = tk.get_validator("not_empty")
convert_int = tk.get_validator("convert_int")
return {
"left": [not_empty, convert_int],
"right": [not_empty, convert_int]
}

13
src/ckanext-d4science/ckanext/d4science/logic/validators.py Normal file
View File

@ -0,0 +1,13 @@
import ckan.plugins.toolkit as tk
def d4science_required(value):
if not value or value is tk.missing:
raise tk.Invalid(tk._("Required"))
return value
def get_validators():
return {
"d4science_required": d4science_required,
}

61
src/ckanext-d4science/ckanext/d4science/plugin.py Normal file
View File

@ -0,0 +1,61 @@
import ckan.plugins as plugins
import ckan.plugins.toolkit as toolkit
# import ckanext.d4science.cli as cli
# import ckanext.d4science.helpers as helpers
# import ckanext.d4science.views as views
# from ckanext.d4science.logic import (
# action, auth, validators
# )
class D4SciencePlugin(plugins.SingletonPlugin):
plugins.implements(plugins.IConfigurer)
# plugins.implements(plugins.IAuthFunctions)
# plugins.implements(plugins.IActions)
# plugins.implements(plugins.IBlueprint)
# plugins.implements(plugins.IClick)
# plugins.implements(plugins.ITemplateHelpers)
# plugins.implements(plugins.IValidators)
# IConfigurer
def update_config(self, config_):
toolkit.add_template_directory(config_, "templates")
toolkit.add_public_directory(config_, "public")
toolkit.add_resource("assets", "d4science")
# IAuthFunctions
# def get_auth_functions(self):
# return auth.get_auth_functions()
# IActions
# def get_actions(self):
# return action.get_actions()
# IBlueprint
# def get_blueprint(self):
# return views.get_blueprints()
# IClick
# def get_commands(self):
# return cli.get_commands()
# ITemplateHelpers
# def get_helpers(self):
# return helpers.get_helpers()
# IValidators
# def get_validators(self):
# return validators.get_validators()

0
src/ckanext-d4science/ckanext/d4science/public/.gitignore vendored Normal file
View File

0
src/ckanext-d4science/ckanext/d4science/templates/.gitignore vendored Normal file
View File

0
src/ckanext-d4science/ckanext/d4science/tests/__init__.py Normal file
View File

13
src/ckanext-d4science/ckanext/d4science/tests/logic/test_action.py Normal file
View File

@ -0,0 +1,13 @@
"""Tests for action.py."""
import pytest
import ckan.tests.helpers as test_helpers
@pytest.mark.ckan_config("ckan.plugins", "d4science")
@pytest.mark.usefixtures("with_plugins")
def test_d4science_get_sum():
result = test_helpers.call_action(
"d4science_get_sum", left=10, right=30)
assert result["sum"] == 40

19
src/ckanext-d4science/ckanext/d4science/tests/logic/test_auth.py Normal file
View File

@ -0,0 +1,19 @@
"""Tests for auth.py."""
import pytest
import ckan.tests.factories as factories
import ckan.tests.helpers as test_helpers
import ckan.model as model
@pytest.mark.ckan_config("ckan.plugins", "d4science")
@pytest.mark.usefixtures("with_request_context", "with_plugins", "clean_db")
def test_d4science_get_sum():
user = factories.User()
context = {
"user": user["name"],
"model": model
}
assert test_helpers.call_auth(
"d4science_get_sum", context=context)

16
src/ckanext-d4science/ckanext/d4science/tests/logic/test_validators.py Normal file
View File

@ -0,0 +1,16 @@
"""Tests for validators.py."""
import pytest
import ckan.plugins.toolkit as tk
from ckanext.d4science.logic import validators
def test_d4science_reauired_with_valid_value():
assert validators.d4science_required("value") == "value"
def test_d4science_reauired_with_invalid_value():
with pytest.raises(tk.Invalid):
validators.d4science_required(None)

7
src/ckanext-d4science/ckanext/d4science/tests/test_helpers.py Normal file
View File

@ -0,0 +1,7 @@
"""Tests for helpers.py."""
import ckanext.d4science.helpers as helpers
def test_d4science_hello():
assert helpers.d4science_hello() == "Hello, d4science!"

56
src/ckanext-d4science/ckanext/d4science/tests/test_plugin.py Normal file
View File

@ -0,0 +1,56 @@
"""
Tests for plugin.py.
Tests are written using the pytest library (https://docs.pytest.org), and you
should read the testing guidelines in the CKAN docs:
https://docs.ckan.org/en/2.9/contributing/testing.html
To write tests for your extension you should install the pytest-ckan package:
pip install pytest-ckan
This will allow you to use CKAN specific fixtures on your tests.
For instance, if your test involves database access you can use `clean_db` to
reset the database:
import pytest
from ckan.tests import factories
@pytest.mark.usefixtures("clean_db")
def test_some_action():
dataset = factories.Dataset()
# ...
For functional tests that involve requests to the application, you can use the
`app` fixture:
from ckan.plugins import toolkit
def test_some_endpoint(app):
url = toolkit.url_for('myblueprint.some_endpoint')
response = app.get(url)
assert response.status_code == 200
To temporary patch the CKAN configuration for the duration of a test you can use:
import pytest
@pytest.mark.ckan_config("ckanext.myext.some_key", "some_value")
def test_some_action():
pass
"""
import ckanext.d4science.plugin as plugin
@pytest.mark.ckan_config("ckan.plugins", "d4science")
@pytest.mark.usefixtures("with_plugins")
def test_plugin():
assert plugin_loaded("d4science")

16
src/ckanext-d4science/ckanext/d4science/tests/test_views.py Normal file
View File

@ -0,0 +1,16 @@
"""Tests for views.py."""
import pytest
import ckanext.d4science.validators as validators
import ckan.plugins.toolkit as tk
@pytest.mark.ckan_config("ckan.plugins", "d4science")
@pytest.mark.usefixtures("with_plugins")
def test_d4science_blueprint(app, reset_db):
resp = app.get(tk.h.url_for("d4science.page"))
assert resp.status_code == 200
assert resp.body == "Hello, d4science!"

17
src/ckanext-d4science/ckanext/d4science/views.py Normal file
View File

@ -0,0 +1,17 @@
from flask import Blueprint
d4science = Blueprint(
"d4science", __name__)
def page():
return "Hello, d4science!"
d4science.add_url_rule(
"/d4science/page", view_func=page)
def get_blueprints():
return [d4science]

1
src/ckanext-d4science/dev-requirements.txt Normal file
View File

@ -0,0 +1 @@
pytest-ckan

0
src/ckanext-d4science/requirements.txt Normal file
View File

62
src/ckanext-d4science/setup.cfg Normal file
View File

@ -0,0 +1,62 @@
[metadata]
name = ckanext-d4science
version = 0.0.1
description = d4science custom extensions
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/d4science/ckanext-d4science
author = d4science
author_email = info@d4science.org
license = AGPL
classifiers =
Development Status :: 4 - Beta
License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
Programming Language :: Python :: 3.9
Programming Language :: Python :: 3.10
keywords = CKAN
[options]
packages = find:
namespace_packages = ckanext
install_requires =
include_package_data = True
[options.entry_points]
ckan.plugins =
d4science = ckanext.d4science.plugin:D4SciencePlugin
babel.extractors =
ckan = ckan.lib.extract:extract_ckan
[options.extras_require]
[extract_messages]
keywords = translate isPlural
add_comments = TRANSLATORS:
output_file = ckanext/d4science/i18n/ckanext-d4science.pot
width = 80
[init_catalog]
domain = ckanext-d4science
input_file = ckanext/d4science/i18n/ckanext-d4science.pot
output_dir = ckanext/d4science/i18n
[update_catalog]
domain = ckanext-d4science
input_file = ckanext/d4science/i18n/ckanext-d4science.pot
output_dir = ckanext/d4science/i18n
previous = true
[compile_catalog]
domain = ckanext-d4science
directory = ckanext/d4science/i18n
statistics = true
[tool:pytest]
filterwarnings =
ignore::sqlalchemy.exc.SADeprecationWarning
ignore::sqlalchemy.exc.SAWarning
ignore::DeprecationWarning
addopts = --ckan-ini test.ini

16
src/ckanext-d4science/setup.py Normal file
View File

@ -0,0 +1,16 @@
# -*- coding: utf-8 -*-
from setuptools import setup
setup(
# If you are changing from the default layout of your extension, you may
# have to change the message extractors, you can read more about babel
# message extraction at
# http://babel.pocoo.org/docs/messages/#extraction-method-mapping-and-configuration
message_extractors={
'ckanext': [
('**.py', 'python', None),
('**.js', 'javascript', None),
('**/templates/**.html', 'ckan', None),
],
}
)

45
src/ckanext-d4science/test.ini Normal file
View File

@ -0,0 +1,45 @@
[DEFAULT]
debug = false
smtp_server = localhost
error_email_from = ckan@localhost
[app:main]
use = config:../../src/ckan/test-core.ini
# Insert any custom config settings to be used when running your extension's
# tests here. These will override the one defined in CKAN core's test-core.ini
ckan.plugins = d4science
# Logging configuration
[loggers]
keys = root, ckan, sqlalchemy
[handlers]
keys = console
[formatters]
keys = generic
[logger_root]
level = WARN
handlers = console
[logger_ckan]
qualname = ckan
handlers =
level = INFO
[logger_sqlalchemy]
handlers =
qualname = sqlalchemy.engine
level = WARN
[handler_console]
class = StreamHandler
args = (sys.stderr,)
level = NOTSET
formatter = generic
[formatter_generic]
format = %(asctime)s %(levelname)-5.5s [%(name)s] %(message)s

17
src/ckanext-d4science_theme/.project Normal file
View File

@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>ckanext-d4science_theme</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
<buildCommand>
<name>org.python.pydev.PyDevBuilder</name>
<arguments>
</arguments>
</buildCommand>
</buildSpec>
<natures>
<nature>org.python.pydev.pythonNature</nature>
</natures>
</projectDescription>

2
src/ckanext-d4science_theme/.settings/org.eclipse.core.resources.prefs Normal file
View File

@ -0,0 +1,2 @@
eclipse.preferences.version=1
encoding/setup.py=utf-8

661
src/ckanext-d4science_theme/LICENSE Normal file
View File

@ -0,0 +1,661 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<http://www.gnu.org/licenses/>.

2
src/ckanext-d4science_theme/MANIFEST.in Normal file
View File

@ -0,0 +1,2 @@
include README.rst
recursive-include ckanext/d4science_theme *.html *.json *.js *.less *.css

129
src/ckanext-d4science_theme/README.rst Normal file
View File

@ -0,0 +1,129 @@
============
ckanext-d4science_theme
============
The CKAN extension that implements the D4Science theme template used by D4Science Catalogues
------------
Requirements
------------
None
------------
Installation
------------
To install ckanext-d4science_theme:
1. Activate your CKAN virtual environment, for example::
. /usr/lib/ckan/default/bin/activate
2. Install the ckanext-d4science_theme Python package into your virtual environment::
pip install ckanext-d4science_theme
3. Add ``d4science_theme`` to the ``ckan.plugins`` setting in your CKAN
config file (by default the config file is located at
``/etc/ckan/default/production.ini``).
4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::
sudo service apache2 reload
---------------
Config Settings
---------------
Document any optional config settings here. For example::
# The minimum number of hours to wait before re-checking a resource
# (optional, default: 24).
ckanext.d4science_theme.some_setting = some_default_value
------------------------
Development Installation
------------------------
To install ckanext-d4science_theme for development, activate your CKAN virtualenv and
do::
git clone https://code-repo.d4science.org/CKAN-Extensions/ckanext-d4science_theme.git
cd ckanext-d4science_theme
python setup.py develop
pip install -r dev-requirements.txt
-----------------
Running the Tests
-----------------
To run the tests, do::
nosetests --nologcapture --with-pylons=test.ini
To run the tests and produce a coverage report, first make sure you have
coverage installed in your virtualenv (``pip install coverage``) then run::
nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.d4science_theme --cover-inclusive --cover-erase --cover-tests
---------------------------------
Registering ckanext-d4science_theme on PyPI
---------------------------------
ckanext-d4science_theme should be availabe on PyPI as
https://pypi.python.org/pypi/ckanext-d4science_theme. If that link doesn't work, then
you can register the project on PyPI for the first time by following these
steps:
1. Create a source distribution of the project::
python setup.py sdist
2. Register the project::
python setup.py register
3. Upload the source distribution to PyPI::
python setup.py sdist upload
4. Tag the first release of the project on GitHub with the version number from
the ``setup.py`` file. For example if the version number in ``setup.py`` is
0.0.1 then do::
git tag 0.0.1
git push --tags
----------------------------------------
Releasing a New Version of ckanext-d4science_theme
----------------------------------------
ckanext-d4science_theme is availabe on PyPI as https://pypi.python.org/pypi/ckanext-d4science_theme.
To publish a new version to PyPI follow these steps:
1. Update the version number in the ``setup.py`` file.
See `PEP 440 <http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers>`_
for how to choose version numbers.
2. Create a source distribution of the new version::
python setup.py sdist
3. Upload the source distribution to PyPI::
python setup.py sdist upload
4. Tag the new release of the project on GitHub with the version number from
the ``setup.py`` file. For example if the version number in ``setup.py`` is
0.0.2 then do::
git tag 0.0.2
git push --tags

7
src/ckanext-d4science_theme/ckanext/__init__.py Normal file
View File

@ -0,0 +1,7 @@
# this is a namespace package
try:
import pkg_resources
pkg_resources.declare_namespace(__name__)
except ImportError:
import pkgutil
__path__ = pkgutil.extend_path(__path__, __name__)

BIN
src/ckanext-d4science_theme/ckanext/__pycache__/__init__.cpython-310.pyc Normal file
View File

Binary file not shown.

0
src/ckanext-d4science_theme/ckanext/d4science_theme/__init__.py Normal file
View File

BIN
src/ckanext-d4science_theme/ckanext/d4science_theme/__pycache__/__init__.cpython-310.pyc Normal file
View File

Binary file not shown.

BIN
src/ckanext-d4science_theme/ckanext/d4science_theme/__pycache__/helpers.cpython-310.pyc Normal file
View File

Binary file not shown.

BIN
src/ckanext-d4science_theme/ckanext/d4science_theme/__pycache__/plugin.cpython-310.pyc Normal file
View File

Binary file not shown.

4
src/ckanext-d4science_theme/ckanext/d4science_theme/controllers/__init__.py Normal file
View File

@ -0,0 +1,4 @@
#The __init__.py files are required to make Python
#treat the directories as containing packages; this is done to prevent directories with a common name, such as string, from unintentionally hiding valid modules that occur later on the module search path.
#See: https://docs.python.org/3/tutorial/modules.html#packages

BIN
src/ckanext-d4science_theme/ckanext/d4science_theme/controllers/__pycache__/__init__.cpython-310.pyc Normal file
View File

Binary file not shown.

BIN
src/ckanext-d4science_theme/ckanext/d4science_theme/controllers/__pycache__/organization.cpython-310.pyc Normal file
View File

Binary file not shown.

75
src/ckanext-d4science_theme/ckanext/d4science_theme/controllers/home.py Normal file
View File

@ -0,0 +1,75 @@
import logging
from ckan.controllers.home import HomeController
import ckan.plugins as p
from ckan.common import OrderedDict, _, g, c
import ckan.lib.search as search
import ckan.model as model
import ckan.logic as logic
import ckan.lib.maintain as maintain
import ckan.lib.base as base
import ckan.lib.helpers as h
# Created by Francesco Mangiacrapa
# francesco.mangiacrapa@isti.cnr.it
# ISTI-CNR Pisa (ITALY)
class d4SHomeController():
#Overriding controllers.HomeController.index method
def index(self):
try:
# package search
context = {'model': model, 'session': model.Session,'user': c.user, 'auth_user_obj': c.userobj}
facets = OrderedDict()
default_facet_titles = {
'organization': _('Organizations'),
'groups': _('Groups'),
'tags': _('Tags'),
'res_format': _('Formats'),
'license_id': _('Licenses'),
}
for facet in g.facets:
if facet in default_facet_titles:
facets[facet] = default_facet_titles[facet]
else:
facets[facet] = facet
# Facet titles
for plugin in p.PluginImplementations(p.IFacets):
facets = plugin.dataset_facets(facets, 'dataset')
c.facet_titles = facets
data_dict = {
'q': '*:*',
'facet.field': list(facets.keys()),
'rows': 4,
'start': 0,
'sort': 'views_recent desc',
'fq': 'capacity:"public"'
}
query = logic.get_action('package_search')(context, data_dict)
c.search_facets = query['search_facets']
c.package_count = query['count']
c.datasets = query['results']
#print "c.search_facets: "
#print " ".join(c.search_facets)
except search.SearchError:
c.package_count = 0
if c.userobj and not c.userobj.email:
url = h.url_for(controller='user', action='edit')
msg = _('Please <a href="%s">update your profile</a>'
' and add your email address. ') % url + \
_('%s uses your email address'
' if you need to reset your password.') \
% g.site_title
h.flash_notice(msg, allow_html=True)
return base.render('home/index.html', cache_force=True)

134
src/ckanext-d4science_theme/ckanext/d4science_theme/controllers/organization.py Normal file
View File

@ -0,0 +1,134 @@
# encoding: utf-8
import re
import ckan.controllers.group as group
import ckan.plugins as plugins
import logging
import datetime
from urllib.parse import urlencode
import ckan.lib.base as base
import ckan.lib.helpers as h
import ckan.lib.maintain as maintain
import ckan.lib.navl.dictization_functions as dict_fns
import ckan.logic as logic
import ckan.lib.search as search
import ckan.model as model
import ckan.authz as authz
import ckan.lib.plugins
import ckan.plugins as plugins
from ckan.common import c, request, _
'''
Created by Francesco Mangiacrapa, see: #8964
'''
class OrganizationVREController(group.GroupController):
''' The organization controller is for Organizations, which are implemented
as Groups with is_organization=True and group_type='organization'. It works
the same as the group controller apart from:
* templates and logic action/auth functions are sometimes customized
(switched using _replace_group_org)
* 'bulk_process' action only works for organizations
Nearly all the code for both is in the GroupController (for historical
reasons).
'''
group_types = ['organization']
def _guess_group_type(self, expecting_name=False):
return 'organization'
def _replace_group_org(self, string):
''' substitute organization for group if this is an org'''
return re.sub('^group', 'organization', string)
def _update_facet_titles(self, facets, group_type):
for plugin in plugins.PluginImplementations(plugins.IFacets):
facets = plugin.organization_facets(
facets, group_type, None)
def index(self):
group_type = self._guess_group_type()
page = h.get_page_number(request.params) or 1
items_per_page = 21
context = {'model': model, 'session': model.Session,
'user': c.user, 'for_view': True,
'with_private': False}
q = c.q = request.params.get('q', '')
sort_by = c.sort_by_selected = request.params.get('sort')
try:
self._check_access('site_read', context)
self._check_access('group_list', context)
except NotAuthorized:
abort(403, _('Not authorized to see this page'))
# pass user info to context as needed to view private datasets of
# orgs correctly
if c.userobj:
context['user_id'] = c.userobj.id
context['user_is_admin'] = c.userobj.sysadmin
data_dict_global_results = {
'all_fields': False,
'q': q,
'sort': sort_by,
'type': group_type or 'group',
}
global_results = self._action('group_list')(context,
data_dict_global_results)
data_dict_page_results = {
'all_fields': True,
'q': q,
'sort': sort_by,
'type': group_type or 'group',
'limit': items_per_page,
'offset': items_per_page * (page - 1),
}
page_results = self._action('group_list')(context,
data_dict_page_results)
c.page = h.Page(
collection=global_results,
page=page,
url=h.pager_url,
items_per_page=items_per_page,
)
c.page.items = page_results
return base.render('organization_vre/index.html',
extra_vars={'group_type': group_type})
def read(self, id, limit=20):
group_type = self._ensure_controller_matches_group_type(
id.split('@')[0])
context = {'model': model, 'session': model.Session,
'user': c.user,
'schema': self._db_to_form_schema(group_type=group_type),
'for_view': True}
data_dict = {'id': id, 'type': group_type}
# unicode format (decoded from utf8)
c.q = request.params.get('q', '')
try:
# Do not query for the group datasets when dictizing, as they will
# be ignored and get requested on the controller anyway
data_dict['include_datasets'] = False
c.group_dict = self._action('group_show')(context, data_dict)
c.group = context['group']
except (NotFound, NotAuthorized):
abort(404, _('Group not found'))
self._read(id, limit, group_type)
return base.render('organization_vre/read.html',
extra_vars={'group_type': group_type})

91
src/ckanext-d4science_theme/ckanext/d4science_theme/controllers/systemtype.py Normal file
View File

@ -0,0 +1,91 @@
import logging
import ckan.plugins as p
from ckan.common import OrderedDict, _, g, c
import ckan.lib.search as search
import ckan.model as model
import ckan.logic as logic
import ckan.lib.maintain as maintain
import ckan.lib.base as base
import ckan.lib.helpers as h
from urllib.parse import urlencode
import ckan.lib.base as base
import ckan.lib.helpers as h
import ckan.lib.maintain as maintain
import ckan.lib.navl.dictization_functions as dict_fns
import ckan.logic as logic
import ckan.lib.search as search
import ckan.model as model
import ckan.authz as authz
import ckan.lib.plugins
import ckan.plugins as plugins
from ckan.common import OrderedDict, c, g, request, _
# Created by Francesco Mangiacrapa
# francesco.mangiacrapa@isti.cnr.it
# ISTI-CNR Pisa (ITALY)
class d4STypeController(base.BaseController):
#Overriding controllers.HomeController.index method
def index(self):
try:
# package search
context = {'model': model, 'session': model.Session,'user': c.user, 'auth_user_obj': c.userobj}
facets = OrderedDict()
default_facet_titles = {
'organization': _('Organizations'),
'groups': _('Groups'),
'tags': _('Tags'),
'res_format': _('Formats'),
'license_id': _('Licenses'),
}
for facet in g.facets:
if facet in default_facet_titles:
facets[facet] = default_facet_titles[facet]
else:
facets[facet] = facet
# Facet titles
for plugin in p.PluginImplementations(p.IFacets):
facets = plugin.dataset_facets(facets, 'dataset')
c.facet_titles = facets
data_dict = {
'q': '*:*',
'facet.field': list(facets.keys()),
'rows': 4,
'start': 0,
'sort': 'views_recent desc',
'fq': 'capacity:"public"'
}
query = logic.get_action('package_search')(context, data_dict)
c.search_facets = query['search_facets']
c.package_count = query['count']
c.datasets = query['results']
#print "c.search_facets: "
#print " ".join(c.search_facets)
except search.SearchError:
c.package_count = 0
if c.userobj and not c.userobj.email:
url = h.url_for(controller='user', action='edit')
msg = _('Please <a href="%s">update your profile</a>'
' and add your email address. ') % url + \
_('%s uses your email address'
' if you need to reset your password.') \
% g.site_title
h.flash_notice(msg, allow_html=True)
return base.render('type/index.html', cache_force=True)

0
src/ckanext-d4science_theme/ckanext/d4science_theme/d4sdiscovery/__init__.py Normal file
View File

BIN
src/ckanext-d4science_theme/ckanext/d4science_theme/d4sdiscovery/__pycache__/__init__.cpython-310.pyc Normal file
View File

Binary file not shown.

BIN
src/ckanext-d4science_theme/ckanext/d4science_theme/d4sdiscovery/__pycache__/d4s_cache_controller.cpython-310.pyc Normal file
View File

Binary file not shown.

BIN
src/ckanext-d4science_theme/ckanext/d4science_theme/d4sdiscovery/__pycache__/d4s_extras.cpython-310.pyc Normal file
View File

Binary file not shown.

BIN
src/ckanext-d4science_theme/ckanext/d4science_theme/d4sdiscovery/__pycache__/d4s_namespaces.cpython-310.pyc Normal file
View File

Binary file not shown.

BIN
src/ckanext-d4science_theme/ckanext/d4science_theme/d4sdiscovery/__pycache__/d4s_namespaces_controller.cpython-310.pyc Normal file
View File

Binary file not shown.

BIN
src/ckanext-d4science_theme/ckanext/d4science_theme/d4sdiscovery/__pycache__/d4s_namespaces_extras_util.cpython-310.pyc Normal file
View File

Binary file not shown.

BIN
src/ckanext-d4science_theme/ckanext/d4science_theme/d4sdiscovery/__pycache__/icproxycontroller.cpython-310.pyc Normal file
View File

Binary file not shown.

106
src/ckanext-d4science_theme/ckanext/d4science_theme/d4sdiscovery/d4s_cache_controller.py Normal file
View File

@ -0,0 +1,106 @@
import datetime
import logging
import os
import tempfile
import csv
from .icproxycontroller import NAMESPACE_ID_LABEL
log = logging.getLogger(__name__)
CATALINA_HOME = 'CATALINA_HOME'
temp_dir = None
namespaces_dir = None
NAMESPACES_DIR_NAME = "namespaces_for_catalogue"
NAMESPACES_CACHE_FILENAME = "Namespaces_Catalogue_Categories.csv"
# Created by Francesco Mangiacrapa
# francesco.mangiacrapa@isti.cnr.it
# ISTI-CNR Pisa (ITALY)
# D4S_Cache_Controller
class D4S_Cache_Controller():
namespaces_cache_path = None
__scheduler = None
def __init__(self):
""" Virtually private constructor. """
log.debug("__init__ D4S_Cache_Controller")
self._check_cache()
def _check_cache(self):
if self.namespaces_cache_path is None:
self.init_temp_dir()
self.namespaces_cache_path = os.path.join(namespaces_dir, NAMESPACES_CACHE_FILENAME)
log.info("The namespaces cache is located at: %s" % self.namespaces_cache_path)
if not os.path.exists(self.namespaces_cache_path):
log.info("File does not exists creating it")
try:
with open(self.namespaces_cache_path, mode='w') as namespaces_file:
csv.writer(namespaces_file, delimiter=',', quotechar='"', quoting=csv.QUOTE_MINIMAL)
log.info("Cache created at %s" % self.namespaces_cache_path)
except Exception as e:
print(e)
''' Write the list of dictionary with namespaces'''
def write_namespaces(self, namespace_list_of_dict):
# Insert Data
with open(self.namespaces_cache_path, 'w') as namespaces_file:
writer = csv.writer(namespaces_file, delimiter=',', quotechar='"', quoting=csv.QUOTE_MINIMAL)
writer.writerow([NAMESPACE_ID_LABEL, 'name', 'title', 'description'])
for namespace_dict in namespace_list_of_dict:
#print("namespace %s" % namespace_dict)
writer.writerow([namespace_dict[NAMESPACE_ID_LABEL], namespace_dict['name'], namespace_dict['title'], namespace_dict['description']])
log.info("Inserted %d namespaces in the Cache" % len(namespace_list_of_dict))
'''Returns the list of dictionary with namespaces'''
def read_namespaces(self):
# Read Data
namespace_list_of_dict = []
try:
with open(self.namespaces_cache_path, 'r') as namespaces_file:
reader = csv.DictReader(namespaces_file)
for row in reader:
#print("read namespace %s" % row)
namespace_list_of_dict.append(dict(row))
log.debug("from Cache returning namespace_list_of_dict %s: " % namespace_list_of_dict)
log.info("from Cache read namespace_list_of_dict with %d item/s " % len(namespace_list_of_dict))
return namespace_list_of_dict
except Exception as e:
print(e)
log.info("no namespace in the Cache returning empty list of dict")
return namespace_list_of_dict
@property
def get_namespaces_cache_path(self):
return self.namespaces_cache_path
@classmethod
def init_temp_dir(cls):
global temp_dir
global NAMESPACES_DIR_NAME
global namespaces_dir
try:
temp_dir = str(os.environ[CATALINA_HOME])
temp_dir = os.path.join(temp_dir, "temp")
except KeyError as error:
log.error("No environment variable for: %s" % CATALINA_HOME)
if temp_dir is None:
temp_dir = tempfile.gettempdir() # using system tmp dir
log.debug("Temp dir is: %s" % temp_dir)
namespaces_dir = os.path.join(temp_dir, NAMESPACES_DIR_NAME)
if not os.path.exists(namespaces_dir):
os.makedirs(namespaces_dir)

30
src/ckanext-d4science_theme/ckanext/d4science_theme/d4sdiscovery/d4s_extras.py Normal file
View File

@ -0,0 +1,30 @@
# Created by Francesco Mangiacrapa
# francesco.mangiacrapa@isti.cnr.it
# ISTI-CNR Pisa (ITALY)
import logging
log = logging.getLogger(__name__)
class D4S_Extras():
def __init__(self, category_dict={}, extras=[]):
self._category = category_dict
self._extras = extras
def append_extra(self, k, v):
#print ("self._extras: %s" %self._extras)
if k is not None:
self._extras.append({k:v})
@property
def category(self):
return self._category
@property
def extras(self):
return self._extras
def __repr__(self):
return 'category: %s'%self._category+' ' \
'extras: %s'%self._extras

39
src/ckanext-d4science_theme/ckanext/d4science_theme/d4sdiscovery/d4s_namespaces.py Normal file
View File

@ -0,0 +1,39 @@
# Created by Francesco Mangiacrapa
# francesco.mangiacrapa@isti.cnr.it
# ISTI-CNR Pisa (ITALY)
#OrderedDict([(u'@id', u'extra_information'), (u'name', u'Extra Information'), (u'title', u'Extras'), (u'description', u'This section is about Extra(s)')]), u'contact': OrderedDict([(u'@id', u'contact'), (u'name', u'Contact'), (u'title', u'Contact Title'), (u'description', u'This section is about Contact(s)')]), u'developer_information': OrderedDict([(u'@id', u'developer_information'), (u'name', u'Developer'), (u'title', u'Developer Information'), (u'description', u'This section is about Developer(s)')])}
import logging
log = logging.getLogger(__name__)
class D4S_Namespaces():
def __init__(self, id=None, name=None, title=None, description=None):
self._id = id
self._name = name
self._title = title
self._description = description
@property
def id(self):
return self._id
@property
def name(self):
return self._name
@property
def title(self):
return self._title
@property
def description(self):
return self._description
def __repr__(self):
return '{id: %s'%self.id+', ' \
'name: %s'%self.name+ ', ' \
'title: %s'%self.title+ ', ' \
'description: %s'%self.description+ '}'

130
src/ckanext-d4science_theme/ckanext/d4science_theme/d4sdiscovery/d4s_namespaces_controller.py Normal file
View File

@ -0,0 +1,130 @@
import logging
import time
from .d4s_cache_controller import D4S_Cache_Controller
from .icproxycontroller import D4S_IS_DiscoveryCatalogueNamespaces
from threading import Event, Thread
CATEGORY = 'category'
NOCATEOGORY = 'nocategory'
log = logging.getLogger(__name__)
cancel_future_calls = None
# Refreshing time for namespaces cache in secs.
NAMESPACES_CACHE_REFRESHING_TIME = 60 * 60
# Funtion to call repeatedly another function
def call_repeatedly(interval, func, *args):
log.info("call_repeatedly called on func '{}' with interval {} sec".format(func.__name__, interval))
stopped = Event()
def loop():
while not stopped.wait(interval): # the first call is in `interval` secs
func(*args)
th = Thread(name='daemon_caching_namespaces', target=loop)
th.setDaemon(True)
th.start()
return stopped.set
def reload_namespaces_from_IS(urlICProxy, resourceID, gcubeToken):
log.info("_reload_namespaces_from_IS called")
try:
discovery_ctg_namespaces = D4S_IS_DiscoveryCatalogueNamespaces(urlICProxy, resourceID, gcubeToken)
namespaces_list_of_dict = discovery_ctg_namespaces.getNamespacesDictFromResource()
if namespaces_list_of_dict is not None and len(namespaces_list_of_dict) > 0:
log.debug("namespaces read from IS are: %s" % namespaces_list_of_dict)
D4S_Cache_Controller().write_namespaces(namespaces_list_of_dict)
else:
log.info("namespaces list read from IS is empty. Skipping caching update")
except Exception as e:
print("Error occurred on reading namespaces from IS and refilling the cache!")
print(e)
# Created by Francesco Mangiacrapa
# francesco.mangiacrapa@isti.cnr.it
# ISTI-CNR Pisa (ITALY)
# D4S_IS_DiscoveryCatalogueNamespacesController is used to discovery namespaces for Catalogue Categories (implemented as a Singleton)
# @param: urlICProxy is the URI of IC proxy rest-full service provided by IS
# @param: resourceID is the resource ID of the Generic Resource: "Namespaces Catalogue Categories"
# @param: gcubeToken the gcube token used to contact the IC proxy
class D4S_Namespaces_Controller():
__instance = None
@staticmethod
def getInstance():
""" Static access method. """
if D4S_Namespaces_Controller.__instance is None:
D4S_Namespaces_Controller()
return D4S_Namespaces_Controller.__instance
def __init__(self):
""" Virtually private constructor. """
log.debug("__init__ D4S_Namespaces_Controller")
if D4S_Namespaces_Controller.__instance is not None:
raise Exception("This class is a singleton!")
else:
D4S_Namespaces_Controller.__instance = self
self._d4s_cache_controller = D4S_Cache_Controller()
self._urlICProxy = None
self._resourceID = None
self._gcubeToken = None
def load_namespaces(self, urlICProxy, resourceID, gcubeToken):
log.debug("readNamespaces called")
self._urlICProxy = urlICProxy
self._resourceID = resourceID
self._gcubeToken = gcubeToken
return self._check_namespaces()
def _read_namespaces(self):
return self._d4s_cache_controller.read_namespaces()
def _check_namespaces(self):
log.debug("_check_namespaces called")
if self._d4s_cache_controller is None:
self._d4s_cache_controller = D4S_Cache_Controller()
namespace_list = self._read_namespaces()
# when the Cache is empty
if namespace_list is None or not namespace_list:
# reading namespaces from IS and filling the DB
log.info("The Cache is empty. Reading the namespace from IS and filling the Cache")
reload_namespaces_from_IS(self._urlICProxy, self._resourceID, self._gcubeToken)
# reloading the namespaces from the cache
namespace_list = self._read_namespaces()
# starting Thread daemon for refreshing the namespaces Cache
global cancel_future_calls
if cancel_future_calls is None:
cancel_future_calls = call_repeatedly(NAMESPACES_CACHE_REFRESHING_TIME, reload_namespaces_from_IS,
self._urlICProxy,
self._resourceID,
self._gcubeToken)
return namespace_list
def get_dict_ctg_namespaces(self):
log.debug("get_dict_ctg_namespaces called")
namespace_list_of_dict = self._check_namespaces()
return self.convert_namespaces_to_d4s_namespacedict(namespace_list_of_dict)
# Private method
@staticmethod
def convert_namespaces_to_d4s_namespacedict(namespace_list_of_dict):
log.debug("convert_namespaces_to_d4s_namespacedict called on %s" % namespace_list_of_dict)
return D4S_IS_DiscoveryCatalogueNamespaces.to_namespaces_dict_index_for_id(namespace_list_of_dict)

89
src/ckanext-d4science_theme/ckanext/d4science_theme/d4sdiscovery/d4s_namespaces_extras_util.py Normal file
View File

@ -0,0 +1,89 @@
import logging
import collections
from .d4s_extras import D4S_Extras
CATEGORY = 'category'
NOCATEOGORY = 'nocategory'
log = logging.getLogger(__name__)
# Created by Francesco Mangiacrapa
# francesco.mangiacrapa@isti.cnr.it
# ISTI-CNR Pisa (ITALY)
# D4S_Namespaces_Extra_Util is used to get the extra fields indexed for D4Science namespaces
# @param: namespace_dict is the namespace dict of D4Science namespaces (defined in the Generic Resource: "Namespaces Catalogue Categories")
# @param: extras is the dictionary of extra fields for a certain item
class D4S_Namespaces_Extra_Util():
def get_extras_indexed_for_namespaces(self, namespace_dict, extras):
extras_for_categories = collections.OrderedDict()
# ADDING ALL EXTRAS WITH NAMESPACE
for namespaceid in list(namespace_dict.keys()):
dict_extras = None
nms = namespaceid + ":"
#has_namespace_ref = None
for key, value in extras:
k = key
v = value
# print "key: " + k
# print "value: " + v
if k.startswith(nms):
if namespaceid not in extras_for_categories:
extras_for_categories[namespaceid] = collections.OrderedDict()
dict_extras = extras_for_categories[namespaceid]
log.debug("dict_extras %s "%dict_extras)
if (dict_extras is None) or (not dict_extras):
dict_extras = D4S_Extras(namespace_dict.get(namespaceid), [])
log.debug("dict_extras after init %s " % dict_extras)
#print ("dict_extras after init %s " % dict_extras)
log.debug("replacing namespace into key %s " % k +" with empty string")
nms = namespaceid + ":"
k = k.replace(nms, "")
dict_extras.append_extra(k, v)
extras_for_categories[namespaceid] = dict_extras
log.debug("adding d4s_extra: %s " % dict_extras+ " - to namespace id: %s" %namespaceid)
#has_namespace_ref = True
#break
#ADDING ALL EXTRAS WITHOUT NAMESPACE
for key, value in extras:
k = key
v = value
has_namespace_ref = None
for namespaceid in list(namespace_dict.keys()):
nms = namespaceid + ":"
#IF KEY NOT STARTING WITH NAMESPACE
if k.startswith(nms):
has_namespace_ref = True
log.debug("key: %s " % k + " - have namespace: %s" % nms)
break
if has_namespace_ref is None:
log.debug("key: %s " % k + " - have not namespace")
if NOCATEOGORY not in extras_for_categories:
extras_for_categories[NOCATEOGORY] = collections.OrderedDict()
dict_extras_no_cat = extras_for_categories[NOCATEOGORY]
#print ("dict_extras_no_cat %s " % dict_extras_no_cat)
if (dict_extras_no_cat is None) or (not dict_extras_no_cat):
dict_extras_no_cat = D4S_Extras(NOCATEOGORY, [])
#print ("adding key: %s "%k+" - value: %s"%v)
log.debug("NOCATEOGORY adding key: %s " % k + " - value: %s" % v)
dict_extras_no_cat.append_extra(k, v)
log.debug("dict_extras_no_cat %s " % dict_extras_no_cat)
extras_for_categories[NOCATEOGORY] = dict_extras_no_cat
log.debug("extras_for_categories NOCATEOGORY %s " % extras_for_categories)
return extras_for_categories

110
src/ckanext-d4science_theme/ckanext/d4science_theme/d4sdiscovery/icproxycontroller.py Normal file
View File

@ -0,0 +1,110 @@
import logging
import urllib.request, urllib.error, urllib.parse
from lxml import etree
import xmltodict
import collections
from .d4s_namespaces import D4S_Namespaces
XPATH_NAMESPACES = "/Resource/Profile/Body/namespaces"
gcubeTokenParam = "gcube-token"
NAMESPACE_ID_LABEL = '@id'
log = logging.getLogger(__name__)
# Created by Francesco Mangiacrapa
# francesco.mangiacrapa@isti.cnr.it
# ISTI-CNR Pisa (ITALY)
def getResponseBody(uri):
req = urllib.request.Request(uri)
try:
resp = urllib.request.urlopen(req, timeout=20)
except urllib.error.HTTPError as e:
log.error("Error on contacting URI: %s" % uri)
log.error("HTTPError: %d" % e.code)
return None
except urllib.error.URLError as e:
# Not an HTTP-specific error (e.g. connection refused)
log.error("URLError - Input URI: %s " % uri + " is not valid!!")
return None
else:
# 200
body = resp.read()
return body
# D4S_IS_DiscoveryCatalogueNamespaces is used to discovery namespaces for Catalogue Categories.
# @param: urlICProxy is the URI of IC proxy rest-full service provided by IS
# @param: resourceID is the resource ID of the Generic Resource: "Namespaces Catalogue Categories"
# @param: gcubeToken the gcube token used to contact the IC proxy
class D4S_IS_DiscoveryCatalogueNamespaces():
def __init__(self, urlICProxy, resourceID, gcubeToken):
self.urlICProxy = urlICProxy
self.resourceID = resourceID
self.gcubeToken = gcubeToken
def getNamespacesDictFromResource(self):
doc = {}
namespace_list = []
try:
# print("proxy: "+self.urlICProxy)
# print("resourceID: " + self.resourceID)
# print("gcubeTokenParam: " + gcubeTokenParam)
# print("gcubeToken: " + self.gcubeToken)
uri = self.urlICProxy + "/" + self.resourceID + "?" + gcubeTokenParam + "=" + self.gcubeToken
log.info("Contacting URL: %s" % uri)
theResource = getResponseBody(uri)
log.debug("Resource returned %s " % theResource)
theResourceXML = etree.XML(theResource)
theNamespaces = theResourceXML.xpath(XPATH_NAMESPACES)
log.debug("The body %s" % etree.tostring(theNamespaces[0]))
if theNamespaces is not None and theNamespaces[0] is not None:
bodyToString = etree.tostring(theNamespaces[0])
doc = xmltodict.parse(bodyToString)
else:
log.warn("No Namespace for Catalogue Categories found, returning None")
except Exception as inst:
log.error("Error on getting catalogue namespaces: " + str(inst))
log.info("Returning empty list of namespaces")
return namespace_list
log.debug("IS namespaces resource to dict is: %s" % doc)
if ('namespaces' in doc):
# log.debug('Namespaces obj %s:' % doc['namespaces'])
namespaces = doc['namespaces']
if doc is not None and 'namespace' in namespaces:
namespace_list = namespaces['namespace']
log.info("Loaded %d namespaces from IS resource" % len(namespace_list))
return namespace_list
@staticmethod
def to_namespaces_dict_index_for_id(namespace_list):
namespace_dict = collections.OrderedDict()
log.debug("namespaces to dict: %s" % namespace_list)
try:
if namespace_list is not None and len(namespace_list) > 0:
for namespace in namespace_list:
try:
if NAMESPACE_ID_LABEL in namespace:
namespace_dict[namespace[NAMESPACE_ID_LABEL]] = D4S_Namespaces(
namespace[NAMESPACE_ID_LABEL],
namespace['name'],
namespace['title'],
namespace['description'])
except Exception as inst:
log.error("Error on converting catalogue namespaces: " + str(inst))
except Exception as inst:
log.error("Error on checking namespace_list: " + str(inst))
# print "namespace_dict to Nam: %s"%namespace_dict
return namespace_dict

0
src/ckanext-d4science_theme/ckanext/d4science_theme/fanstatic/.gitignore vendored Normal file
View File

303
src/ckanext-d4science_theme/ckanext/d4science_theme/fanstatic/d4science_scripts.js Normal file
View File

@ -0,0 +1,303 @@
/* =====================================================
JavaScript used by CKAN plugin: 'd4science_theme'
Created by Francesco Mangiacrapa ISTI-CNR Pisa, Italy
===================================================== */
CKAN_D4S_Breadcrumb_Manager = {
breadcrumbShow : function (show) {
var breadcrumb = document.getElementById('ckan-breadcrumb');
console.log('breadcrumb is '+breadcrumb)
if(breadcrumb){
if(show){
breadcrumb.style.display = 'block';
this.organizationTreeShow(true);
} else{
breadcrumb.style.display = 'none';
this.organizationTreeShow(false);
}
}
//var elements = document.getElementsByTagName('a');
//for(var i = 0, len = elements.length; i < len; i++) {
// elements[i].onclick = function () {
// //alert("You clicked an external link to: " + this.href);
// //window.parent.add_hide_breadcrumb_to_dom(false);
// this.add_hide_breadcrumb_to_dom(false);
// }
//}
},
organizationTreeShow : function (show) {
var trees = document.getElementsByClassName("hierarchy-tree-top");
if (trees){
for (i = 0; i < trees.length; i++) {
if(show){
trees[i].style.display = 'block';
} else{
trees[i].style.display = 'none';
}
}
}
},
checkBreadcrumbShow : function () {
var showBdc = this.getSessionStorageItem("showbreadcrumb")
//console.log("showBdc is: "+showBdc)
if(showBdc != undefined && showBdc=="false"){
console.log("Show breadcrumb false");
this.breadcrumbShow(false);
}else{
console.log("Show breadcrumb true");
this.breadcrumbShow(true);
}
},
setSessionStorageItem : function (item_key, item_value) {
// Check browser support
if (typeof(Storage) !== "undefined") {
// Store
sessionStorage.setItem(item_key, item_value);
return true;
} else {
console.log("Sorry, your browser does not support Web Storage...");
return false;
}
},
getSessionStorageItem : function (item_key) {
// Check browser support
if (typeof(Storage) !== "undefined") {
// Store
return sessionStorage.getItem(item_key);
} else {
console.log("Sorry, your browser does not support Web Storage...");
return undefined;
}
}
}
CKAN_D4S_Functions_Util = {
getPosition : function(canvas, event){
var x = new Number();
var y = new Number();
try {
if (event.clientX != undefined && event.clientY != undefined)
{
x = event.clientX;
y = event.clientY;
}
else // Firefox method to get the position
{
x = event.clientX + document.body.scrollLeft +
document.documentElement.scrollLeft;
y = event.clientY + document.body.scrollTop +
document.documentElement.scrollTop;
}
x -= canvas.offsetLeft;
y -= canvas.offsetTop;
}catch (err) {
//silent error
}
return '{"posX": "'+x+'", "posY": "'+y+'"}';
},
// When the user clicks on div, open the popup
showPopupD4S : function(event, my_div, my_popup_left_position) {
var popup = document.getElementById(my_div);
var clickPosition = this.getPosition(my_div, event)
var myPosition = JSON.parse(clickPosition);
this.closePopups(my_div);
// When the user clicks anywhere outside of the modal, close it
/*window.onclick = function(event) {
if (event.target != popup) {
popup.style.display = "none";
}
}*/
popup.classList.toggle("show");
if(my_popup_left_position){
popup.style.left = my_popup_left_position;
}
else if (myPosition.posX){
popup.style.left = myPosition.posX + "px";
}
},
closePopups : function ($target) {
var popups = document.getElementsByClassName('popuptext');
for (i = 0; i < popups.length; i++) {
if (popups[i].getAttribute('id') != $target) {
popups[i].classList.remove('show');
}
}
},
checkURL : function (url) {
//console.log('checking url: '+url)
var regex = new RegExp('^(http:\/\/www\.|https:\/\/www\.|http:\/\/|https:\/\/|www\.|ftp:\/\/)+[^ "]+$');
if (regex.test(url)) {
return true;
}
return false;
}
}
CKAN_D4S_HTMLMessage_Util = {
postHeightToPortlet : function (selectedProduct, product) {
var h = document.body.scrollHeight + "px";
var p = "";
var msg = "";
//WORK AROUND IF TWO MESSAGES ARE SENT FROM A PAGE OF A PRODUCT
//THE MESSAGE WITH 'NULL' PRODUCT IS SKIPPED
//console.log("window.location.pathname? "+window.location.pathname);
var pathArray = window.location.pathname.split('/');
var productContext = "dataset";
if(pathArray.length>1){
//console.log("pathArray is: "+pathArray);
var secondLevelLocation = pathArray[1]; //it is the second level location
//console.log("secondLevelLocation is: "+secondLevelLocation);
//console.log("h is: "+h);
if(secondLevelLocation == productContext){ //is it product context?
if(product !== 'undefined' && product !== null){
p = product;
//console.log("product selected is: "+p);
}else{
//console.log("product is null or undefined, passing only height");
msg = "{\"height\": \""+h+"\"}";
//window.postMessage(msg,'*');
this.postMessageToParentWindow(msg);
return;
}
}
}
//msg = "{'height': '"+h+"', 'product': '"+p+"'}";
msg = "{\"height\": \""+h+"\", \"product\": \""+p+"\"}";
//window.postMessage(msg,'*');
//console.log("posting message in the window: "+msg);
this.postMessageToParentWindow(msg);
},
postMessageToParentWindow : function (msg) {
//window.postMessage(msg,'*');
//console.log("posting message in the window: "+msg);
if(window.parent!=null){
console.log("posting message in the parent window: "+msg);
window.parent.postMessage(msg,'*');
}
return;
}
}
CKAN_D4S_JSON_Util = {
//ADDED by Francesco Mangiacrapa
appendHTMLToElement : function(containerID, elementHTML){
var divContainer = document.getElementById(containerID);
divContainer.innerHTML = "";
divContainer.appendChild(elementHTML);
},
//ADDED by Francesco Mangiacrapa
jsonToHTML : function(containerID, cssClassToTable) {
try
{
var jsonTxt = document.getElementById(containerID).innerHTML;
var jsonObj = JSON.parse(jsonTxt);
//console.log(jsonObj.length)
if(jsonObj.length==undefined)
jsonObj = [jsonObj]
//console.log(jsonObj.length)
// EXTRACT VALUE FOR HTML HEADER.
var col = [];
for (var i = 0; i < jsonObj.length; i++) {
for (var key in jsonObj[i]) {
//console.log('key json' +key)
if (col.indexOf(key) === -1) {
col.push(key);
}
}
}
// CREATE DYNAMIC TABLE.
var table = document.createElement("table");
var addDefaultCss = "json-to-html-table-column";
if(cssClassToTable){
addDefaultCss = cssClassToTable;
}
try{
table.classList.add(addDefaultCss);
}catch(e){
console.log('invalid css add', e);
}
// ADD JSON DATA TO THE TABLE AS ROWS.
for (var i = 0; i < col.length; i++) {
tr = table.insertRow(-1);
var firstCell = tr.insertCell(-1);
//firstCell.style.cssText="font-weight: bold; text-align: center; vertical-align: middle;";
firstCell.innerHTML = col[i];
for (var j = 0; j < jsonObj.length; j++) {
var tabCell = tr.insertCell(-1);
var theValue = jsonObj[j][col[i]];
/* console.log(theValue + ' is url? '+isUrl);*/
if(CKAN_D4S_Functions_Util.checkURL(theValue)){
theValue = '<a target="_blank" href='+theValue+'>'+theValue+'</a>';
}
tabCell.innerHTML = theValue;
}
}
// FINALLY ADD THE NEWLY CREATED TABLE WITH JSON DATA TO A CONTAINER.
this.appendHTMLToElement(containerID, table);
}
catch(e){
console.log('invalid json', e);
}
}
}
//Task #8032
window.addEventListener("message",
function (e) {
var curr_loc = window.location.toString()
var orgin = e.origin.toString()
if(curr_loc.startsWith(orgin)){
//alert("ignoring message from myself");
return;
}
//console.log("origin: "+e.data)
if(e.data == null)
return;
var pMess = JSON.parse(e.data)
//console.log(pMess.explore_vres_landing_page)
window.linktogateway = pMess.explore_vres_landing_page;
},false);

844
src/ckanext-d4science_theme/ckanext/d4science_theme/fanstatic/d4science_theme.css Normal file
View File

@ -0,0 +1,844 @@
/* =====================================================
The "account masthead" bar across the top of the site
===================================================== */
.account-masthead {
background-color: #ccc;
}
/* The "bubble" containing the number of new notifications. */
.account-masthead .account .notifications a span {
background-color: #9fa0a2;
}
/* The text and icons in the user account info. */
.account-masthead .account ul li a {
color: rgba(255, 255, 255, 0.6);
}
/* The user account info text and icons, when the user's pointer is hovering
over them. */
.account-masthead .account ul li a:hover {
color: rgba(255, 255, 255, 0.7);
/* background-color: black;*/
}
/* ========================================================================
The main masthead bar that contains the site logo, nav links, and search
======================================================================== */
.masthead {
background: #eee url("/bg-noise.png") repeat scroll 0 0;
border-top: 1px solid #555;
padding-top: 5px;
padding-bottom: 15px !important;
border-bottom: 1px solid #999;
/* background-image: url("/bg-pattern.min.svg") !important; */
}
.masthead .navigation .nav-pills li a{
color: #187794;
}
a.logo > img{
margin-bottom: 5px;
}
/* The "navigation pills" in the masthead (the links to Datasets,
Organizations, etc) when the user's pointer hovers over them. */
.masthead .navigation .nav-pills li a:hover {
/* background-color: rgb(48, 48, 48);*/
color: white;
}
/* The "active" navigation pill (for example, when you're on the /dataset page
the "Datasets" link is active). */
.masthead .navigation .nav-pills li.active a {
background-color: #d2d2d5;
}
/* The "box shadow" effect that appears around the search box when it
has the keyboard cursor's focus. */
.masthead input[type="text"]:focus {
-webkit-box-shadow: inset 0px 0px 2px 0px rgba(0, 0, 0, 0.7);
box-shadow: inset 0px 0px 2px 0px rgba(0, 0, 0, 0.7);
}
/* ===========================================
The content in the middle of the front page
=========================================== */
/* Remove the "box shadow" effect around various boxes on the page. */
.box {
box-shadow: none;
}
.hero {
background: #FEFEFE repeat scroll 0 0 !important;
}
/* Remove the borders around the "Welcome to CKAN" and "Search Your Data"
boxes. */
.hero .box {
/*border: none;*/
margin-top: 10px !important;
}
/* Change the colors of the "Search Your Data" box. */
.homepage .module-search .module-content {
color: rgb(68, 68, 68);
background-color: white;
}
/* Change the background color of the "Popular Tags" box. */
.homepage .module-search .tags {
background-color: #fcfcfc;
}
.homepage-title{
font-size: 20px;
font-weight: bold;
color: #202020;
margin-bottom: 20px;
}
/* Change the background color of the "Popular Tags" box. */
.homepage .module-search h3{
color: #444;
}
/* Remove some padding. This makes the bottom edges of the "Welcome to CKAN"
and "Search Your Data" boxes line up. */
.module-content:last-child {
/*padding-bottom: 0px;*/
}
.homepage .module-search {
padding: 0px;
}
/* Add a border line between the top and bottom halves of the front page. */
.homepage [role="main"] {
border-bottom: 1px solid #bbb;
padding: 10px 0;
}
.homepage .stats ul li a b{
font-size: 30px !important;
}
[role="main"], .main {
/* background: #f5f6fa url("/bg-pattern.min.svg") repeat; scroll 0 0;*/
/*background: #fafafa url("/bg-pattern.svg") repeat; scroll 0 0;*/
background: #fdfdfd none repeat scroll 0 0;
min-height: 0px !important;
}
.media-item-homepage {
background-color: white;
border-radius: 3px;
float: left;
margin: 15px 0 0 15px;
overflow: hidden;
padding-left: 10px;
padding-right: 10px;
position: relative;
text-align: center;
width: 150px;
}
.media-heading-homepage {
font-size: 16px;
hyphens: auto;
line-height: 1.3;
margin: 5px 0;
}
.media-grid-homepage {
-moz-border-bottom-colors: none;
-moz-border-left-colors: none;
-moz-border-right-colors: none;
-moz-border-top-colors: none;
/* background: #fbfbfb url("../../../base/images/bg.png") repeat scroll 0 0;
border-color: #dddddd;
border-image: none;
border-style: solid;
border-width: 1px 0;*/
list-style: outside none none;
margin: 0 -10px;
padding-bottom: 15px;
}
.media-grid-homepage::before, .media-grid::after {
content: "";
display: table;
line-height: 0;
}
.media-grid-homepage::after {
clear: both;
}
.background-circle{
padding: 10px 10px;
display: inline-block !important;
-webkit-border-radius: 90px;
-moz-border-radius: 90px;
border-radius: 90px;
background-color: #4679b2;
text-decoration: none !important;
}
.color-white{
color: white !important;
}
.badge-circle {
border-radius: 50% 50% 50% 50% !important;
height: 60px;
text-align: center;
vertical-align: middle;
width: 65px;
background-color: #4679b2;
display: inline-block !important;
padding-top: 5px;
text-decoration: none !important;
}
/* ====================================
The footer at the bottom of the site
==================================== */
.site-footer, body {
background-color: #bbb;
font-family: "Lato","Helvetica Neue",Helvetica,Arial,sans-serif;
font-size: 16px;
}
/* The text in the footer. */
.site-footer,
.site-footer label,
.site-footer small {
color: rgba(255, 255, 255, 0.6);
}
/* The link texts in the footer. */
.site-footer a {
color: rgba(255, 255, 255, 0.6);
}
.site-footer-internal{
min-height: 10px;
padding: 2px 0;
font-size: 12px;
}
.site-footer-internal {
/*background-color: rgba(255, 255, 255, 0.6);*/
text-align: center;
/*display: inline-block;*/
}
.site-footer-internal,
.site-footer-internal label,
.site-footer-internal small {
}
.site-footer-internal a {
display: inline-block;
}
.d4s-hide-text {
background-color: transparent;
border: 0 none;
color: transparent;
font: 0px/0 a;
text-shadow: none;
}
.d4science-footer-logo {
background: url("/gCube_70.png") no-repeat scroll left top rgba(0, 0, 0, 0);
height: 32px;
margin-top: 2px;
text-indent: -900em;
width: 75px;
}
.d4s-ckan-footer-logo {
background: rgba(0, 0, 0, 0) url("/ckan-logo-footer.png") no-repeat scroll left top;
height: 21px;
margin-top: 2px;
text-indent: -900em;
width: 69px;
}
.site-footer-d4science {
font-size: 14px;
color: #f5f5f5;
text-align: center;
height: 25px;
padding-top: 5px;
background-color: #7F7F7F;
}
.site-footer-d4science a {
font-weight: bold;
text-decoration: none;
color: white;
}
/* ====================================
Base elements of the site
==================================== */
div .principaltitle {
color: inherit;
font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
font-size: 20px;
font-weight: bold;
line-height: 1.2;
margin: 15px 0;
text-rendering: optimizelegibility;
word-break: break-all;
padding-bottom: 10px;
padding-top: 5px;
border-bottom: 1px solid #eee;
}
div .notes {
color: #444444;
font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
font-size: 14px;
line-height: 1.3;
text-align: justify;
word-break: break-all;
}
div .infotitle {
font-size: 15px;
hyphens: auto;
line-height: 1.3;
word-break: break-all;
font-weight: bold;
}
.toolbar .breadcrumb{
font-size: 16px !important;
}
.box{
border: 0px !important;
}
div .sectiontitle{
color: #9F9F9F;
font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
font-size: 17px;
font-weight: bold;
margin: 20px 0;
margin-top: 20px;
margin-bottom: 10px;
text-rendering: optimizelegibility;
}
section .well {
background-color: #fdfdfd !important;
border: 1px solid #e3e3e3;
border-radius: 4px;
box-shadow: none !important;
margin-bottom: 20px;
min-height: 20px;
}
.page-heading {
font-size: 18px;
line-height: 1.2;
margin-top: 20px;
margin-bottom: 0px;
}
#dataset-resources .resource-list{
background-color: #fdfdfd !important;
border: 1px solid #e3e3e3;
border-radius: 4px;
box-shadow: none !important;
margin: -1px 0 !important;
}
.wrapper{
border: 1px solid #d0d0d0;
box-shadow: 0 0 0 2px rgba(0, 0, 0, 0.05);
border-radius: 3px
}
.home-popular{
padding-top: 25px;
}
.logo-homepage{
max-height: 60px;
}
.statistics-show{
-webkit-border-radius: 5px;
-moz-border-radius: 5px;
border-radius: 5px;
color: #444444;
text-decoration: none;
}
.d4s-center-cropped{
text-align: center;
background-color: #eee;
border: 1px solid #ddd;
padding-bottom: 10px;
padding-top: 10px;
}
.tag-list {
font-size: 14px;
}
/* ====================================
Acquired Dataset
==================================== */
.label-acquired {
background-color: #55a1ce;
}
.label-owner {
background-color: #e0051e;
}
.divider {
margin-left:10px;
height:auto;
display:inline-block;
}
/* ====================================
List Dataset
==================================== */
/*LEFT
.show_meatadatatype {
color: white;
display: inline-block; // Inline elements with width and height. TL;DR they make the icon buttons stack from left-to-right instead of top-to-bottom
position: relative; // All 'absolute'ly positioned elements are relative to this one
margin-bottom: 20px;
margin-left: 25px;
}
*/
/*RIGHT*/
.show_meatadatatype {
color: white;
display: inline-block;
float: right;
margin-right: 2px;
margin-top: -20px;
position: relative;
}
/* LEFT
* Position the badge within the relatively positioned button
.button__badge {
background-color: #fa3e3e;
border-radius: 2px;
color: white;
padding: 1px 6px;
font-size: 10px;
position: absolute;
top: 0;
right: 0;
}*/
/* RIGTH */
.button__badge {
color: #808080;
padding: 0px 2px;
font-size: 10px;
top: 0;
right: 0;
font-family: sans-serif, times, georgia;
}
/* ====================================
Modal Popup
==================================== */
/* Popup container - can be anything you want */
/* The Modal (background) */
.d4s_modal {
display: none; /* Hidden by default */
position: fixed; /* Stay in place */
z-index: 10001; /* Sit on top (NB. At 1000 there is the zoom in/out of the Map Widget)*/
/*padding-top: 100px;*/ /* Location of the box */
left: 0;
top: 0;
width: 100%; /* Full width */
height: 100%; /* Full height */
overflow: auto; /* Enable scroll if needed */
background-color: rgb(0,0,0); /* Fallback color */
background-color: rgba(0,0,0,0.4); /* Black w/ opacity */
}
/* Modal Content */
.d4s_modal-content {
background-color: #fefefe;
/*margin: auto;*/
padding: 20px;
border: 1px solid #888;
-webkit-border-radius: 5px;
-moz-border-radius: 5px;
border-radius: 5px;
position: absolute;
left: 50%;
margin-left: -225px;
width: 450px;
}
/* The Close Button */
.d4s_close {
color: #aaaaaa;
float: right;
font-size: 28px;
font-weight: bold;
padding-left: 20px;
}
.d4s_close:hover,
.d4s_close:focus {
color: #000;
text-decoration: none;
cursor: pointer;
}
.d4s_div_clickable{
cursor: pointer;
}
/*====================================
D4S POPUP
======================================*/
/* Popup container - can be anything you want */
.popupD4SNoArrow {
position: relative;
cursor: pointer;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
}
/* The actual popup */
.popupD4SNoArrow .popuptext {
visibility: hidden;
width: 300px;
background-color: #555;
color: #fff;
text-align: center;
border-radius: 6px;
padding: 8px;
position: absolute;
z-index: 1;
bottom: 125%;
left: 50%;
margin-left: -150px;
}
/* Toggle this class - hide and show the popup */
.popupD4SNoArrow .show {
visibility: visible;
-webkit-animation: fadeIn 1s;
animation: fadeIn 1s;
}
/* Popup container - can be anything you want */
.popupD4S {
position: relative;
cursor: pointer;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
}
/* The actual popup */
.popupD4S .popuptext {
visibility: hidden;
width: 300px;
background-color: #555;
color: #fff;
text-align: center;
border-radius: 6px;
padding: 8px;
position: absolute;
z-index: 1;
bottom: 125%;
left: 50%;
margin-left: -150px;
}
/* Popup arrow */
.popupD4S .popuptext::after {
content: "";
position: absolute;
top: 100%;
left: 50%;
margin-left: -5px;
border-width: 5px;
border-style: solid;
border-color: #555 transparent transparent transparent;
}
/* Toggle this class - hide and show the popup */
.popupD4S .show {
visibility: visible;
-webkit-animation: fadeIn 1s;
animation: fadeIn 1s;
}
/* Add animation (fade in the popup) */
@-webkit-keyframes fadeIn {
from {opacity: 0;}
to {opacity: 1;}
}
@keyframes fadeIn {
from {opacity: 0;}
to {opacity:1 ;}
}
/*====================================
D4S PACKAGE
======================================*/
.graphic-preview-style {
text-align: center;
border-top: 1px dotted #DDD;
padding-top: 10px;
padding-bottom: 0px;
margin-top: 15px;
}
.graphic-preview-style a{
font-size: 13px;
}
.graphic-preview-style img{
max-width: 100% !important;
height: auto;
}
.graphic-preview-style #graphic-title{
font-size: 13px;
}
.nav-item{
word-wrap:break-word;
}
/*====================================
RESOURCE_LIST RESOURCE_ITEM INTO PACKAGE
======================================*/
.required-access {
font-style: italic;
font-weight: bold;
padding: 5px;
}
/*====================================
LINK TO RESOURCES FROM PACKAGE LIST
======================================*/
.dataset-resources li a {
background-color: #187794;
}
.label[data-format="csw"], .label[data-format*="csw"] {
background-color: #e6b800;
}
/*====================================
CSS APPLIED TO Similar GRSF Records
======================================*/
.my-grsf-table{
word-break: break-all;
}
.my-grsf-table tr td{
width: inherit;
}
.my-grsf-table tr td:first-child{
width: 82px !important;
}
/*====================================
CSS APPLIED in base.html
======================================*/
#ckan-page-loading {
display: none;
position: fixed;
top: 50%;
left: 50%;
margin-top: -130px;
margin-left: -130px;
width: 260px;
height: 260px;
z-index: 100000;
background-image: url("/pageloading.gif");
background-repeat: no-repeat;
background-position: center;
}
/*====================================
CSS APPLIED in search_for_location.html
======================================*/
div#search-for-location {
}
div#search-for-location #dataset-map {
position: relative !important;
top: +0px !important;
}
div#search-for-location #dataset-map-container {
height: 300px;
}
div#search-for-location .module-heading {
display: none;
}
div#search-for-extent{
padding-top: 10px;
}
/*====================================
CSS APPLIED in additional_info.html
======================================*/
.qr-code-table {
width: 100%;
}
.qr-code-table td {
width: 85%;
border: 1px solid #e3e3e3;
}
.qr-code-table td:first-child {
padding-left: 10px;
border-right-style: none;
}
.qr-code-table td:last-child {
width: 105px;
text-align: center;
border-left-style: none;
}
/* MAX-WITH APPIED TO QR_CODE */
.qr-code-table img {
max-width: 100px;
height: auto;
}
/*====================================
CSS APPLIED FROM JSON TO HTML TABLE
======================================*/
.json-to-html-table-column{
word-break: break-all;
}
.json-to-html-table-column tr td{
width: inherit;
}
.json-to-html-table-column tr td:first-child{
font-weight: bold;
color: #5a5a5a;
}
/*====================================
CSS APPLIED into custom_form_fields
======================================*/
.disabled-div{
pointer-events: none;
opacity: 0.5;
}
.disabled-div input[type="text"]{
background: #f1f1f1;
}
/*====================================
CSS APPLIED into extra_table.html
======================================*/
.read-more-state {
display: none;
}
.read-more-target {
opacity: 0;
max-height: 0;
font-size: 0;
transition: .25s ease;
}
.read-more-state:checked ~ .read-more-wrap .read-more-target {
opacity: 1;
font-size: inherit;
max-height: 999em;
content: "";
}
.read-more-state ~ .read-more-trigger:before {
content: 'Show more';
}
.read-more-state:checked ~ .read-more-trigger:before {
content: 'Show less';
}
.read-more-state:checked ~ .read-more-wrap::after {
content: "";
}
.read-more-trigger {
cursor: pointer;
display: inline-block;
padding: 0 .5em;
color: #187794;
font-size: .9em;
line-height: 2;
border: 1px solid #ddd;
border-radius: .25em;
font-weight: normal;
}
.read-more-trigger::after {
content: "";
}
.read-more-wrap {
margin-bottom: 2px;
}
.read-more-wrap::after{
content: " ...";
}

715
src/ckanext-d4science_theme/ckanext/d4science_theme/helpers.py Normal file
View File

@ -0,0 +1,715 @@
import ckan.authz as authz
import ckan.model as model
from webhelpers2.html import literal
from webhelpers2.text import truncate
import ckan.lib.helpers as h
import ckan.logic as logic
from ckan.common import config
from ckanext.d4science_theme.d4sdiscovery.d4s_namespaces_controller import D4S_Namespaces_Controller
from ckanext.d4science_theme.d4sdiscovery.d4s_namespaces_extras_util import D4S_Namespaces_Extra_Util
from ckanext.d4science_theme.qrcodelink.generate_qrcode import D4S_QrCode
import urllib.request, urllib.error, urllib.parse
from ckan.common import (
_, g, c, request, session
)
import random
from operator import itemgetter
from logging import getLogger
import base64
import sys, os, re
import configparser
import collections
log = getLogger(__name__)
systemtype_field = 'systemtypefield'
systemtype_field_default_value = 'system:type'
ic_proxy_url_field = 'ic_proxy_url'
ic_proxy_url_field_default_value = "https://registry.d4science.org/icproxy/gcube/service"
application_token_field = 'application_token'
namespaces_generic_resource_id_default_value = "23d827cd-ba8e-4d8c-9ab4-6303bdb7d1db"
namespaces_gr_id_fieldname = "namespaces_generic_resource_id"
namespaceseparator_field = 'namespace_separator'
namespaceseparator_field_default_value = ':'
systemtype_rgb_colors = ['#c0392b ', '#585858', '#04407C', '#9b59b6', '#2ecc71', '#16a085', '#7f8c8d ', '#2ecc71',
'#FA8072', '#00FFFF', '#C76611', '#f39c12', '#800000']
systemtype_field_colors = 'systemtype_field_colors'
systemtype_cms_fields_placeholders = {'prefix': 'system:cm_', 'item_status': 'system:cm_item_status'}
NOCATEOGORY = 'nocategory'
TRANSLATE_OF_ = 'translate_of_'
ctg_namespace_ctrl = None
# ADDED BY FRANCESCO.MANGIACRAPA, related to Task #5196
def get_user_role_for_group_or_org(group_id, user_name):
''' Returns the user's role for the group. (Ignores privileges that cascade
in a group hierarchy.)'''
return authz.users_role_for_group_or_org(group_id, user_name)
# ADDED BY FRANCESCO.MANGIACRAPA, related to breadcrumb for Group
def get_parents_for_group(group_name_or_id):
''' Returns the user's role for the group. (Ignores privileges that cascade
in a group hierarchy.)'''
group = model.Group.get(group_name_or_id)
if group:
return model.Group.get_parent_group_hierarchy(group)
else:
return None
# ADDED BY FRANCESCO.MANGIACRAPA
def get_header_param(parameter_name, default=None):
''' This function allows templates to access header string parameters
from the request. '''
return request.headers.get(parameter_name, default)
# ADDED BY FRANCESCO.MANGIACRAPA
def get_request_param(parameter_name, default=None):
''' This function allows templates to access query string parameters
from the request. '''
return request.params.get(parameter_name, default)
# ADDED BY FRANCESCO.MANGIACRAPA
def get_cookie_value(cookie_name, default=None):
''' This function allows templates to access cookie by cookie_name parameter
from the request. '''
value = request.cookies.get(cookie_name)
if value is None:
print(('cookie: ' + cookie_name + ', has value None'))
else:
print(('cookie: ' + cookie_name + ', has value ' + value))
return value
# Updated BY FRANCESCO.MANGIACRAPA, added allow_html
def markdown_extract_html(text, extract_length=190, allow_html=False):
''' Returns the plain text representation of markdown encoded text. That
is the texted without any html tags. If extract_length is 0 then it
will not be truncated.'''
if not text:
return ''
if allow_html:
plain = h.markdown(text.strip())
else:
plain = h.RE_MD_HTML_TAGS.sub('', h.markdown(text))
if not extract_length or len(plain) < extract_length:
return literal(plain)
return literal(str(truncate(plain, length=extract_length, indicator='...', whole_word=True)))
def get_systemtype_field_dict_from_session():
'''Return the value of 'ckan.d4science_theme.metadatatypefield'
read from production.ini'''
systemtype_fieldname = session.get(systemtype_field)
if systemtype_fieldname is None:
log.info(systemtype_field + " not found in session, loading from config")
else:
log.debug(systemtype_field + " found in session having value: %s" % systemtype_fieldname)
return systemtype_fieldname
systemtype_fieldname = config.get('ckan.d4science_theme.' + systemtype_field)
if systemtype_fieldname is None:
log.info(
systemtype_field + " field does not exist in production.ini, returning default value %s" % systemtype_field_default_value)
systemtype_fieldname = systemtype_field_default_value
separator = get_namespace_separator_from_session()
log.debug("Replacing %s" % separator + " with empty string for key %s" % systemtype_field)
systemtype_fieldname_name = systemtype_fieldname.replace(separator, "")
purgedfieldname = purge_namespace_to_fieldname(systemtype_fieldname)
log.debug("Setting %s" % systemtype_fieldname + " in session for key %s" % systemtype_field)
session[systemtype_field] = {'id': systemtype_fieldname, 'name': systemtype_fieldname_name,
'title': purgedfieldname}
session.save()
return session[systemtype_field]
def get_d4s_namespace_controller():
'''Instance the D4S_Namespaces_Controller and check that the namespaces are not empty reading it from IS and/or using a Caching system.
The ic-proxy-url is built by reading the configurations from production.ini'''
d4s_extras_controller = D4S_Namespaces_Controller.getInstance()
global ctg_namespace_ctrl
if ctg_namespace_ctrl is not None:
log.info("ctg_namespace_ctrl with configurations is NOT None")
the_namespaces = d4s_extras_controller.load_namespaces(ctg_namespace_ctrl['ic_proxy_url'],
ctg_namespace_ctrl['resource_id'],
ctg_namespace_ctrl['application_token'])
log.debug("the_namespaces are %s" % the_namespaces)
if the_namespaces is None or len(the_namespaces) == 0:
log.info("D4S_Namespaces_Controller obj with none or empty namespaces, going to read them")
else:
log.info("d4s_namespaces_controller found and the namespaces property is not empty: %s" % d4s_extras_controller)
return d4s_extras_controller
else:
log.info("ctg_namespace_ctrl with configurations is None, instancing it")
ic_proxy_url_value = config.get('ckan.d4science_theme.' + ic_proxy_url_field)
if ic_proxy_url_value is None:
log.info(
"ckan.d4science_theme." + ic_proxy_url_field + " field does not exist in production.ini, returning default value %s" % ic_proxy_url_field_default_value)
ic_proxy_url_value = ic_proxy_url_field_default_value
application_token_fieldname = config.get('ckan.d4science_theme.' + application_token_field)
if application_token_fieldname is None:
log.error("ckan.d4science_theme." + application_token_field + " field does not exist in production.ini!!!")
application_token_fieldname = None
namespaces_gr_id_fieldname_value = config.get('ckan.d4science_theme.' + namespaces_gr_id_fieldname)
if namespaces_gr_id_fieldname_value is None:
log.error("ckan.d4science_theme." + application_token_field + " field does not exist in production.ini!!!")
namespaces_gr_id_fieldname_value = namespaces_generic_resource_id_default_value
# filling the ctg_namespace_ctrl with IS configurations to perform the query for loading the namespaces from IS
ctg_namespace_ctrl = {'ic_proxy_url': ic_proxy_url_value,
'application_token': application_token_fieldname,
'resource_id': namespaces_gr_id_fieldname_value}
d4s_extras_controller.load_namespaces(ctg_namespace_ctrl['ic_proxy_url'], ctg_namespace_ctrl['resource_id'],
ctg_namespace_ctrl['application_token'])
return d4s_extras_controller
def get_extras_indexed_for_namespaces(extras):
namespace_dict = get_namespaces_dict()
# log.info("my_namespace_dict %s" % namespace_dict)
my_extra = get_extras(extras)
# log.info("my_extra is %s" % my_extra)
# d4s_extras_controller = D4S_Namespaces_Controller.getInstance()
# extras_indexed_for_categories = d4s_extras_controller.get_extras_indexed_for_namespaces(namespace_dict, my_extra)
extras_indexed_for_categories = D4S_Namespaces_Extra_Util().get_extras_indexed_for_namespaces(namespace_dict,
my_extra)
return extras_indexed_for_categories
def get_namespaces_dict():
d4s_extras_controller = get_d4s_namespace_controller()
if d4s_extras_controller is not None:
return d4s_extras_controller.get_dict_ctg_namespaces()
else:
log.info("local_extras_controller is null, returning empty dictionary for namespaces")
return {}
def get_extra_for_category(extras_indexed_for_categories, key_category):
if key_category in extras_indexed_for_categories:
catalogue_namespace = extras_indexed_for_categories[key_category]
return catalogue_namespace.extras
return []
def get_systemtype_value_from_extras(package, extras=None):
'''Returns the value of metadata fied read from key 'metadatatype'
stored into extra fields if it exists, 'No Type' otherwise'''
systemtype_dict = get_systemtype_field_dict_from_session()
no_type = 'No Type'
if extras is None:
return no_type
for extra in extras:
k, v = extra['key'], extra['value']
log.debug("key is %s" % k)
log.debug("value is %s" % v)
if k == str(systemtype_dict['id']):
return v
return no_type
def get_namespace_separator_from_session():
'''Returns the character used to separate namespace from fieldname'''
separator = session.get(namespaceseparator_field)
if separator is None:
log.info(namespaceseparator_field + " not found in session, loading from config")
else:
log.debug(namespaceseparator_field + " found in session: %s" % separator)
return separator
namespace_sep = config.get('ckan.d4science_theme.' + namespaceseparator_field)
if namespace_sep is None:
log.info(
namespaceseparator_field + " field does not exist in production.ini, returning default value %s" % namespaceseparator_field_default_value)
namespace_sep = namespaceseparator_field_default_value
log.debug("Setting %s" % namespace_sep + " in session for key %s" % namespaceseparator_field)
session[namespaceseparator_field] = namespace_sep
return namespace_sep
def get_extras(package_extras, auto_clean=False, subs=None, exclude=None):
''' Used for outputting package extras
:param package_extras: the package extras
:type package_extras: dict
:param auto_clean: If true capitalize and replace -_ with spaces
:type auto_clean: bool
:param subs: substitutes to use instead of given keys
:type subs: dict {'key': 'replacement'}
:param exclude: keys to exclude
:type exclude: list of strings
'''
# If exclude is not supplied use values defined in the config
if not exclude:
exclude = g.package_hide_extras
output = []
for extra in package_extras:
if extra.get('state') == 'deleted':
continue
k, v = extra['key'], extra['value']
if k in exclude:
continue
if subs and k in subs:
k = subs[k]
elif auto_clean:
k = k.replace('_', ' ').replace('-', ' ').title()
if isinstance(v, (list, tuple)):
v = ", ".join(map(str, v))
output.append((k, v))
return output
def purge_namespace_to_fieldname(fieldname):
separator = get_namespace_separator_from_session()
if fieldname is None:
return ""
if separator not in fieldname:
return fieldname
end = fieldname.index(separator) + 1
max_l = len(fieldname)
if end < max_l:
return fieldname[end:max_l]
return fieldname
def purge_namespace_to_string(facet):
if not c.search_facets or \
not c.search_facets.get(facet) or \
not c.search_facets.get(facet).get('items'):
return ""
facet_name = c.search_facets.get(facet)
print(("facet_name " + str(facet_name)))
end = str(facet_name).index(":")
if end <= len(facet_name):
return facet_name[:end]
return facet_name
def count_facet_items_dict(facet, limit=None, exclude_active=False):
if not c.search_facets or \
not c.search_facets.get(facet) or \
not c.search_facets.get(facet).get('items'):
return 0
facets = []
for facet_item in c.search_facets.get(facet)['items']:
if not len(facet_item['name'].strip()):
continue
if not (facet, facet_item['name']) in list(request.params.items()):
facets.append(dict(active=False, **facet_item))
elif not exclude_active:
facets.append(dict(active=True, **facet_item))
# for count,
# print "facets " + str(facets)
total = len(facets)
log.debug("total facet: %s" % facet + " are %d" % total)
return total
def random_color():
rgbl = [255, 0, 0]
random.shuffle(rgbl)
return tuple(rgbl)
def check_url(the_url):
try:
urllib.request.urlopen(the_url)
return True
except urllib.error.HTTPError as e:
# print(e.code)
return False
except urllib.error.URLError as e:
# print(e.args)
return False
except Exception as error:
# print(error)
return False
def get_color_for_type(systemtype_field_value):
'''Return a color assigned to a system type'''
systemtypecolors = session.get(systemtype_field_colors)
# log.info("color: getting color for type: %s" %systemtype_field_value)
if systemtypecolors is None:
log.info("color: " + systemtype_field_colors + " not found in session, creating new one")
systemtypecolors = {}
session[systemtype_field_colors] = systemtypecolors
else:
log.debug("color: " + systemtype_field_colors + " found in session having value: %s" % systemtypecolors)
e_color = systemtypecolors.get(systemtype_field_value)
if e_color is None:
usedcolorsLen = len(systemtypecolors)
colorsLen = len(systemtype_rgb_colors)
index = usedcolorsLen if usedcolorsLen < colorsLen else random.randint(0, colorsLen - 1)
e_color = systemtype_rgb_colors[index]
# log.debug("color: adding color %s" %e_color +" index is: "+str(index))
systemtypecolors[systemtype_field_value] = e_color
session[systemtype_field_colors] = systemtypecolors
session.save()
# log.debug("color: returning color %s" %e_color +" for type: "+systemtype_field_value)
return e_color
def ordered_dictionary(list_to_be_sorted, property='name', ordering="asc"):
# print ("dict %s" %list_to_be_sorted)
ord = False if ordering == "asc" else True
if list_to_be_sorted:
return sorted(list_to_be_sorted, key=itemgetter(property), reverse=ord)
return list_to_be_sorted
def qrcode_for_url(url):
if url:
try:
qr_code = D4S_QrCode(url)
image_path = qr_code.get_qrcode_path()
with open(image_path, "rb") as image_file:
return base64.b64encode(image_file.read())
return ""
except Exception as error:
log.error("Error on getting qrcode for url: " + url + "error: %s" % error)
return ""
def get_list_of_organizations(limit=10, sort='packages'):
to_browse_organizations = []
try:
data = {}
if sort:
data['sort'] = sort
data['limit'] = limit
data['all_fields'] = True
ordered_organizations = []
ordered_organizations = logic.get_action('organization_list')({}, data)
for organization in ordered_organizations:
try:
to_browse_obj = {}
if not organization['name']:
continue
to_browse_obj['name'] = organization['name']
if 'package_count' in organization:
to_browse_obj['package_count'] = organization['package_count']
if 'display_name' in organization:
to_browse_obj['display_name'] = organization['display_name']
image_url = get_url_to_icon_for_ckan_entity(organization['name'], 'organization', False)
# Using ICON as first option
if image_url:
to_browse_obj['url'] = image_url
# Using object image_url as second one
elif 'image_url' in organization and organization['image_url']:
to_browse_obj['url'] = organization['image_url']
# Default placeholder
else:
to_browse_obj['url'] = h.url_for_static('/images/organisations/icon/placeholder-organization.png')
to_browse_organizations.append(to_browse_obj)
except (logic.NotFound, logic.ValidationError, logic.NotAuthorized) as error:
# SILENT
log.warn("Error on putting organization: %s" % error)
log.info("browse %d" % len(ordered_organizations) + " organisation/s")
except (logic.NotFound, logic.ValidationError, logic.NotAuthorized) as error:
log.error("Error on getting organizations: %s" % error)
return []
return to_browse_organizations
def get_list_of_groups(limit=10, sort='package_count'):
to_browse_groups = []
try:
data = {}
if sort:
data['sort'] = sort
data['limit'] = limit
data['all_fields'] = True
ordered_groups = []
ordered_groups = logic.get_action('group_list')({}, data)
for group in ordered_groups:
# print "\n\ngroup %s" %group
try:
to_browse_obj = {}
if not group['name']:
continue
to_browse_obj['name'] = group['name']
if 'package_count' in group:
to_browse_obj['package_count'] = group['package_count']
if 'display_name' in group:
to_browse_obj['display_name'] = group['display_name']
if 'image_url' in group and group['image_url']:
to_browse_obj['url'] = group['image_url']
else:
to_browse_obj['url'] = get_url_to_icon_for_ckan_entity(group['name'], 'group')
to_browse_groups.append(to_browse_obj)
except (logic.NotFound, logic.ValidationError, logic.NotAuthorized) as error:
# SILENT
log.warn("Error on putting group: %s" % error)
log.info("browse %d" % len(ordered_groups) + " organisation/s")
except (logic.NotFound, logic.ValidationError, logic.NotAuthorized) as error:
log.error("Error on getting group: %s" % error)
return []
return to_browse_groups
def get_browse_info_for_organisations_or_groups(type='organization', limit=10, sort_field=None):
sort = None
if sort_field:
sort = sort_field
if type == 'organization':
if sort:
return get_list_of_organizations(limit, sort)
else:
return get_list_of_organizations(limit)
elif type == 'group':
if sort:
return get_list_of_groups(limit, sort)
else:
return get_list_of_groups(limit)
return []
def get_image_display_for_group(item_id):
if item_id:
try:
item_obj = model.Group.get(item_id)
if item_obj and item_obj.image_url:
return item_obj.image_url
else:
return h.url_for_static('/images/groups/icon/placeholder-group.png')
except Exception as error:
log.error("Error on getting item obj: %s" % item_id + "error: %s" % error)
def get_application_path():
if getattr(sys, 'frozen', False):
# If the application is run as a bundle, the pyInstaller bootloader
# extends the sys module by a flag frozen=True and sets the app
# path into variable _MEIPASS'.
application_path = sys._MEIPASS
else:
application_path = os.path.dirname(os.path.abspath(__file__))
return application_path
'''
Get icon url for input entity type
@:param default_placeholder if True returns the URL of default image, otherwise None.
'''
def get_url_to_icon_for_ckan_entity(item_name, entity_type=None, default_placeholder=True):
if not entity_type or not item_name:
return None
dir_images_full_path = get_application_path() + "/public/images"
dir_images_relative_path = "/images"
if entity_type == 'group':
dir_images_full_path += "/groups"
dir_images_relative_path += "/groups"
placeholder_icon = "placeholder-group.png"
elif entity_type == 'organization':
dir_images_full_path += "/organisations"
dir_images_relative_path += "/organisations"
placeholder_icon = "placeholder-organization.png"
elif entity_type == 'type':
dir_images_full_path += "/types"
dir_images_relative_path += "/types"
placeholder_icon = "placeholder-type.png"
else:
return None
icon_path = dir_images_full_path + "/icon/" + item_name.lower() + ".png"
if os.path.isfile(icon_path):
return h.url_for_static(dir_images_relative_path + "/icon/" + item_name.lower() + ".png")
elif default_placeholder:
return h.url_for_static(dir_images_relative_path + "/icon/" + placeholder_icon)
return None
def get_user_info(user_id_or_name):
if user_id_or_name:
try:
item_obj = model.User.get(user_id_or_name)
if item_obj:
return item_obj
return None
except Exception as error:
log.error("Error on getting item obj: %s" % user_id_or_name + "error: %s" % error)
return None
'''
Search the value of my_search_string into input file {ckan_po_file} or the default file ckan.po provided as CKAN language
and returns its translate
'''
def get_ckan_translate_for(ckan_po_file, my_search_string):
my_translate = session.get(TRANSLATE_OF_ + my_search_string)
if not my_search_string:
return ""
if my_translate:
log.info("Translate of '%s' " % my_search_string + " found in session as: %s" % my_translate)
return my_translate
if not ckan_po_file:
ckan_po_file = "/usr/lib/ckan/default/src/ckan/ckan/i18n/en_gcube/LC_MESSAGES/ckan.po"
numlines = 0
numfound = 0
found = 0
line_text = ""
try:
infile = open(ckan_po_file, "r")
for line in infile:
numlines += 1
if found > 0:
numfound += 1
line_text += str(line)
found = 0 # reset found
# found += line.upper().count(my_search_string.upper())
found += line.count(my_search_string)
if found > 0:
log.debug("The search string '%s'" % my_search_string + " was found. Read the line: %s" % str(line))
infile.close()
except Exception as e:
print(("Exception during parsing the file %s" % ckan_po_file, e))
log.info("Recap: '%s' was found" % my_search_string + " %i times " % numfound + "in %i lines" % numlines)
log.debug("Line text is: %s" % line_text)
pattern = '"([A-Za-z0-9_ \./\\-]*)"'
m = re.search(pattern, line_text)
try:
my_translate = m.group()
except Exception as e:
print(("Pattern %s" % my_search_string + " not found ", e))
if my_translate:
log.debug("Replacing quotas...")
my_translate = my_translate.replace("\"", "")
log.info("Found the string '%s'" % my_translate + " that translating '%s'" % my_search_string)
session[TRANSLATE_OF_ + my_search_string] = my_translate
session.save()
return my_translate
def get_location_to_bboxes():
config = configparser.ConfigParser()
config.optionxform = str
location_to_bboxes = {}
try:
bboxes_file = get_application_path() + "/public/location_to_bboxes.ini"
log.debug("bboxes_file is: '%s'" % bboxes_file)
config.read(bboxes_file)
for section_name in config.sections():
log.debug('Location to bboxes Section: ' + section_name)
# print ' Options:', parser.options(section_name)
for name, value in config.items(section_name):
location_to_bboxes[name] = value.replace(",", "%2C")
ordDictBboxes = collections.OrderedDict(sorted(location_to_bboxes.items()))
log.debug("Ordered 'bboxes_file' dict: '%s'" % ordDictBboxes)
return ordDictBboxes
except Exception as error:
log.error("Error on reading file: %s" % bboxes_file + "error: %s" % error)
def get_content_moderator_system_placeholder():
return systemtype_cms_fields_placeholders

423
src/ckanext-d4science_theme/ckanext/d4science_theme/plugin.py Normal file
View File

@ -0,0 +1,423 @@
# encoding: utf-8
from logging import getLogger
import ckan.plugins as plugins
from ckanext.d4science_theme import helpers
import ckan.plugins.toolkit as toolkit
import ckan.lib.dictization.model_save as model_save
import ckan.model as model
import ckan.lib.helpers as h
import sqlalchemy as sa
from ckanext.d4science_theme.controllers.organization import OrganizationVREController
from ckanext.d4science_theme.controllers.home import d4SHomeController
from ckan.controllers.home import HomeController
from ckan.config.middleware.common_middleware import TrackingMiddleware
from ckan.plugins import IRoutes
from ckan.common import (
g
)
# Created by Francesco Mangiacrapa
# francesco.mangiacrapa@isti.cnr.it
# ISTI-CNR Pisa (ITALY)
log = getLogger(__name__)
d4s_ctg_namespaces_controller = None
def remove_check_replicated_custom_key(schema):
if schema is not None:
schema.pop('__before', None)
return schema
#CREATED BY FRANCESCO MANGIACRAPA FOR OVERRIDING THE package_extras_save FROM dictization.model_save.py
def _package_extras_save(extra_dicts, obj, context):
''' It can save repeated extras as key-value '''
allow_partial_update = context.get("allow_partial_update", False)
if extra_dicts is None and allow_partial_update:
return
model = context["model"]
session = context["session"]
#ADDED BY FRANCESCO MANGIACRAPA
log.debug("extra_dicts: "+str(str(extra_dicts)).encode('utf-8'))
#print "extra_dicts: "+str(extra_dicts)
extras_list = obj.extras_list
#extras = dict((extra.key, extra) for extra in extras_list)
old_extras = {}
extras = {}
for extra in extras_list or []:
old_extras.setdefault(extra.key, []).append(extra.value)
extras.setdefault(extra.key, []).append(extra)
#ADDED BY FRANCESCO MANGIACRAPA
#print "old_extras: "+str(old_extras)
new_extras = {}
for extra_dict in extra_dicts or []:
#print 'extra_dict key: '+extra_dict["key"] + ', value: '+extra_dict["value"]
#new_extras.setdefault(extra_dict["key"], []).append(extra_dict["value"])
if extra_dict.get("deleted"):
log.debug("extra_dict deleted: "+str(extra_dict["key"]).encode('utf-8'))
#print 'extra_dict deleted: '+extra_dict["key"]
continue
#if extra_dict['value'] is not None and not extra_dict["value"] == "":
if extra_dict['value'] is not None:
new_extras.setdefault(extra_dict["key"], []).append(extra_dict["value"])
#ADDED BY FRANCESCO MANGIACRAPA
log.debug("new_extras: "+str(str(new_extras)).encode('utf-8'))
#print "new_extras: "+str(new_extras)
#new
for key in set(new_extras.keys()) - set(old_extras.keys()):
state = 'active'
log.debug("adding key: "+str(key).encode('utf-8'))
#print "adding key: "+str(key)
extra_lst = new_extras[key]
for extra in extra_lst:
extra = model.PackageExtra(state=state, key=key, value=extra)
session.add(extra)
extras_list.append(extra)
#deleted
for key in set(old_extras.keys()) - set(new_extras.keys()):
log.debug("deleting key: "+str(key).encode('utf-8'))
#print "deleting key: "+str(key)
extra_lst = extras[key]
for extra in extra_lst:
state = 'deleted'
extra.state = state
extras_list.remove(extra)
#changed
for key in set(new_extras.keys()) & set(old_extras.keys()):
#for each value of new list
for value in new_extras[key]:
old_occur = old_extras[key].count(value)
new_occur = new_extras[key].count(value)
log.debug("value: "+str(value).encode('utf-8') + ", new_occur: "+str(new_occur).encode('utf-8')+ ", old_occur: "+str(old_occur).encode('utf-8'))
#print "value: "+str(value) + ", new_occur: "+str(new_occur) + ", old_occur: "+str(old_occur)
# it is an old value deleted or not
if value in old_extras[key]:
if old_occur == new_occur:
#print "extra - occurrences of: "+str(value) +", are equal into both list"
log.debug("extra - occurrences of: "+str(value).encode('utf-8') +", are equal into both list")
#there is a little bug, this code return always the first element, so I'm fixing with #FIX-STATUS
extra_values = get_package_for_value(extras[key], value)
#extras_list.append(extra)
for extra in extra_values:
state = 'active'
extra.state = state
session.add(extra)
#print "extra updated: "+str(extra)
log.debug("extra updated: "+str(extra).encode('utf-8'))
elif new_occur > old_occur:
#print "extra - a new occurrence of: "+str(value) +", is present into new list, adding it to old list"
log.debug("extra - a new occurrence of: "+str(value).encode('utf-8') +", is present into new list, adding it to old list")
state = 'active'
extra = model.PackageExtra(state=state, key=key, value=value)
extra.state = state
session.add(extra)
extras_list.append(extra)
old_extras[key].append(value)
log.debug("old extra values updated: "+str(old_extras[key]).encode('utf-8'))
#print "old extra values updated: "+str(old_extras[key])
else:
#remove all occurrences deleted - this code could be optimized, it is run several times but could be performed one shot
countDelete = old_occur-new_occur
log.debug("extra - occurrence of: "+str(value).encode('utf-8')+", is not present into new list, removing "+str(countDelete).encode('utf-8')+" occurrence/s from old list")
#print "extra - occurrence of: "+str(value) +", is not present into new list, removing "+str(countDelete)+" occurrence/s from old list"
extra_values = get_package_for_value(extras[key], value)
for idx, extra in enumerate(extra_values):
if idx < countDelete:
#print "extra - occurrence of: "+str(value) +", is not present into new list, removing it from old list"
log.debug("pkg extra deleting: "+str(extra.value).encode('utf-8'))
#print "pkg extra deleting: "+str(extra.value)
state = 'deleted'
extra.state = state
else:
#print "pkg extra reactivating: "+str(extra.value)
log.debug("pkg extra reactivating: "+str(extra.value).encode('utf-8'))
state = 'active'
extra.state = state
session.add(extra)
else:
#print "extra new value: "+str(value)
log.debug("extra new value: "+str(value).encode('utf-8'))
state = 'active'
extra = model.PackageExtra(state=state, key=key, value=value)
extra.state = state
session.add(extra)
extras_list.append(extra)
#for each value of old list
for value in old_extras[key]:
#if value is not present in new list
if value not in new_extras[key]:
extra_values = get_package_for_value(extras[key], value)
for extra in extra_values:
#print "not present extra deleting: "+str(extra)
log.debug("not present extra deleting: "+str(extra).encode('utf-8'))
state = 'deleted'
extra.state = state
#ADDED BY FRANCESCO MANGIACRAPA
def get_package_for_value(list_package, value):
''' Returns a list of packages containing the value passed in input
'''
lst = []
for x in list_package:
if x.value == value:
lst.append(x)
else:
return lst
return lst
#OVERRIDING BASE SQL ALCHEMY ENGINE INSTANCE
def _init_TrackingMiddleware(self, app, config):
self.app = app
log.debug('TrackingMiddleware d4Science instance')
sqlalchemy_url = config.get('sqlalchemy.url')
log.debug('sqlalchemy_url read: '+str(sqlalchemy_url))
sqlalchemy_pool = config.get('sqlalchemy.pool_size')
if sqlalchemy_pool is None:
sqlalchemy_pool = 5
log.debug('sqlalchemy_pool read: '+str(sqlalchemy_pool))
sqlalchemy_overflow = config.get('sqlalchemy.max_overflow')
if sqlalchemy_overflow is None:
sqlalchemy_overflow = 10;
log.debug('sqlalchemy_overflow read: '+str(sqlalchemy_overflow))
try:
self.engine = sa.create_engine(sqlalchemy_url, pool_size=int(sqlalchemy_pool), max_overflow=int(sqlalchemy_overflow))
except TypeError as e:
log.error('pool size does not work: ' +str(e.args))
self.engine = sa.create_engine(sqlalchemy_url)
class D4Science_ThemePlugin(plugins.SingletonPlugin, toolkit.DefaultDatasetForm):
plugins.implements(plugins.IConfigurer)
plugins.implements(plugins.IDatasetForm)
plugins.implements(plugins.ITemplateHelpers)
plugins.implements(plugins.IFacets)
plugins.implements(IRoutes, inherit=True)
# IConfigurer
def update_config(self, config_):
# Add this plugin's templates dir to CKAN's extra_template_paths, so
# that CKAN will use this plugin's custom templates.
toolkit.add_template_directory(config_, 'templates')
# Add this plugin's public dir to CKAN's extra_public_paths, so
# that CKAN will use this plugin's custom static files.
toolkit.add_public_directory(config_, 'public')
# Register this plugin's fanstatic directory with CKAN.
# Here, 'fanstatic' is the path to the fanstatic directory
# (relative to this plugin.py file), and 'example_theme' is the name
# that we'll use to refer to this fanstatic directory from CKAN
# templates.
toolkit.add_resource('fanstatic', 'd4science_theme')
#IDatasetForm
def create_package_schema(self):
# let's grab the default schema in our plugin
schema = super(D4Science_ThemePlugin, self).create_package_schema()
schema = remove_check_replicated_custom_key(schema)
#d.package_dict_save = _package_dict_save
return schema
#IDatasetForm
def update_package_schema(self):
schema = super(D4Science_ThemePlugin, self).update_package_schema()
schema = remove_check_replicated_custom_key(schema)
return schema
#IDatasetForm
def show_package_schema(self):
schema = super(D4Science_ThemePlugin, self).show_package_schema()
schema = remove_check_replicated_custom_key(schema)
return schema
#IDatasetForm
def is_fallback(self):
# Return True to register this plugin as the default handler for package types not handled by any other IDatasetForm plugin
return False
#IDatasetForm
def package_types(self):
# This plugin doesn't handle any special package types, it just
# registers itself as the default (above).
return []
#ITemplateHelpers
def get_helpers(self):
log.info("get_helpers called...")
'''Register functions as a template
helper function.
'''
# Template helper function names should begin with the name of the
# extension they belong to, to avoid clashing with functions from
# other extensions.
return {
'd4science_theme_get_user_role_for_group_or_org': helpers.get_user_role_for_group_or_org,
'd4science_theme_get_parents_for_group': helpers.get_parents_for_group,
'get_header_param': helpers.get_header_param,
'get_request_param': helpers.get_request_param,
'get_cookie_value': helpers.get_cookie_value,
'd4science_theme_markdown_extract_html' : helpers.markdown_extract_html,
'd4science_theme_get_systemtype_value_from_extras' : helpers.get_systemtype_value_from_extras,
'd4science_theme_get_systemtype_field_dict_from_session' : helpers.get_systemtype_field_dict_from_session,
'd4science_theme_get_namespace_separator_from_session' : helpers.get_namespace_separator_from_session,
'd4science_theme_get_extras' : helpers.get_extras,
'd4science_theme_count_facet_items_dict' : helpers.count_facet_items_dict,
'd4science_theme_purge_namespace_to_facet': helpers.purge_namespace_to_fieldname,
'd4science_get_color_for_type': helpers.get_color_for_type,
'd4science_get_d4s_namespace_controller': helpers.get_d4s_namespace_controller,
'd4science_get_extras_indexed_for_namespaces': helpers.get_extras_indexed_for_namespaces,
'd4science_get_namespaces_dict': helpers.get_namespaces_dict,
'd4science_get_extra_for_category' : helpers.get_extra_for_category,
'd4science_get_ordered_dictionary': helpers.ordered_dictionary,
'd4science_get_qrcode_for_url': helpers.qrcode_for_url,
'd4science_get_list_of_organizations': helpers.get_list_of_organizations,
'd4science_get_image_display_for_group': helpers.get_image_display_for_group,
'd4science_get_list_of_groups': helpers.get_list_of_groups,
'd4science_get_browse_info_for_organisations_or_groups': helpers.get_browse_info_for_organisations_or_groups,
'd4science_get_user_info': helpers.get_user_info,
'd4science_get_url_to_icon_for_ckan_entity' : helpers.get_url_to_icon_for_ckan_entity,
'd4science_get_ckan_translate_for' : helpers.get_ckan_translate_for,
'd4science_get_location_to_bboxes' : helpers.get_location_to_bboxes,
'd4science_get_content_moderator_system_placeholder': helpers.get_content_moderator_system_placeholder,
}
#Overriding package_extras_save method
model_save.package_extras_save = _package_extras_save
#Overriding index home controller
d4sHC = d4SHomeController()
HomeController.index = d4sHC.index
#OVERRIDING BASE SQL ALCHEMY ENGINE INSTANCE
TrackingMiddleware.__init__ = _init_TrackingMiddleware
global d4s_ctg_namespaces_controller
#if d4s_ctg_namespaces_controller is None:
# log.info("d4s_ctg_namespaces_controller instancing...")
# d4s_ctg_namespaces_controller = helpers.get_d4s_namespace_controller()
# log.info("d4s_ctg_namespaces_controller instancied %s" % d4s_ctg_namespaces_controller)
#IFacets
def dataset_facets(self, facets_dict, package_type):
facets_dict = self._update_facets(facets_dict)
return facets_dict
def group_facets(self, facets_dict, group_type, package_type):
facets_dict = self._update_facets(facets_dict)
return facets_dict
def organization_facets(self, facets_dict, organization_type, package_type):
facets_dict = self._update_facets(facets_dict)
return facets_dict
def _update_facets(self, facets_dict):
'''Add 'metadatatype' to facets if not already present.'''
log.debug("facets_dict: ")
log.debug(', '.join(facets_dict))
metadatatype = helpers.get_systemtype_field_dict_from_session()
'''Adding system:type'''
facet_title = helpers.purge_namespace_to_fieldname(str(metadatatype['id']))
facet_title = plugins.toolkit._(facet_title.capitalize() + 's')
facets_dict = self._add_or_update_facet(metadatatype['name'],facet_title, facets_dict)
log.info("site_url is: "+g.site_url)
#ADD IT IN THE CUSTOMIZATION?
if g.site_url:
dev_sites = ['https://ckan-d-d4s.d4science.org']
grsf_sites = ['https://ckan-grsf-admin2.d4science.org', 'https://ckan-grsf.pre.d4science.org']
sbd_sites = ['https://ckan.sobigdata.d4science.net', 'https://ckan-sobigdata.d4science.org',
'https://ckan-sobigdata2.d4science.org']
if g.site_url in dev_sites:
'''Adding Status of the GRSF record'''
facets_dict = self._add_or_update_facet("StatusoftheRecord", "Status of the Record", facets_dict,
display_after_facet='groups')
elif g.site_url in grsf_sites:
'''Adding Status of the GRSF record'''
# facets_dict = self._add_or_update_facet("StatusoftheGRSFrecord", "Status of the GRSF record", facets_dict, display_after_facet='groups')
# Fixing #23348
facets_dict = self._add_or_update_facet("StatusoftheRecord", "Status of the Record", facets_dict,
display_after_facet='groups')
elif g.site_url in sbd_sites:
'''Adding the field Availability '''
facets_dict = self._add_or_update_facet("Availability", "Availability", facets_dict,
display_after_facet='groups')
return facets_dict
def before_map(self, map):
"""This IRoutes implementation overrides the standard
``/user/register`` behaviour with a custom controller. You
might instead use it to provide a completely new page, for
example.
Note that we have also provided a custom register form
template at ``theme/templates/user/register.html``.
"""
# Hook in our custom user controller at the points of creation
# and edition.
#
#map.connect('/type', controller='ckanext.d4science_theme.controllers.type::d4STypeController', action='index')
map.connect('/type', controller='ckanext.d4science_theme.controllers.systemtype:d4STypeController', action='index')
''' Added by Francesco Mangiacrapa, see: #8964 '''
organization_vre = OrganizationVREController()
map.connect('/organization_vre', controller='ckanext.d4science_theme.controllers.organization:OrganizationVREController', action='index')
map.connect('/organization_vre/{id}', controller='ckanext.d4science_theme.controllers.organization:OrganizationVREController', action='read')
map.redirect('/types', "/type")
return map
def _add_or_update_facet(self, facet_key, facet_value, facets_dict, display_after_facet='organization'):
#Updating ordering of facets_dict OrderedDict
if str(facet_key) not in facets_dict:
new_orderded_facets_dict=facets_dict.__class__()
for key, value in list(facets_dict.items()):
new_orderded_facets_dict[key]=value
# #the field 'metadatatype' will be inserted after following key
if key==display_after_facet:
new_orderded_facets_dict[facet_key]=facet_value
facets_dict.clear()
facets_dict.update(new_orderded_facets_dict)
log.debug("facets_dict ordered: ")
log.debug(', '.join(facets_dict))
return facets_dict

0
src/ckanext-d4science_theme/ckanext/d4science_theme/public/.gitignore vendored Normal file
View File

BIN
src/ckanext-d4science_theme/ckanext/d4science_theme/public/D4ScienceDataCataloguelogo.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.2 KiB

BIN
src/ckanext-d4science_theme/ckanext/d4science_theme/public/D4ScienceDataCataloguelogo2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 113 KiB

BIN
src/ckanext-d4science_theme/ckanext/d4science_theme/public/bg-noise.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.8 KiB

Some files were not shown because too many files have changed in this diff Show More