Metadata

Distro Index Owner:
eea
Home Page:
ftw.globalstatusmessage
License
GPL2
Version:
1.6.3rc1
Last updated:
2018-06-13
Keywords:
ftw global status message plone

ftw.globalstatusmessage

Files

Indexes

Shows a global message on every site.

Introduction

With ftw.globalstatusmessage a Plone site administrator display messages on all pages.

This is useful for inform the users about an upcoming maintance downtime or any other important thing.

The message can be changed in the plone control panel:

https://raw.githubusercontent.com/4teamwork/ftw.globalstatusmessage/master/docs/screenshot.png

Exclude sites

With the Exclude sites option it is possible to show the global status message only for certain sub sites. All containers providing the interface INavigationRoot are considered sub sites. Make sure that the object_provides catalog index is up to date after enabling the interface for a container.

When having nested sub sites, the nearest parent sub site relative to the current context is relevant. If the nearest sub site is not excluded but a parent is excluded, the message is shown on the current context.

Allow automatic activation

With the Allow automatic activation? option active it is possible to show and hide the global status message in automatic. By default, there is no logic defined for this option. You can define your own utility to specify the logic for the automatic activation as described bellow.

Under overrides.zcml register a utility as shown bellow:

<utility
    name="ftw.globalstatusmessage:automatic_enable"
    provides="ftw.globalstatusmessage.interfaces.IStatusMessageAutomaticEnable"
    factory="mypackage.utilities.StatusmessageAutomaticEnable" />

and create a factory class for the automatic enable logic:

from ftw.globalstatusmessage.interfaces import IStatusMessageAutomaticEnable
from zope.interface import implements

class StatusmessageAutomaticEnable(object):
    """ Global status message utility for automatic enable
    """
    implements(IStatusMessageAutomaticEnable)

    def __call__(self):
        return True

Show on login form

With the Show on login form? option active the global status message will appear only on the login_form for the anonymous users. This option can be useful for example when you want to inform your editors that the CMS login is closed for maintenance. You can define your own utility to specify the logic for detecting the login form as described bellow.

Under overrides.zcml register a utility as shown bellow:

<utility
    name="ftw.globalstatusmessage:show_on_login"
    provides="ftw.globalstatusmessage.interfaces.IStatusMessageShowOnLogin"
    factory="mypackage.utilities.StatusmessageShowOnLogin" />

and create a factory class for the show on login form logic:

from ftw.globalstatusmessage.interfaces import IStatusMessageShowOnLogin
from zope.interface import implements

class StatusmessageShowOnLogin(object):
    """ Global status message utility for show on login form
    """
    implements(IStatusMessageShowOnLogin)

    def __call__(self):
        return True

Compatibility

Supports Plone 4.2, 4.3.

Installation

  • Add ftw.globalstatusmessage to your buildout configuration:
[instance]
eggs +=
    ftw.globalstatusmessage
  • Install the generic import profile.

Uninstall

This package provides an uninstall Generic Setup profile. Uninstall the package by using Plone's addon controlpanel or portal_quickInstaller.

Changelog

1.6.3.rc1 (2018-06-13)

  • Implemented option to enable in automatic the status message. [alecghica]
  • Implemented option to show the status message on login form. [alecghica]

1.6.2 (2017-08-22)

  • Make the receiving endpoint available if ftw.publisher.receiver is installed. Fixes 1.6.1. [mbaechtold]

1.6.1 (2017-08-17)

  • Prevent exception if ftw.publisher.sender is not installed. Fixes 1.6.0 [mbaechtold]

1.6.0 (2017-08-16)

  • New feature allows to send the global status message config to a ftw.publisher.receiver instance. [mbaechtold, jone]

1.5.0 (2017-02-17)

  • Add option to exclude anonymous users from viewing the status message. [hvelarde]
  • Remove indirect dependency on five.grok. [hvelarde]
  • Drop Plone 4.1 support. [jone]

1.4.3 (2016-12-02)

  • Fix class assertion on DOM-Element. [raphael-s]

1.4.2 (2016-10-31)

  • Chameleon support: fix status message class. [jone]

1.4.1 (2015-05-06)

  • Add Finnish translations. [petri]

1.4.0 (2014-06-02)

  • Add option to exclude subsites from displaying the status message. [jone]
  • Brazilian Portuguese and Spanish translations were updated. [hvelarde]
  • Configlet was migrated to plone.app.registry (closes #13). [hvelarde]

1.3.0 (2014-05-14)

  • Brazilian Portuguese and Spanish translations were added. [hvelarde]
  • Implement uninstall profile. [jone]
  • Remove no longer used utility. [jone]
  • Protect statusmessage viewlet with browserlayer. The viewlet should not be rendered when the package is not installed. [jone]
  • Replace old PloneTestCase tests with p.a.testing tests. [jone]
  • Remove z3c.autoinclude includeDependencies, no longer required. [jone]

1.2 (2013-06-21)

  • Use own permission to manage globalstatusmessages. [Julian Infanger]
  • Drop Plone 4.0 support. [jone]

1.1 (2012-05-21)

  • Make Plone 4.1.x compatible. [mathias.leimgruber]
  • Prepare for public release. [mathias.leimgruber]

1.0 (2011-04-12)

  • Fix egg structure / added readme [mathias.leimgruber]
  • Initial release [ttschanz]