├── requirements.txt ├── ckanext ├── announcements │ ├── i18n │ │ └── .gitignore │ ├── public │ │ └── .gitignore │ ├── tests │ │ ├── __init__.py │ │ ├── fixtures.py │ │ ├── test_ui.py │ │ ├── factories.py │ │ └── test_plugin.py │ ├── __init__.py │ ├── templates │ │ ├── header.html │ │ ├── admin │ │ │ ├── base.html │ │ │ ├── snippets │ │ │ │ ├── delete-announcement.html │ │ │ │ ├── new-announcement.html │ │ │ │ └── edit-announcement.html │ │ │ └── announcements.html │ │ ├── base.html │ │ └── announcements │ │ │ └── announcement.html │ ├── assets │ │ ├── webassets.yml │ │ ├── css │ │ │ └── announcements.css │ │ └── js │ │ │ └── announcements.js │ ├── validators.py │ ├── utils.py │ ├── auth.py │ ├── models.py │ ├── migration │ │ └── announcements │ │ │ ├── versions │ │ │ └── 001_95aed1f25344_add_message_models.py │ │ │ ├── alembic.ini │ │ │ └── env.py │ ├── helpers.py │ ├── plugin.py │ ├── actions.py │ └── blueprints.py └── __init__.py ├── dev-requirements.txt ├── .flake8 ├── .coveragerc ├── docs └── imgs │ └── screen.png ├── conftest.py ├── .pre-commit-config.yaml ├── MANIFEST.in ├── setup.cfg ├── .gitignore ├── test.ini ├── CHANGELOG.md ├── .github └── workflows │ ├── test-ckan-2.10.yml │ └── test-ckan-2.11.yml ├── README.md ├── setup.py └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- 1 | ckantoolkit 2 | -------------------------------------------------------------------------------- /ckanext/announcements/i18n/.gitignore: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /dev-requirements.txt: -------------------------------------------------------------------------------- 1 | pytest-ckan 2 | -------------------------------------------------------------------------------- /ckanext/announcements/public/.gitignore: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /ckanext/announcements/tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /ckanext/announcements/__init__.py: -------------------------------------------------------------------------------- 1 | __VERSION__ = "0.1.6" 2 | -------------------------------------------------------------------------------- /.flake8: -------------------------------------------------------------------------------- 1 | [flake8] 2 | max-line-length = 88 3 | max-complexity = 15 4 | -------------------------------------------------------------------------------- /.coveragerc: -------------------------------------------------------------------------------- 1 | [report] 2 | omit = 3 | */site-packages/* 4 | */python?.?/* 5 | ckan/* 6 | -------------------------------------------------------------------------------- /docs/imgs/screen.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/okfn/ckanext-announcements/main/docs/imgs/screen.png -------------------------------------------------------------------------------- /conftest.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | pytest_plugins = [ 4 | "ckanext.announcements.tests.fixtures", 5 | ] 6 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: https://github.com/PyCQA/flake8 3 | rev: 7.0.0 4 | hooks: 5 | - id: flake8 6 | files: ckanext 7 | args: [--max-line-length=130] 8 | -------------------------------------------------------------------------------- /ckanext/announcements/templates/header.html: -------------------------------------------------------------------------------- 1 | {% ckan_extends %} 2 | 3 | {% block header_account %} 4 | 5 | {{ super() }} 6 | {% snippet 'announcements/announcement.html' %} 7 | 8 | {% endblock %} 9 | -------------------------------------------------------------------------------- /ckanext/announcements/templates/admin/base.html: -------------------------------------------------------------------------------- 1 | {% ckan_extends %} 2 | 3 | {% block content_primary_nav %} 4 | {{ super() }} 5 | {{ h.build_nav_icon('announcements.index', _('Announcements'), icon='bell') }} 6 | {% endblock %} 7 | -------------------------------------------------------------------------------- /ckanext/announcements/templates/base.html: -------------------------------------------------------------------------------- 1 | {% ckan_extends %} 2 | 3 | {% block styles %} 4 | {{ super() }} 5 | {% asset "announcements/announcements-css" %} 6 | {% asset "announcements/announcements-js" %} 7 | {% endblock %} 8 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.rst 2 | include README.md 3 | include LICENSE 4 | include requirements.txt 5 | recursive-include ckanext/announcements *.html *.json *.js *.less *.css *.mo *.yml 6 | recursive-include ckanext/announcements/migration *.ini *.py *.mako 7 | -------------------------------------------------------------------------------- /ckanext/__init__.py: -------------------------------------------------------------------------------- 1 | # this is a namespace package 2 | try: 3 | import pkg_resources 4 | 5 | pkg_resources.declare_namespace(__name__) 6 | except ImportError: 7 | import pkgutil 8 | 9 | __path__ = pkgutil.extend_path(__path__, __name__) 10 | -------------------------------------------------------------------------------- /ckanext/announcements/assets/webassets.yml: -------------------------------------------------------------------------------- 1 | announcements-css: 2 | filter: cssrewrite 3 | output: ckanext-announcements/%(version)s-announcements.css 4 | contents: 5 | - css/announcements.css 6 | 7 | announcements-js: 8 | filter: rjsmin 9 | output: ckanext-announcements/%(version)s-announcements.js 10 | contents: 11 | - js/announcements.js 12 | extra: 13 | preload: 14 | - base/main 15 | -------------------------------------------------------------------------------- /ckanext/announcements/validators.py: -------------------------------------------------------------------------------- 1 | from ckan.plugins import toolkit 2 | 3 | 4 | def validate_announcement(data_dict): 5 | errors = {} 6 | if not data_dict.get("from_date"): 7 | errors["from_date"] = ["'From date' is required"] 8 | if not data_dict.get("to_date"): 9 | errors["to_date"] = ["'To date' is required"] 10 | if not data_dict.get("message"): 11 | errors["message"] = ["A 'Message' is required"] 12 | if errors: 13 | raise toolkit.ValidationError(errors) 14 | -------------------------------------------------------------------------------- /ckanext/announcements/templates/announcements/announcement.html: -------------------------------------------------------------------------------- 1 |
2 | {% for announcement in h.get_public_announcements() %} 3 | 10 | {% endfor %} 11 |
12 | -------------------------------------------------------------------------------- /ckanext/announcements/utils.py: -------------------------------------------------------------------------------- 1 | from functools import wraps 2 | from ckan.plugins import toolkit 3 | 4 | 5 | def require_sysadmin_user(func): 6 | ''' 7 | Decorator for flask view functions. Returns 403 response if no user is logged in or if the login user is external 8 | ''' 9 | 10 | @wraps(func) 11 | def view_wrapper(*args, **kwargs): 12 | if not hasattr(toolkit.c, "user") or not toolkit.c.user: 13 | return toolkit.abort(403, "Forbidden") 14 | if not toolkit.c.userobj.sysadmin: 15 | return toolkit.abort(403, "Sysadmin user required") 16 | return func(*args, **kwargs) 17 | 18 | return view_wrapper 19 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [extract_messages] 2 | keywords = translate isPlural 3 | add_comments = TRANSLATORS: 4 | output_file = ckanext/announcements/i18n/ckanext-announcements.pot 5 | width = 80 6 | 7 | [init_catalog] 8 | domain = ckanext-announcements 9 | input_file = ckanext/announcements/i18n/ckanext-announcements.pot 10 | output_dir = ckanext/announcements/i18n 11 | 12 | [update_catalog] 13 | domain = ckanext-announcements 14 | input_file = ckanext/announcements/i18n/ckanext-announcements.pot 15 | output_dir = ckanext/announcements/i18n 16 | previous = true 17 | 18 | [compile_catalog] 19 | domain = ckanext-announcements 20 | directory = ckanext/announcements/i18n 21 | statistics = true 22 | -------------------------------------------------------------------------------- /ckanext/announcements/auth.py: -------------------------------------------------------------------------------- 1 | """ 2 | Announcement auth functions 3 | """ 4 | 5 | 6 | def announcement_create(context, data_dict): 7 | """Only sysadmins are allowed""" 8 | user_obj = context.get("auth_user_obj") 9 | return {"success": user_obj.sysadmin} 10 | 11 | 12 | def announcement_update(context, data_dict): 13 | """Only sysadmins are allowed""" 14 | user_obj = context.get("auth_user_obj") 15 | return {"success": user_obj.sysadmin} 16 | 17 | 18 | def announcement_delete(context, data_dict): 19 | """Only sysadmins are allowed""" 20 | user_obj = context.get("auth_user_obj") 21 | return {"success": user_obj.sysadmin} 22 | 23 | 24 | def announcement_show(context, data_dict): 25 | return {"success": True} 26 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .ropeproject 2 | node_modules 3 | bower_components 4 | 5 | # Byte-compiled / optimized / DLL files 6 | __pycache__/ 7 | *.py[cod] 8 | 9 | # C extensions 10 | *.so 11 | 12 | # Distribution / packaging 13 | .Python 14 | env/ 15 | build/ 16 | develop-eggs/ 17 | dist/ 18 | sdist/ 19 | *.egg-info/ 20 | .installed.cfg 21 | *.egg 22 | 23 | # PyInstaller 24 | # Usually these files are written by a python script from a template 25 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 26 | *.manifest 27 | *.spec 28 | 29 | # Installer logs 30 | pip-log.txt 31 | pip-delete-this-directory.txt 32 | 33 | # Unit test / coverage reports 34 | htmlcov/ 35 | .tox/ 36 | .coverage 37 | .cache 38 | nosetests.xml 39 | coverage.xml 40 | 41 | # Sphinx documentation 42 | docs/_build/ 43 | 44 | .vscode 45 | -------------------------------------------------------------------------------- /ckanext/announcements/assets/css/announcements.css: -------------------------------------------------------------------------------- 1 | /* 2 | Public 3 | */ 4 | 5 | .announcements-container { 6 | padding-top: 10px; 7 | } 8 | 9 | .announcement { 10 | display: none; /* All is hide until is not hide */ 11 | padding-bottom: 20px; 12 | margin-bottom: 10px; 13 | } 14 | 15 | /* 16 | Private 17 | */ 18 | #new-announcement { 19 | text-align: right; 20 | margin-bottom: 7px; 21 | } 22 | 23 | .announcement-edit-btn, .announcement-delete-btn { 24 | margin: 3px; 25 | } 26 | 27 | .announcement-msg-column { 28 | width: 50%; 29 | } 30 | 31 | .announcement-form-error { 32 | color: rgb(115, 8, 8); 33 | width: 100%; 34 | background-color: #ff000022; 35 | font-weight: bold; 36 | display: none; 37 | padding: 7px; 38 | margin: 7px; 39 | } 40 | 41 | /* We don't expect to need this */ 42 | .modal-backdrop { 43 | z-index: 0 !important; 44 | background-color: #00000000; 45 | } 46 | -------------------------------------------------------------------------------- /ckanext/announcements/tests/fixtures.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | 3 | from ckan.plugins import toolkit 4 | 5 | 6 | @pytest.fixture 7 | def clean_db(reset_db, migrate_db_for): 8 | reset_db() 9 | if toolkit.check_ckan_version(min_version='2.11'): 10 | migrate_db_for("announcements") 11 | else: 12 | migrate_old() 13 | 14 | 15 | def migrate_old(): 16 | import contextlib 17 | from ckan.cli.db import _resolve_alembic_config 18 | import ckan.model as model 19 | 20 | @contextlib.contextmanager 21 | def _repo_for_plugin(plugin): 22 | original = model.repo._alembic_ini 23 | model.repo._alembic_ini = _resolve_alembic_config(plugin) 24 | try: 25 | yield model.repo 26 | finally: 27 | model.repo._alembic_ini = original 28 | 29 | def _apply_alembic_migrations(): 30 | with _repo_for_plugin("announcements") as repo: 31 | repo.upgrade_db("head") 32 | 33 | _apply_alembic_migrations() 34 | -------------------------------------------------------------------------------- /ckanext/announcements/tests/test_ui.py: -------------------------------------------------------------------------------- 1 | from types import SimpleNamespace 2 | import pytest 3 | from ckanext.announcements.tests import factories 4 | 5 | 6 | @pytest.fixture 7 | def an_data(): 8 | """test setup data""" 9 | obj = SimpleNamespace() 10 | # Create CKAN users 11 | obj.regular_user = factories.UserMulti() 12 | obj.sysadmin = factories.SysadminUserMulti() 13 | 14 | return obj 15 | 16 | 17 | @pytest.mark.usefixtures("with_plugins", "clean_db") 18 | class TestAnnouncementsUI: 19 | def test_regular_user(self, app, an_data): 20 | environ = {"Authorization": an_data.regular_user["token"]} 21 | 22 | resp = app.get("/ckan-admin/announcements", headers=environ) 23 | assert resp.status_code == 403 24 | 25 | def test_sysadmin_user(self, app, an_data): 26 | environ = {"Authorization": an_data.sysadmin["token"]} 27 | 28 | resp = app.get("/ckan-admin/announcements", headers=environ) 29 | assert resp.status_code == 200 30 | -------------------------------------------------------------------------------- /test.ini: -------------------------------------------------------------------------------- 1 | [DEFAULT] 2 | debug = false 3 | smtp_server = localhost 4 | error_email_from = ckan@localhost 5 | 6 | [app:main] 7 | use = config:/srv/app/src/ckan/test-core.ini 8 | 9 | # Insert any custom config settings to be used when running your extension's 10 | # tests here. These will override the one defined in CKAN core's test-core.ini 11 | ckan.plugins = announcements 12 | ckan.site_id = default_test 13 | ckan.sqlalchemy.url = postgres://ckan:ckan@postgresql/ckan_test 14 | ckan.datastore.write_url = postgresql://ckan:ckan@postgresql/datastore_test 15 | ckan.datastore.read_url = postgresql://datastore_ro:datastore@postgresql/datastore_test 16 | ckan.display_timezone = UTC 17 | 18 | # Logging configuration 19 | [loggers] 20 | keys = root, ckan, sqlalchemy 21 | 22 | [handlers] 23 | keys = console 24 | 25 | [formatters] 26 | keys = generic 27 | 28 | [logger_root] 29 | level = WARN 30 | handlers = console 31 | 32 | [logger_ckan] 33 | qualname = ckan 34 | handlers = 35 | level = INFO 36 | 37 | [logger_sqlalchemy] 38 | handlers = 39 | qualname = sqlalchemy.engine 40 | level = WARN 41 | 42 | [handler_console] 43 | class = StreamHandler 44 | args = (sys.stderr,) 45 | level = NOTSET 46 | formatter = generic 47 | 48 | [formatter_generic] 49 | format = %(asctime)s %(levelname)-5.5s [%(name)s] %(message)s 50 | -------------------------------------------------------------------------------- /ckanext/announcements/templates/admin/snippets/delete-announcement.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /ckanext/announcements/models.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | import logging 3 | 4 | from sqlalchemy import Column, DateTime 5 | from sqlalchemy.dialects.postgresql import JSONB 6 | from sqlalchemy.ext.declarative import declarative_base 7 | from sqlalchemy.ext.mutable import MutableDict 8 | from sqlalchemy.types import Enum, UnicodeText 9 | 10 | from ckan.model.meta import metadata 11 | from ckan.model.types import make_uuid 12 | 13 | 14 | log = logging.getLogger(__name__) 15 | Base = declarative_base(metadata=metadata) 16 | 17 | 18 | class Announcement(Base): 19 | __tablename__ = "announcements" 20 | 21 | id = Column(UnicodeText, primary_key=True, default=make_uuid) 22 | timestamp = Column(DateTime, default=datetime.datetime.utcnow, nullable=False) 23 | user_creator_id = Column(UnicodeText, nullable=False) 24 | 25 | from_date = Column(DateTime, default=datetime.datetime.utcnow, nullable=False) 26 | to_date = Column(DateTime, default=datetime.datetime.utcnow, nullable=False) 27 | message = Column(UnicodeText, nullable=True) 28 | 29 | status = Column( 30 | Enum("draft", "active", "deleted", name="announcements_status_enum"), 31 | default="draft", 32 | nullable=False, 33 | ) 34 | extras = Column(MutableDict.as_mutable(JSONB), nullable=True) 35 | 36 | def dictize(self): 37 | dct = {k: v for k, v in self.__dict__.items() if not k.startswith("_")} 38 | return dct 39 | -------------------------------------------------------------------------------- /ckanext/announcements/migration/announcements/versions/001_95aed1f25344_add_message_models.py: -------------------------------------------------------------------------------- 1 | """Add Announcements Models 2 | 3 | Revision ID: 95aed1f25344 4 | Revises: None 5 | Create Date: 2022-07-06 15:31:04.000000 6 | 7 | """ 8 | from alembic import op 9 | import sqlalchemy as sa 10 | from sqlalchemy.dialects import postgresql 11 | 12 | 13 | # revision identifiers, used by Alembic. 14 | revision = "85aed1f25344" 15 | down_revision = None 16 | branch_labels = None 17 | depends_on = None 18 | 19 | 20 | def upgrade(): 21 | op.create_table( 22 | "announcements", 23 | sa.Column("id", sa.UnicodeText, primary_key=True), 24 | sa.Column("timestamp", sa.DateTime, server_default=sa.func.current_timestamp()), 25 | sa.Column("user_creator_id", sa.UnicodeText, nullable=False), 26 | sa.Column( 27 | "from_date", 28 | sa.DateTime, 29 | nullable=False, 30 | server_default=sa.func.current_timestamp(), 31 | ), 32 | sa.Column( 33 | "to_date", 34 | sa.DateTime, 35 | nullable=False, 36 | server_default=sa.func.current_timestamp(), 37 | ), 38 | sa.Column("message", sa.UnicodeText, nullable=True), 39 | sa.Column( 40 | "status", 41 | sa.Enum("draft", "active", "deleted", name="announcements_status_enum"), 42 | nullable=False, 43 | ), 44 | sa.Column("extras", postgresql.JSONB(astext_type=sa.Text()), nullable=True), 45 | ) 46 | 47 | 48 | def downgrade(): 49 | op.drop_table("announcements") 50 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## 0.1.6 - 2025-05-09 4 | 5 | New features: 6 | - Drop old bootstrap classes [#11](https://github.com/okfn/ckanext-announcements/pull/11) 7 | - Drop CKAN 2.9 compatibility [#11](https://github.com/okfn/ckanext-announcements/pull/11) 8 | 9 | ## 0.1.5 - 2025-01-03 10 | 11 | New features: 12 | 13 | Bug fixes: 14 | - Fix template after change in CKAN 2.11 [#10](https://github.com/okfn/ckanext-announcements/pull/10) 15 | 16 | ## 0.1.4 - 2025-01-03 17 | 18 | New features: 19 | - CKAN 2.11 compatibility added. 20 | 21 | Bug fixes: 22 | 23 | ## 0.1.3 - 2024-04-26 24 | 25 | New features: 26 | 27 | Bug fixes: 28 | - Fix anon visits [#8](https://github.com/okfn/ckanext-announcements/pull/8) 29 | 30 | ## 0.1.2 - 2024-04-26 31 | 32 | New features: 33 | - Hide announcements if users closes them [#7](https://github.com/okfn/ckanext-announcements/pull/7) 34 | Bug fixes: 35 | - Do not send the SQLAlchemy objects to template [#7](https://github.com/okfn/ckanext-announcements/pull/7) 36 | 37 | ## 0.1.1 - 2024-04-23 38 | 39 | New features: 40 | - Allow to define timezones for announcements [#6](https://github.com/okfn/ckanext-announcements/pull/6) 41 | - Update test images for CKAN 2.9 42 | 43 | ## 0.1.0 - 2023-08-08 44 | New features: 45 | - CKAN 2.10 compatibility added. 46 | 47 | ## 0.0.4 - 2022-08-02 48 | New features: 49 | - Validate announcement forms 50 | - Improve style for announcement forms 51 | - Add flake8 and black checks for GiyHub acvtions and internally, as pre-commit hooks 52 | - Allow markdown for announcements 53 | 54 | ## 0.0.2 - 2022-07-20 55 | First version released 56 | -------------------------------------------------------------------------------- /ckanext/announcements/tests/factories.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | import factory 3 | from ckan import model 4 | from ckantoolkit import check_ckan_version 5 | from ckantoolkit.tests import factories, helpers 6 | from ckanext.announcements.models import Announcement 7 | 8 | 9 | class UserMulti(factories.User): 10 | """Multi version CKAN user""" 11 | 12 | @factory.post_generation 13 | def token(obj, create, extracted, **kwargs): 14 | if not create: 15 | return 16 | if check_ckan_version(min_version="2.10"): 17 | api_token = factories.APIToken( 18 | user=obj["id"], 19 | expires_in=30, 20 | unit=4, 21 | ) 22 | obj["token"] = api_token["token"] 23 | else: 24 | obj["token"] = obj["apikey"] 25 | 26 | 27 | class SysadminUserMulti(UserMulti): 28 | sysadmin = True 29 | 30 | 31 | class Announcement(factory.Factory): 32 | class Meta: 33 | model = Announcement 34 | 35 | _user = helpers.call_action("get_site_user") 36 | user_creator_id = _user["name"] 37 | from_date = datetime.datetime.now() + datetime.timedelta(days=3) 38 | to_date = datetime.datetime.now() + datetime.timedelta(days=7) 39 | message = "This is an announcement message" 40 | status = "active" 41 | 42 | @classmethod 43 | def _create(cls, target_class, *args, **kwargs): 44 | if args: 45 | assert False, "Positional args aren't supported, use keyword args." 46 | 47 | gm = target_class(**kwargs) 48 | model.Session.add(gm) 49 | model.Session.commit() 50 | model.Session.remove() 51 | return gm 52 | -------------------------------------------------------------------------------- /ckanext/announcements/tests/test_plugin.py: -------------------------------------------------------------------------------- 1 | from datetime import datetime, timedelta 2 | from types import SimpleNamespace 3 | import pytest 4 | 5 | from ckanext.announcements.helpers import ( 6 | get_all_announcements, 7 | get_public_announcements, 8 | ) 9 | from ckanext.announcements.tests import factories 10 | 11 | 12 | @pytest.fixture 13 | def an_data(): 14 | """test setup data""" 15 | obj = SimpleNamespace() 16 | obj.old_announcement = factories.Announcement( 17 | message="This is an old message", 18 | from_date=datetime.now() - timedelta(days=7), 19 | to_date=datetime.now() - timedelta(days=6), 20 | ) 21 | obj.active_announcement = factories.Announcement( 22 | message="This should be a public message", 23 | from_date=datetime.now() - timedelta(days=1), 24 | to_date=datetime.now() + timedelta(days=1), 25 | ) 26 | return obj 27 | 28 | 29 | @pytest.mark.usefixtures("with_plugins", "clean_db") 30 | class TestAnnouncements: 31 | def test_announcement_saved(self, an_data): 32 | """Test single announcement saved correctly""" 33 | assert an_data.old_announcement.message == "This is an old message" 34 | assert an_data.old_announcement.status == "active" 35 | 36 | def test_get_all_announcements_helper(self, an_data): 37 | """Test all messages helper""" 38 | ga = get_all_announcements() 39 | assert len(ga) == 2 40 | 41 | def test_get_public_announcements_helper(self, an_data): 42 | """Test public messages helper""" 43 | ga = get_public_announcements() 44 | assert len(ga) == 1 45 | assert ga[0]['message'] == "This should be a public message" 46 | -------------------------------------------------------------------------------- /ckanext/announcements/helpers.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | import logging 3 | from pytz import timezone 4 | from ckan import model 5 | from ckan.plugins import toolkit 6 | from ckanext.announcements.models import Announcement 7 | 8 | 9 | log = logging.getLogger(__name__) 10 | 11 | 12 | def get_public_announcements(): 13 | """Get a list of Announcements""" 14 | # display messages up to 3 days after they disappeared. 15 | now = datetime.datetime.now() 16 | messages = ( 17 | model.Session.query(Announcement) 18 | .filter_by(status="active") 19 | .filter(Announcement.to_date > now, Announcement.from_date < now) 20 | .limit(10) 21 | .all() 22 | ) 23 | messages = dictize_announ(messages) 24 | return messages 25 | 26 | 27 | def get_all_announcements(): 28 | """Get a list of Announcements""" 29 | # TODO this should be paginated 30 | limit = toolkit.config.get("ckanext.announcements.limit_announcements", 50) 31 | messages = ( 32 | model.Session.query(Announcement) 33 | .order_by(Announcement.timestamp.desc()) 34 | .limit(limit) 35 | .all() 36 | ) 37 | messages = dictize_announ(messages) 38 | return messages 39 | 40 | 41 | def dictize_announ(messages): 42 | """Dictize and improve. Apply the proper timezone to messages""" 43 | display_timezone = toolkit.config.get("ckan.display_timezone", "UTC") 44 | tz = timezone(display_timezone) 45 | # Do not send the SQLAlchemy objects to template, use dictionaries instead 46 | dict_messages = [] 47 | for message in messages: 48 | message.from_date = message.from_date.astimezone(tz) 49 | message.to_date = message.to_date.astimezone(tz) 50 | dict_messages.append(message.dictize()) 51 | return dict_messages 52 | -------------------------------------------------------------------------------- /ckanext/announcements/plugin.py: -------------------------------------------------------------------------------- 1 | from ckanext.announcements import actions, auth, blueprints, helpers 2 | import ckan.plugins as plugins 3 | import ckan.plugins.toolkit as toolkit 4 | 5 | 6 | class announcementsPlugin(plugins.SingletonPlugin): 7 | plugins.implements(plugins.IConfigurer) 8 | plugins.implements(plugins.ITemplateHelpers) 9 | plugins.implements(plugins.IBlueprint) 10 | plugins.implements(plugins.IAuthFunctions) 11 | plugins.implements(plugins.IActions) 12 | 13 | # IConfigurer 14 | 15 | def update_config(self, config_): 16 | toolkit.add_template_directory(config_, "templates") 17 | toolkit.add_public_directory(config_, "public") 18 | toolkit.add_resource("assets", "announcements") 19 | 20 | # ITemplateHelpers 21 | 22 | def get_helpers(self): 23 | return { 24 | "get_all_announcements": helpers.get_all_announcements, 25 | "get_public_announcements": helpers.get_public_announcements, 26 | } 27 | 28 | # IBlueprint 29 | 30 | def get_blueprint(self): 31 | return [ 32 | blueprints.announcements_blueprint, 33 | ] 34 | 35 | # IAuthFunctions 36 | 37 | def get_auth_functions(self): 38 | functions = { 39 | "announcement_create": auth.announcement_create, 40 | "announcement_update": auth.announcement_update, 41 | "announcement_delete": auth.announcement_delete, 42 | "announcement_show": auth.announcement_show, 43 | } 44 | return functions 45 | 46 | # IActions 47 | 48 | def get_actions(self): 49 | functions = { 50 | "announcement_create": actions.announcement_create, 51 | "announcement_update": actions.announcement_update, 52 | "announcement_delete": actions.announcement_delete, 53 | "announcement_show": actions.announcement_show, 54 | } 55 | return functions 56 | -------------------------------------------------------------------------------- /ckanext/announcements/migration/announcements/alembic.ini: -------------------------------------------------------------------------------- 1 | # A generic, single database configuration. 2 | 3 | [alembic] 4 | # path to migration scripts 5 | script_location = %(here)s 6 | 7 | # template used to generate migration files 8 | # file_template = %%(rev)s_%%(slug)s 9 | 10 | # timezone to use when rendering the date 11 | # within the migration file as well as the filename. 12 | # string value is passed to dateutil.tz.gettz() 13 | # leave blank for localtime 14 | # timezone = 15 | 16 | # max length of characters to apply to the 17 | # "slug" field 18 | #truncate_slug_length = 40 19 | 20 | # set to 'true' to run the environment during 21 | # the 'revision' command, regardless of autogenerate 22 | # revision_environment = false 23 | 24 | # set to 'true' to allow .pyc and .pyo files without 25 | # a source .py file to be detected as revisions in the 26 | # versions/ directory 27 | # sourceless = false 28 | 29 | # version location specification; this defaults 30 | # to /srv/app/src_extensions/ckanext-announcements/ckanext/announcements/migration/announcements/versions. 31 | # When using multiple version 32 | # directories, initial revisions must be specified with --version-path 33 | # version_locations = %(here)s/versions 34 | 35 | # the output encoding used when revision files 36 | # are written from script.py.mako 37 | # output_encoding = utf-8 38 | 39 | # sqlalchemy.url = postgresql://ckan:ckan@postgresql/ckan_test 40 | 41 | # Logging configuration 42 | [loggers] 43 | keys = root,sqlalchemy,alembic 44 | 45 | [handlers] 46 | keys = console 47 | 48 | [formatters] 49 | keys = generic 50 | 51 | [logger_root] 52 | level = WARN 53 | handlers = console 54 | qualname = 55 | 56 | [logger_sqlalchemy] 57 | level = WARN 58 | handlers = 59 | qualname = sqlalchemy.engine 60 | 61 | [logger_alembic] 62 | level = INFO 63 | handlers = 64 | qualname = alembic 65 | 66 | [handler_console] 67 | class = StreamHandler 68 | args = (sys.stderr,) 69 | level = NOTSET 70 | formatter = generic 71 | 72 | [formatter_generic] 73 | format = %(levelname)-5.5s [%(name)s] %(message)s 74 | datefmt = %H:%M:%S 75 | -------------------------------------------------------------------------------- /.github/workflows/test-ckan-2.10.yml: -------------------------------------------------------------------------------- 1 | name: Tests CKAN 2.10 Python 3.10 2 | on: [push] 3 | jobs: 4 | test: 5 | runs-on: ubuntu-latest 6 | container: 7 | # The CKAN version tag of the Solr and Postgres containers should match 8 | # the one of the container the tests run on. 9 | # You can switch this base image with a custom image tailored to your project 10 | image: openknowledge/ckan-dev:2.10.1 11 | services: 12 | solr: 13 | image: ckan/ckan-solr:2.10-solr8 14 | postgres: 15 | image: ckan/ckan-postgres-dev:2.10 16 | env: 17 | POSTGRES_USER: postgres 18 | POSTGRES_PASSWORD: postgres 19 | POSTGRES_DB: postgres 20 | options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5 21 | redis: 22 | image: redis:3 23 | 24 | env: 25 | CKAN_SQLALCHEMY_URL: postgresql://ckan_default:pass@postgres/ckan_test 26 | CKAN_DATASTORE_WRITE_URL: postgresql://datastore_write:pass@postgres/datastore_test 27 | CKAN_DATASTORE_READ_URL: postgresql://datastore_read:pass@postgres/datastore_test 28 | CKAN_SOLR_URL: http://solr:8983/solr/ckan 29 | CKAN_REDIS_URL: redis://redis:6379/1 30 | 31 | steps: 32 | - uses: actions/checkout@v2 33 | 34 | - name: Flake8 35 | run: | 36 | pip install flake8 37 | flake8 . \ 38 | --count \ 39 | --show-source \ 40 | --max-complexity=12 \ 41 | --max-line-length=130 \ 42 | --statistics 43 | 44 | - name: Install requirements 45 | # Install any extra requirements your extension has here (dev requirements, other extensions etc) 46 | run: | 47 | # remove when errors with "packaging" package is fixed 48 | pip install setuptools==65.3.0 49 | pip install -r requirements.txt 50 | pip install -r dev-requirements.txt 51 | python3 setup.py develop 52 | 53 | - name: Setup extension 54 | # Extra initialization steps 55 | run: | 56 | # Replace default path to CKAN core config file with the one on the container 57 | sed -i -e 's/use = config:.*/use = config:\/srv\/app\/src\/ckan\/test-core.ini/' test.ini 58 | 59 | ckan -c test.ini db init 60 | ckan -c test.ini db upgrade -p announcements 61 | 62 | - name: Run tests 63 | run: pytest --ckan-ini=test.ini --cov=ckanext.announcements --disable-warnings ckanext/announcements 64 | 65 | -------------------------------------------------------------------------------- /ckanext/announcements/actions.py: -------------------------------------------------------------------------------- 1 | from ckan import model 2 | from ckan.plugins import toolkit 3 | from ckanext.announcements.models import Announcement 4 | from ckanext.announcements.validators import validate_announcement 5 | 6 | 7 | def announcement_create(context, data_dict): 8 | toolkit.check_access("announcement_create", context, data_dict) 9 | m = context.get("model", model) 10 | validate_announcement(data_dict) 11 | 12 | from_date = data_dict.get("from_date") 13 | to_date = data_dict.get("to_date") 14 | 15 | announcement = Announcement( 16 | timestamp=data_dict["timestamp"], 17 | user_creator_id=data_dict["user_creator_id"], 18 | from_date=from_date, 19 | to_date=to_date, 20 | message=data_dict["message"], 21 | status=data_dict["status"], 22 | ) 23 | m.Session.add(announcement) 24 | m.Session.commit() 25 | m.Session.refresh(announcement) 26 | 27 | return announcement.dictize() 28 | 29 | 30 | def announcement_update(context, data_dict): 31 | toolkit.check_access("announcement_update", context, data_dict) 32 | m = context.get("model", model) 33 | 34 | validate_announcement(data_dict) 35 | 36 | announcement = m.Session.query(Announcement).get(data_dict["id"]) 37 | if not announcement: 38 | raise toolkit.ObjectNotFound("Announcement not found") 39 | 40 | announcement.from_date = data_dict["from_date"] 41 | announcement.to_date = data_dict["to_date"] 42 | announcement.message = data_dict["message"] 43 | 44 | m.Session.commit() 45 | m.Session.refresh(announcement) 46 | 47 | return announcement.dictize() 48 | 49 | 50 | def announcement_delete(context, data_dict): 51 | toolkit.check_access("announcement_delete", context, data_dict) 52 | m = context.get("model", model) 53 | 54 | announcement = m.Session.query(Announcement).get(data_dict["id"]) 55 | if not announcement: 56 | raise toolkit.ObjectNotFound("Announcement not found") 57 | 58 | m.Session.delete(announcement) 59 | m.Session.commit() 60 | 61 | return 62 | 63 | 64 | @toolkit.side_effect_free 65 | def announcement_show(context, data_dict): 66 | m = context.get("model", model) 67 | toolkit.check_access("announcement_show", context, data_dict) 68 | 69 | announcement = m.Session.query(Announcement).get(data_dict["id"]) 70 | if announcement: 71 | return announcement.dictize() 72 | 73 | raise toolkit.ObjectNotFound("Announcement not found") 74 | -------------------------------------------------------------------------------- /.github/workflows/test-ckan-2.11.yml: -------------------------------------------------------------------------------- 1 | name: Tests CKAN 2.11 Python 3.10 2 | on: [push] 3 | jobs: 4 | test: 5 | runs-on: ubuntu-latest 6 | container: 7 | # The CKAN version tag of the Solr and Postgres containers should match 8 | # the one of the container the tests run on. 9 | # You can switch this base image with a custom image tailored to your project 10 | image: ckan/ckan-dev:2.11.1 11 | options: --user root 12 | services: 13 | solr: 14 | image: ckan/ckan-solr:2.11-solr9 15 | postgres: 16 | image: ckan/ckan-postgres-dev:2.11 17 | env: 18 | POSTGRES_USER: postgres 19 | POSTGRES_PASSWORD: postgres 20 | POSTGRES_DB: postgres 21 | options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5 22 | redis: 23 | image: redis:3 24 | 25 | env: 26 | CKAN_SQLALCHEMY_URL: postgresql://ckan_default:pass@postgres/ckan_test 27 | CKAN_DATASTORE_WRITE_URL: postgresql://datastore_write:pass@postgres/datastore_test 28 | CKAN_DATASTORE_READ_URL: postgresql://datastore_read:pass@postgres/datastore_test 29 | CKAN_SOLR_URL: http://solr:8983/solr/ckan 30 | CKAN_REDIS_URL: redis://redis:6379/1 31 | 32 | steps: 33 | - uses: actions/checkout@v4 34 | 35 | - name: Flake8 36 | run: | 37 | pip install flake8 38 | flake8 . \ 39 | --count \ 40 | --show-source \ 41 | --max-complexity=12 \ 42 | --max-line-length=130 \ 43 | --statistics 44 | 45 | - name: Install requirements 46 | # Install any extra requirements your extension has here (dev requirements, other extensions etc) 47 | run: | 48 | # remove when errors with "packaging" package is fixed 49 | pip install setuptools==65.3.0 50 | pip install -r requirements.txt 51 | pip install -r dev-requirements.txt 52 | python3 setup.py develop 53 | 54 | - name: Setup extension 55 | # Extra initialization steps 56 | run: | 57 | # Replace default path to CKAN core config file with the one on the container 58 | sed -i -e 's/use = config:.*/use = config:\/srv\/app\/src\/ckan\/test-core.ini/' test.ini 59 | 60 | ckan -c test.ini db init 61 | ckan -c test.ini db pending-migrations --apply 62 | 63 | - name: Run tests 64 | run: pytest --ckan-ini=test.ini --cov=ckanext.announcements --disable-warnings ckanext/announcements 65 | 66 | -------------------------------------------------------------------------------- /ckanext/announcements/templates/admin/snippets/new-announcement.html: -------------------------------------------------------------------------------- 1 | {% import 'macros/form.html' as form %} 2 | 3 | -------------------------------------------------------------------------------- /ckanext/announcements/migration/announcements/env.py: -------------------------------------------------------------------------------- 1 | from alembic import context 2 | from sqlalchemy import engine_from_config, pool 3 | from logging.config import fileConfig 4 | 5 | import os 6 | 7 | # this is the Alembic Config object, which provides 8 | # access to the values within the .ini file in use. 9 | config = context.config 10 | 11 | # Interpret the config file for Python logging. 12 | # This line sets up loggers basically. 13 | fileConfig(config.config_file_name) 14 | 15 | # add your model's MetaData object here 16 | # for 'autogenerate' support 17 | # from myapp import mymodel 18 | # target_metadata = mymodel.Base.metadata 19 | target_metadata = None 20 | 21 | # other values from the config, defined by the needs of env.py, 22 | # can be acquired: 23 | # my_important_option = config.get_main_option("my_important_option") 24 | # ... etc. 25 | 26 | name = os.path.basename(os.path.dirname(__file__)) 27 | 28 | 29 | def run_migrations_offline(): 30 | """Run migrations in 'offline' mode. 31 | 32 | This configures the context with just a URL 33 | and not an Engine, though an Engine is acceptable 34 | here as well. By skipping the Engine creation 35 | we don't even need a DBAPI to be available. 36 | 37 | Calls to context.execute() here emit the given string to the 38 | script output. 39 | 40 | """ 41 | 42 | url = config.get_main_option("sqlalchemy.url") 43 | context.configure( 44 | url=url, 45 | target_metadata=target_metadata, 46 | literal_binds=True, 47 | version_table="{}_alembic_version".format(name), 48 | ) 49 | 50 | with context.begin_transaction(): 51 | context.run_migrations() 52 | 53 | 54 | def run_migrations_online(): 55 | """Run migrations in 'online' mode. 56 | 57 | In this scenario we need to create an Engine 58 | and associate a connection with the context. 59 | 60 | """ 61 | connectable = engine_from_config( 62 | config.get_section(config.config_ini_section), 63 | prefix="sqlalchemy.", 64 | poolclass=pool.NullPool, 65 | ) 66 | 67 | with connectable.connect() as connection: 68 | context.configure( 69 | connection=connection, 70 | target_metadata=target_metadata, 71 | version_table="{}_alembic_version".format(name), 72 | ) 73 | 74 | with context.begin_transaction(): 75 | context.run_migrations() 76 | 77 | 78 | if context.is_offline_mode(): 79 | run_migrations_offline() 80 | else: 81 | run_migrations_online() 82 | -------------------------------------------------------------------------------- /ckanext/announcements/templates/admin/announcements.html: -------------------------------------------------------------------------------- 1 | {% extends "admin/base.html" %} 2 | 3 | {% set messages = h.get_all_announcements() %} 4 | 5 | {% block primary_content_inner %} 6 |

