Lessons Learned: Updating ContentLicensing to be Plone3 compatible David Ray, Brent Lambert Center for Open and Sustainable Learning Utah State University

David Ray, Brent Lambert Center for Open and Sustainable Learning Utah State University

Disclaimer! We are not Core Developers Some solutions presented may not be the definitive way of solving Zope 3 issues

We are not Core Developers

Some solutions presented may not be the definitive way of solving Zope 3 issues

Disclaimer However, issues that we have faced will be relevant to any Zope 3 related work We are still learning, and welcome suggestions and feedback

However, issues that we have faced will be relevant to any Zope 3 related work

We are still learning, and welcome suggestions and feedback

Background Based on PLIP #136 http://plone.org/products/plone/roadmap/136 'neutral licensing engine' standard behavior for all types Result of remote sprinting at Big Apple Sprint in Summer 2006

Based on PLIP #136

http://plone.org/products/plone/roadmap/136

'neutral licensing engine'

standard behavior for all types

Result of remote sprinting at Big Apple Sprint in Summer 2006

What it does Licenses content on a per object basis Acquires default site license unless specifically set Provides support for Creative Commons, GNU, All Rights Reserved

Licenses content on a per object basis

Acquires default site license unless specifically set

Provides support for Creative Commons, GNU, All Rights Reserved

What it does Able to add additional reusable license(s) to the licensing engine via control panel Able to add custom license per object, as needed Demo

Able to add additional reusable license(s) to the licensing engine via control panel

Able to add custom license per object, as needed

Demo

Who's using it? eduCommons Plone4Artists EngageMedia

eduCommons

Plone4Artists

EngageMedia

Source Code Plone 3 branch found in Plone Collective http://dev.plone.org/collective/browser/ContentLicensing/branches/cosl-plone3 Place in Products directory, apply profile to new Plone Site eduCommons project http://cosl.usu.edu/trac/browser/eduCommons3/trunk

Plone 3 branch found in Plone Collective

http://dev.plone.org/collective/browser/ContentLicensing/branches/cosl-plone3

Place in Products directory, apply profile to new Plone Site

eduCommons project

http://cosl.usu.edu/trac/browser/eduCommons3/trunk

From Zope 2 to Zope 3 Annotations Tools vs Local Utilities Replacing Placeless Scripts Custom Views Using the new Control Panel

Annotations

Tools vs Local Utilities

Replacing Placeless Scripts

Custom Views

Using the new Control Panel

Annotations DublinCoreExtensions Module Adds extended DC metadata to content objects Rights License Rights Holder Mitigates ambiguity of default Copyright field

DublinCoreExtensions Module

Adds extended DC metadata to content objects

Rights License

Rights Holder

Mitigates ambiguity of default Copyright field

Annotations ILicensable interface marks content as annotate-able Marker interface

ILicensable interface marks content as annotate-able

Marker interface

ILicensable Interface <class class=&quot;Products.ATContentTypes.content.document.ATDocument&quot;> <implements interface=&quot;Products.ContentLicensing.DublinCoreExtensions.interfaces.ILicensable zope.annotation.interfaces.IAttributeAnnotatable” /> </class>

<class class=&quot;Products.ATContentTypes.content.document.ATDocument&quot;>

<implements interface=&quot;Products.ContentLicensing.DublinCoreExtensions.interfaces.ILicensable zope.annotation.interfaces.IAttributeAnnotatable”

/>

</class>

Annotations Where would annotations be accessed from? Placeless script Zope3 View Archetypes generated form How to access annotations in these situations?

Where would annotations be accessed from?

Placeless script

Zope3 View

Archetypes generated form

How to access annotations in these situations?

Annotations Zope2 placeless environments Do not have access by default Can provide access through zope 3 views Access from placeless scripts via restrictedTraverse() Access from page templates using the structure tag

Zope2 placeless environments

Do not have access by default

Can provide access through zope 3 views

Access from placeless scripts via restrictedTraverse()

Access from page templates using the structure tag

Annotations – Placeless Script message = obj.restrictedTraverse('@@change_copyright_view').changeCopyright(copyright_action)

message = obj.restrictedTraverse('@@change_copyright_view').changeCopyright(copyright_action)

Annotations – Zope 2 Page template <div tal:replace=&quot;structure context/@@copyright_byline_view|nothing&quot; />

<div tal:replace=&quot;structure context/@@copyright_byline_view|nothing&quot; />

Annotations – Zope 3 View <div tal:omit-tag=&quot;&quot; tal:define=&quot;objstuff python:view.getLicenseAndHolderFromObject(here); objHolder python:objstuff[0]; objLicense python:objstuff[1]; objLicenseId python:objLicense[0];&quot;>

<div tal:omit-tag=&quot;&quot;

tal:define=&quot;objstuff python:view.getLicenseAndHolderFromObject(here);

objHolder python:objstuff[0];

objLicense python:objstuff[1];

objLicenseId python:objLicense[0];&quot;>

Annotations – Archeypes A little more complicated customize edit macros

A little more complicated

customize edit macros

Customizing Archetypes Forms Add field via edit_macros check view for availability <tal:licensingfield tal:condition=&quot;python:fieldset == 'ownership'&quot;> <div tal:replace=&quot;structure context/@@dc_metadata| nothing &quot; /> </tal:licensingfield>

Add field via edit_macros

check view for availability

<tal:licensingfield tal:condition=&quot;python:fieldset == 'ownership'&quot;>

<div tal:replace=&quot;structure context/@@dc_metadata| nothing &quot; />

</tal:licensingfield>

Annotations - Indexing ProxyIndex AddOn Product Don't have to install Lives in Products directory http://infrae.com/download/ProxyIndex

ProxyIndex

AddOn Product

Don't have to install

Lives in Products directory

http://infrae.com/download/ProxyIndex

Annotations - Indexing ProxyIndex allows TALES expressions to retrieve the value to index an object Defined in setupHandlers.py

ProxyIndex allows TALES expressions to retrieve the value to index an object

Defined in setupHandlers.py

Utility Move settable properties to GenericSetup Register Utility in setupHandlers.py Explicity setSite(site) to register

Move settable properties to GenericSetup

Register Utility in setupHandlers.py

Explicity setSite(site) to register

Utility def setupUtilities(site): &quot;&quot;&quot; Register a local utility &quot;&quot;&quot; if not Isite.providedBy(site): enableLocalSiteHook(site) setSite(site) sm = getSiteManager() if not sm.queryUtility(IContentLicensingUtility): sm.registerUtility(ContentLicensingUtility('contentlicensing'), IContentLicensingUtility)

def setupUtilities(site):

&quot;&quot;&quot; Register a local utility &quot;&quot;&quot;

if not Isite.providedBy(site):

enableLocalSiteHook(site)

setSite(site)

sm = getSiteManager()

if not sm.queryUtility(IContentLicensingUtility):

sm.registerUtility(ContentLicensingUtility('contentlicensing'),

IContentLicensingUtility)

Events CMFFormController scripts evolve Determine if placeless script can be assigned to an event

CMFFormController scripts evolve

Determine if placeless script can be assigned to an event

Events Recursive License on Folderish Objects Fire event on IObjectModified <subscriber for=&quot;Products.ATContentTypes.content.folder.ATFolder zope.app.event.interfaces.IObjectModifiedEvent” handler=&quot;.events.recursive_license” />

Recursive License on Folderish Objects

Fire event on IObjectModified

<subscriber for=&quot;Products.ATContentTypes.content.folder.ATFolder zope.app.event.interfaces.IObjectModifiedEvent” handler=&quot;.events.recursive_license” />

Events Check state of Object for certain events IObjectAddedEvent

Check state of Object for certain events

IObjectAddedEvent

Viewlets Do you need to customize all those page templates? Viewlets can simplify codebase

Do you need to customize all those page templates?

Viewlets can simplify codebase

Viewlets Beware! Layer management incomplete! ZCML executed regardless of whether or not layer is installed

Beware! Layer management incomplete!

ZCML executed regardless of whether or not layer is installed

Formlib - ControlPanel Separate concerns with interfaces/fieldsets Content License Settings Add New License Control Panel Adapter Adapts schema of Control Panel to Plone Site

Separate concerns with interfaces/fieldsets

Content License Settings

Add New License

Control Panel Adapter

Adapts schema of Control Panel to Plone Site

Formlib : ControlPanel New License Form getter/setter of properties does nothing handle data in handle_edit_action also handles default view

New License Form

getter/setter of properties does nothing

handle data in handle_edit_action

also handles default view

Formlib Custom Widgets Hidden fields Attach to existing custom widget Formlib doesn't provide a hidden widget ccwidget.pt

Custom Widgets

Hidden fields

Attach to existing custom widget

Formlib doesn't provide a hidden widget

ccwidget.pt

Other Examples eduCommons Course Builder Widget Existing vs New Division

eduCommons Course Builder Widget

Existing vs New Division

Questions?

Additional Resources http://cosl.usu.edu/projects/plone-add-on-products/ List of COSL authored projects Check Plone3 branches for additional examples

http://cosl.usu.edu/projects/plone-add-on-products/

List of COSL authored projects

Check Plone3 branches for additional examples