{{ _('Announcements to all users') }}

7 | 8 |
9 | Schedule new message 17 |
18 | 19 |
20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | {% for message in messages %} 31 | 32 | 33 | 34 | 35 | 43 | 44 | {% endfor %} 45 | 46 |
MessageFromToActions
{{ h.render_markdown(message.message) }}{{ h.render_datetime(message.from_date, with_hours=True) }} ({{ display_timezone }}){{ h.render_datetime(message.to_date, with_hours=True) }} ({{ display_timezone }}) 36 | 37 | 38 | 39 | 40 | 41 | 42 |
47 |
48 | 49 | {% include "admin/snippets/new-announcement.html" %} 50 | 51 | {% for message in messages %} 52 | 53 | {% snippet "admin/snippets/edit-announcement.html", message=message, display_timezone=display_timezone, timezones=timezones %} 54 | {% snippet "admin/snippets/delete-announcement.html", message=message %} 55 | 56 | {% endfor %} 57 | 58 | {% endblock %} 59 | 60 | {% block secondary_content %} 61 |
62 |

63 | 64 | {{ _('Announcements to all users') }} 65 |

66 |
67 | {# allow to define start and end dates for a custom message #} 68 |
69 |
70 | {% endblock %} 71 | -------------------------------------------------------------------------------- /ckanext/announcements/templates/admin/snippets/edit-announcement.html: -------------------------------------------------------------------------------- 1 | {% import 'macros/form.html' as form %} 2 | 3 | 64 | -------------------------------------------------------------------------------- /ckanext/announcements/assets/js/announcements.js: -------------------------------------------------------------------------------- 1 | $( document ).ready(function() { 2 | 3 | $(document).on('click', 'form button[type=submit].announcement-submit-button', function(e) { 4 | $this = $(this); 5 | $form = $(e.target).parents('form'); 6 | errors = []; 7 | $message = $form.find('.announcement-message-input textarea'); 8 | if (! $message.val()) { 9 | errors.push('Error, a "message" is required'); 10 | } 11 | 12 | $dates = $form.find('.announcement-date-input'); 13 | $dates.each(function(i, obj) { 14 | if (! obj.value) { 15 | errors.push('Error, a date is required for "' + obj.name + '"'); 16 | } 17 | }); 18 | 19 | if (errors.length > 0) { 20 | e.preventDefault(); //prevent the default action 21 | $('.announcement-form-error').html('Please fix the following errors:'); 22 | $('.announcement-form-error').show(); 23 | // Scroll to error message 24 | $('.modal-body').animate({ 25 | scrollTop: $('.announcement-form-error').position().top 26 | }, 500); 27 | } 28 | }); 29 | 30 | // hide error div on modal hide to start fresh next time 31 | $('.announcement-form-modal').on('hide.bs.modal', function () { 32 | $('.announcement-form-error').hide(); 33 | // Reset any custom styling 34 | $('.modal-dialog').css('overflow-y', ''); 35 | }); 36 | 37 | // add a cookie to remember if user closed any announcement 38 | $(document).on('click', '.announcement-close-button', function(e) { 39 | var announcement_id = $(this).data('announcement-id'); 40 | var storage_name = 'announcement_closed_' + announcement_id; 41 | var expirationDate = new Date(); 42 | expirationDate.setDate(expirationDate.getDate() + 30); // Set expiration date to 7 days from now 43 | var item = { 44 | value: 'true', 45 | expiry: expirationDate.getTime() 46 | }; 47 | localStorage.setItem(storage_name, JSON.stringify(item)); 48 | }); 49 | 50 | // Show announcements that haven't been previously closed by the user 51 | $('.announcement').each(function(i, obj) { 52 | var announcement_id = $(obj).data('announcement-id'); 53 | var storage_name = 'announcement_closed_' + announcement_id; 54 | var st = localStorage.getItem(storage_name); 55 | var now = new Date(); 56 | if (st === null ) { 57 | // If the item is not in the storage show the announcement 58 | $(obj).show(); 59 | } 60 | // remove the storage key if expired 61 | else { 62 | var item = JSON.parse(localStorage.getItem(storage_name)); 63 | if (now.getTime() > item.expiry) { 64 | localStorage.removeItem(storage_name); 65 | } 66 | } 67 | }); 68 | }); -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![CKAN 2.11](https://github.com/okfn/ckanext-announcements/actions/workflows/test-ckan-2.11.yml/badge.svg)](https://github.com/okfn/ckanext-announcements/actions/workflows/test-ckan-2.11.yml) 2 | [![CKAN 2.10](https://github.com/okfn/ckanext-announcements/actions/workflows/test-ckan-2.10.yml/badge.svg)](https://github.com/okfn/ckanext-announcements/actions/workflows/test-ckan-2.10.yml) 3 | 4 | # ckanext-announcements 5 | 6 | Allow users to define scheduled announcements 7 | 8 | ![Screen shot](/docs/imgs/screen.png) 9 | 10 | ## Requirements 11 | 12 | Compatibility with core CKAN versions: 13 | 14 | `ckanext-announcements` only works with Python 3 15 | 16 | | CKAN version | Compatible? | 17 | | --------------- | -------------------- | 18 | | 2.8 | no | 19 | | 2.9 (py2) | no | 20 | | 2.9 (py3) | deprecated on 0.1.6 | 21 | | 2.10 | yes | 22 | | 2.11 | yes | 23 | 24 | ## Installation 25 | 26 | To install ckanext-announcements: 27 | 28 | 1. Activate your CKAN virtual environment, for example: 29 | 30 | . /usr/lib/ckan/default/bin/activate 31 | 32 | 2. Clone the source and install it on the virtualenv 33 | 34 | git clone https://github.com/okfn/ckanext-announcements.git 35 | cd ckanext-announcements 36 | pip install -e . 37 | pip install -r requirements.txt 38 | 39 | 3. Add `announcements` to the `ckan.plugins` setting in your CKAN 40 | config file (by default the config file is located at 41 | `/etc/ckan/default/ckan.ini`). 42 | 43 | 4. Update DB to add the announcements table 44 | 45 | `ckan db upgrade -p announcements` 46 | 47 | 5. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu: 48 | 49 | sudo service apache2 reload 50 | 51 | 52 | ## Config settings 53 | 54 | `ckanext.announcements.limit_announcements` (default: 50) 55 | > Limit for the announcement list 56 | 57 | `ckan.display_timezone` 58 | > Start and end dates are displayed in the timezone defined in this CKAN core setting 59 | 60 | ## Developer installation 61 | 62 | To install ckanext-announcements for development, activate your CKAN virtualenv and 63 | do: 64 | 65 | git clone https://github.com/okfn/ckanext-announcements.git 66 | cd ckanext-announcements 67 | python setup.py develop 68 | pip install -r dev-requirements.txt 69 | 70 | ### Activate pre-commits 71 | 72 | There are github actions to check code with `flake8` so it will be usefull to activate pre-commits 73 | 74 | ``` 75 | pip install pre-commit 76 | pre-commit install 77 | ``` 78 | 79 | ## Tests 80 | 81 | To run the tests, do: 82 | 83 | pytest --ckan-ini=test.ini 84 | 85 | 86 | ## Releasing a new version of ckanext-announcements 87 | 88 | If ckanext-announcements should be available on PyPI you can follow these steps to publish a new version: 89 | 90 | 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. 91 | 92 | 2. Make sure you have the latest version of necessary packages: 93 | 94 | pip install --upgrade setuptools wheel twine 95 | 96 | 3. Create a source and binary distributions of the new version: 97 | 98 | python setup.py sdist bdist_wheel && twine check dist/* 99 | 100 | Fix any errors you get. 101 | 102 | 4. Upload the source distribution to PyPI: 103 | 104 | twine upload dist/* 105 | 106 | 5. Commit any outstanding changes: 107 | 108 | git commit -a 109 | git push 110 | 111 | 6. Tag the new release of the project on GitHub with the version number from 112 | the `setup.py` file. For example if the version number in `setup.py` is 113 | 0.0.1 then do: 114 | 115 | git tag 0.0.1 116 | git push --tags 117 | 118 | ## License 119 | 120 | [AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html) 121 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # Always prefer setuptools over distutils 2 | from setuptools import setup, find_packages 3 | from codecs import open # To use a consistent encoding 4 | from os import path 5 | 6 | # from ckanext.announcements import __VERSION__ 7 | 8 | here = path.abspath(path.dirname(__file__)) 9 | 10 | # Get the long description from the relevant file 11 | with open(path.join(here, "README.md"), encoding="utf-8") as f: 12 | long_description = f.read() 13 | 14 | with open(path.join(here, "ckanext/announcements/__init__.py"), encoding="utf-8") as f: 15 | init = f.read() 16 | for line in init.splitlines(): 17 | if line.startswith("__VERSION__"): 18 | delim = '"' if '"' in line else "'" 19 | __VERSION__ = line.split(delim)[1] 20 | 21 | 22 | setup( 23 | name="""ckanext-announcements""", 24 | # Versions should comply with PEP440. For a discussion on single-sourcing 25 | # the version across setup.py and the project code, see 26 | # http://packaging.python.org/en/latest/tutorial.html#version 27 | version=__VERSION__, 28 | description="""Scheduled announcements""", 29 | long_description=long_description, 30 | long_description_content_type="text/markdown", 31 | # The project's main homepage. 32 | url="https://github.com/okfn/ckanext-announcements", 33 | # Author details 34 | author="""OKFN""", 35 | author_email="""info@okfn.org""", 36 | # Choose your license 37 | license="AGPL", 38 | # See https://pypi.python.org/pypi?%3Aaction=list_classifiers 39 | classifiers=[ 40 | # How mature is this project? Common values are 41 | # 3 - Alpha 42 | # 4 - Beta 43 | # 5 - Production/Stable 44 | "Development Status :: 4 - Beta", 45 | # Pick your license as you wish (should match "license" above) 46 | "License :: OSI Approved :: GNU Affero General Public License v3 (AGPLv3+)", 47 | # Specify the Python versions you support here. In particular, ensure 48 | # that you indicate whether you support Python 2, Python 3 or both. 49 | "Programming Language :: Python :: 3", 50 | "Programming Language :: Python :: 3.8", 51 | ], 52 | # What does your project relate to? 53 | keywords="""CKAN""", 54 | # You can just specify the packages manually here if your project is 55 | # simple. Or you can use find_packages(). 56 | packages=find_packages(exclude=["contrib", "docs", "tests*"]), 57 | namespace_packages=["ckanext"], 58 | install_requires=[ 59 | # CKAN extensions should not list dependencies here, but in a separate 60 | # ``requirements.txt`` file. 61 | # 62 | # http://docs.ckan.org/en/latest/extensions/best-practices.html 63 | # add-third-party-libraries-to-requirements-txt 64 | ], 65 | # If there are data files included in your packages that need to be 66 | # installed, specify them here. If using Python 2.6 or less, then these 67 | # have to be included in MANIFEST.in as well. 68 | include_package_data=True, 69 | package_data={}, 70 | # Although 'package_data' is the preferred approach, in some case you may 71 | # need to place data files outside of your packages. 72 | # see http://docs.python.org/3.4/distutils/setupscript.html 73 | # installing-additional-files 74 | # In this case, 'data_file' will be installed into '/my_data' 75 | data_files=[], 76 | # To provide executable scripts, use entry points in preference to the 77 | # "scripts" keyword. Entry points provide cross-platform support and allow 78 | # pip to create the appropriate form of executable for the target platform. 79 | entry_points=""" 80 | [ckan.plugins] 81 | announcements=ckanext.announcements.plugin:announcementsPlugin 82 | 83 | [babel.extractors] 84 | ckan = ckan.lib.extract:extract_ckan 85 | """, 86 | # If you are changing from the default layout of your extension, you may 87 | # have to change the message extractors, you can read more about babel 88 | # message extraction at 89 | # http://babel.pocoo.org/docs/messages/#extraction-method-mapping-and-configuration 90 | message_extractors={ 91 | "ckanext": [ 92 | ("**.py", "python", None), 93 | ("**.js", "javascript", None), 94 | ("**/templates/**.html", "ckan", None), 95 | ], 96 | }, 97 | ) 98 | -------------------------------------------------------------------------------- /ckanext/announcements/blueprints.py: -------------------------------------------------------------------------------- 1 | from datetime import datetime 2 | import logging 3 | import pytz 4 | from flask import Blueprint 5 | from ckan.plugins import toolkit 6 | from ckanext.announcements.utils import require_sysadmin_user 7 | 8 | 9 | log = logging.getLogger(__name__) 10 | announcements_blueprint = Blueprint( 11 | "announcements", __name__, url_prefix="/ckan-admin/announcements" 12 | ) 13 | 14 | 15 | @require_sysadmin_user 16 | def index(): 17 | """Get the Announcements home page""" 18 | display_timezone = toolkit.config.get("ckan.display_timezone", "UTC") 19 | pytz_timezones = pytz.all_timezones.copy() 20 | # remove CET and UTC to display them first 21 | pytz_timezones.remove("CET") 22 | pytz_timezones.remove("UTC") 23 | ctx = { 24 | "display_timezone": display_timezone, 25 | "timezones": ["UTC", "CET"] + sorted(pytz_timezones), 26 | } 27 | return toolkit.render("admin/announcements.html", extra_vars=ctx) 28 | 29 | 30 | def get_dates(form): 31 | from_date = form.get("from_date") 32 | to_date = form.get("to_date") 33 | timezone = form.get("timezone") 34 | # apply the selected tuimezone 35 | from_date = datetime.strptime(from_date, "%Y-%m-%dT%H:%M") 36 | from_date = pytz.timezone(timezone).localize(from_date) 37 | to_date = datetime.strptime(to_date, "%Y-%m-%dT%H:%M") 38 | to_date = pytz.timezone(timezone).localize(to_date) 39 | return from_date, to_date 40 | 41 | 42 | def create(): 43 | """Create (POST) a new announcement""" 44 | 45 | user_obj = toolkit.c.userobj 46 | user_creator_id = user_obj.id 47 | from_date, to_date = get_dates(toolkit.request.form) 48 | message = toolkit.request.form.get("message") 49 | 50 | new_announcements_data = { 51 | "timestamp": datetime.now(), 52 | "user_creator_id": user_creator_id, 53 | "from_date": from_date, 54 | "to_date": to_date, 55 | "message": message, 56 | "status": "active", 57 | } 58 | try: 59 | toolkit.get_action("announcement_create")( 60 | {"user": user_obj.name}, new_announcements_data 61 | ) 62 | except toolkit.ValidationError as e: 63 | summary = ", ".join([v[0] for k, v in e.error_dict.items()]) 64 | message = "Error creating new announcement: {}.".format(summary) 65 | toolkit.h.flash_error(message) 66 | 67 | return toolkit.redirect_to("announcements.index") 68 | 69 | 70 | def update(): 71 | """Updates an announcement""" 72 | 73 | user_obj = toolkit.c.userobj 74 | announ_id = toolkit.request.form.get("id") 75 | from_date, to_date = get_dates(toolkit.request.form) 76 | 77 | message = toolkit.request.form.get("message") 78 | 79 | announcements_data = { 80 | "id": announ_id, 81 | "from_date": from_date, 82 | "to_date": to_date, 83 | "message": message, 84 | } 85 | try: 86 | toolkit.get_action("announcement_update")( 87 | {"user": user_obj.name}, announcements_data 88 | ) 89 | except toolkit.ValidationError as e: 90 | summary = ", ".join([v[0] for _, v in e.error_dict.items()]) 91 | message = "Error updating announcement: {}.".format(summary) 92 | toolkit.h.flash_error(message) 93 | 94 | return toolkit.redirect_to("announcements.index") 95 | 96 | 97 | def delete(): 98 | """Delete an announcement""" 99 | 100 | user_obj = toolkit.c.userobj 101 | announ_id = toolkit.request.form.get("id") 102 | 103 | try: 104 | toolkit.get_action("announcement_delete")( 105 | {"user": user_obj.name}, {"id": announ_id} 106 | ) 107 | except toolkit.ValidationError as e: 108 | message = "Error deleting announcement: {}.".format(e) 109 | toolkit.h.flash_error(message) 110 | 111 | return toolkit.redirect_to("announcements.index") 112 | 113 | 114 | announcements_blueprint.add_url_rule(rule="/", view_func=index, methods=["GET"], strict_slashes=False) 115 | announcements_blueprint.add_url_rule(rule="/new", view_func=create, methods=["POST"], strict_slashes=False) 116 | announcements_blueprint.add_url_rule(rule="/update", view_func=update, methods=["POST"], strict_slashes=False) 117 | announcements_blueprint.add_url_rule(rule="/delete", view_func=delete, methods=["POST"], strict_slashes=False) 118 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------