Skip to content

Z
Zope
Commit 3022a300 authored by Amos Latteier's avatar Amos Latteier
Browse files
Options

Moved help system code to the HelpSys module. Removed the HelpSystem module.... 

Moved help system code to the HelpSys module. Removed the HelpSystem module. This was done to improve backword compatibility with Zope 2.1.6 and earlier.

Zope's built recently from CVS may have problems with this change. If I hear a lot of complaints I may add backward compatibility, otherwise it should be easy enough fix by either erasing your database or replacing your HelpSys object.
parent 5fcbc1b1
Show whitespace changes
Inline Side-by-side
Showing with 151 additions and 286 deletions
lib/python/HelpSys/HelpSys.py
View file @ 3022a300
......@@ -82,54 +82,165 @@
# attributions are listed in the accompanying credits file.
#
##############################################################################
"""Help system implementation"""
__version__='$Revision: 1.7 $'[11:-2]
import sys, os, string, Globals, Acquisition
from HelpUtil import HelpBase
from ObjectRef import ObjectRef
from App.ImageFile import ImageFile
from Globals import HTMLFile
class HelpSys(HelpBase):
""" """
__names__=None
__roles__=None
hs_index=HTMLFile('helpsys', globals())
hs_menu =HTMLFile('helpsys_menu', globals())
hs_main =HTMLFile('helpsys_main', globals())
hs_cicon='HelpSys/hs_cbook'
hs_eicon='HelpSys/hs_obook'
# Images used by the help system
hs_uarrow=ImageFile('images/hs_uarrow.gif', globals())
hs_darrow=ImageFile('images/hs_darrow.gif', globals())
hs_rarrow=ImageFile('images/hs_rarrow.gif', globals())
hs_larrow=ImageFile('images/hs_larrow.gif', globals())
hs_dnode=ImageFile('images/hs_dnode.gif', globals())
hs_obook=ImageFile('images/hs_obook.gif', globals())
hs_cbook=ImageFile('images/hs_cbook.gif', globals())
hs_id='HelpSys'
hs_title='Z Help Online'
ObjectRef=ObjectRef()
hs_objectvalues__roles__=None
def hs_objectvalues(self):
return [self.ObjectRef]
def __len__(self):
return 1
import Acquisition
from OFS.SimpleItem import Item
from OFS.ObjectManager import ObjectManager
from Globals import Persistent, HTMLFile, HTML
from Products.ZCatalog.ZCatalog import ZCatalog
from Products.ZCatalog.Lazy import LazyCat
import Products
import HelpTopic
class HelpSys(Acquisition.Implicit, ObjectManager, Item, Persistent):
"""
Zope Help System
Provides browsing and searching of Zope Product Help.
"""
meta_type='Help System'
manage_options=(
{'label' : 'Contents', 'action' : 'menu'},
{'label' : 'Search', 'action' : 'search'},
)
__ac_permissions__=(
('View',
('__call__', 'searchResults', 'HelpButton', '',
'index_html', 'menu', 'search', 'results', 'main', )),
('Access contents information', ('helpValues',)),
)
def __init__(self, id):
self.id=id
def helpValues(self, spec=None):
"ProductHelp objects of all Products that have help"
hv=[]
for product in self.Control_Panel.Products.objectValues():
productHelp=product.getProductHelp()
# only list products that actually have help
if productHelp.helpValues():
hv.append(productHelp)
return hv
# Seaching does an aggregated search of all ProductHelp
# objects. Only Help Topics for which the user has permissions
# are returned.
def __call__(self, REQUEST=None, **kw):
"Searchable interface"
if REQUEST is not None:
perms=[]
user=REQUEST.AUTHENTICATED_USER
for p in self.ac_inherited_permissions():
if user.has_permission(p[0], self):
perms.append(p[0])
REQUEST.set('permissions',perms)
results=[]
for ph in self.helpValues():
results.append(apply(getattr(ph, '__call__'), (REQUEST,) , kw))
return LazyCat(results)
searchResults=__call__
index_html=HTMLFile('frame', globals())
menu=HTMLFile('menu', globals())
search=HTMLFile('search', globals())
results=HTMLFile('results', globals())
main=HTML("""<html></html>""")
button=HTMLFile('button', globals())
def HelpButton(self, topic, product):
"""
Insert a help button linked to a help topic.
"""
return self.button(self, self.REQUEST, product=product, topic=topic)
helpURL=HTMLFile('helpURL',globals())
class ProductHelp(Acquisition.Implicit, ObjectManager, Item, Persistent):
"""
Manages a collection of Help Topics for a given Product.
Provides searching services to HelpSystem.
"""
meta_type='Product Help'
icon='p_/ProductHelp_icon'
lastRegistered=None
meta_types=({'name':'Help Topic',
'action':'addTopicForm',
'permission':'Add Documents, Images, and Files'},
)
manage_options=(
{'label':'Contents', 'action':'manage_main'},
{'label':'Import/Export', 'action':'manage_importExportForm'},
{'label':'Undo', 'action':'manage_UndoForm'},
)
__ac_permissions__=(
('Add Documents, Files, and Images', ('addTopicForm', 'addTopic')),
)
def __init__(self, id='Help', title=''):
self.id=id
self.title=title
self.catalog=ZCatalog('catalog')
c=self.catalog._catalog
# clear catalog
for index in c.indexes.keys():
c.delIndex(index)
for col in c.schema.keys():
c.delColumn(col)
c.addIndex('SearchableText', 'TextIndex')
c.addIndex('categories', 'KeywordIndex')
c.addIndex('permissions', 'KeywordIndex')
c.addColumn('categories')
c.addColumn('permissions')
c.addColumn('title_or_id')
c.addColumn('url')
c.addColumn('id')
addTopicForm=HTMLFile('addTopic', globals())
def addTopic(self, id, title, REQUEST=None):
"Add a Help Topic"
topic=HelpTopic.DTMLDocumentTopic(
HelpTopic.default_topic_content, __name__=id)
topic.title=title
self._setObject(id, topic)
if REQUEST is not None:
return self.manage_main(self, REQUEST,
manage_tabs_message='Help Topic added.')
def helpValues(self, REQUEST=None):
"""
Lists contained Help Topics.
Help Topics for which the user is not authorized
are not listed.
"""
topics=self.objectValues('Help Topic')
if REQUEST is None:
return topics
return filter(
lambda ht, u=REQUEST.AUTHENTICATED_USER: ht.authorized(u), topics)
def all_meta_types(self):
f=lambda x: x['name'] in ('Image', 'File')
return filter(f, Products.meta_types) + self.meta_types
def __call__(self, *args, **kw):
"""
Searchable interface
"""
return apply(self.catalog.__call__, args, kw)
standard_html_header=HTMLFile('topic_header', globals())
standard_html_footer=HTMLFile('topic_footer', globals())
lib/python/HelpSys/HelpSystem.py deleted 100644 → 0
View file @ 5fcbc1b1
##############################################################################
#
# Zope Public License (ZPL) Version 1.0
# -------------------------------------
#
# Copyright (c) Digital Creations. All rights reserved.
#
# This license has been certified as Open Source(tm).
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions in source code must retain the above copyright
# notice, this list of conditions, and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions, and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# 3. Digital Creations requests that attribution be given to Zope
# in any manner possible. Zope includes a "Powered by Zope"
# button that is installed by default. While it is not a license
# violation to remove this button, it is requested that the
# attribution remain. A significant investment has been put
# into Zope, and this effort will continue if the Zope community
# continues to grow. This is one way to assure that growth.
#
# 4. All advertising materials and documentation mentioning
# features derived from or use of this software must display
# the following acknowledgement:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# In the event that the product being advertised includes an
# intact Zope distribution (with copyright and license included)
# then this clause is waived.
#
# 5. Names associated with Zope or Digital Creations must not be used to
# endorse or promote products derived from this software without
# prior written permission from Digital Creations.
#
# 6. Modified redistributions of any form whatsoever must retain
# the following acknowledgment:
#
# "This product includes software developed by Digital Creations
# for use in the Z Object Publishing Environment
# (http://www.zope.org/)."
#
# Intact (re-)distributions of any official Zope release do not
# require an external acknowledgement.
#
# 7. Modifications are encouraged but must be packaged separately as
# patches to official Zope releases. Distributions that do not
# clearly separate the patches from the original work must be clearly
# labeled as unofficial distributions. Modifications which do not
# carry the name Zope may be packaged in any form, as long as they
# conform to all of the clauses above.
#
#
# Disclaimer
#
# THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
# EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#
# This software consists of contributions made by Digital Creations and
# many individuals on behalf of Digital Creations. Specific
# attributions are listed in the accompanying credits file.
#
##############################################################################
import Acquisition
from OFS.SimpleItem import Item
from OFS.ObjectManager import ObjectManager
from Globals import Persistent, HTMLFile, HTML
from Products.ZCatalog.ZCatalog import ZCatalog
from Products.ZCatalog.Lazy import LazyCat
import Products
import HelpTopic
class HelpSystem(Acquisition.Implicit, ObjectManager, Item, Persistent):
"""
Zope Help System
Provides browsing and searching of Zope Product Help.
"""
meta_type='Help System'
manage_options=(
{'label' : 'Contents', 'action' : 'menu'},
{'label' : 'Search', 'action' : 'search'},
)
__ac_permissions__=(
('View',
('__call__', 'searchResults', 'HelpButton', '',
'index_html', 'menu', 'search', 'results', 'main', )),
('Access contents information', ('helpValues',)),
)
def __init__(self, id):
self.id=id
def helpValues(self, spec=None):
"ProductHelp objects of all Products that have help"
hv=[]
for product in self.Control_Panel.Products.objectValues():
productHelp=product.getProductHelp()
# only list products that actually have help
if productHelp.helpValues():
hv.append(productHelp)
return hv
# Seaching does an aggregated search of all ProductHelp
# objects. Only Help Topics for which the user has permissions
# are returned.
def __call__(self, REQUEST=None, **kw):
"Searchable interface"
if REQUEST is not None:
perms=[]
user=REQUEST.AUTHENTICATED_USER
for p in self.ac_inherited_permissions():
if user.has_permission(p[0], self):
perms.append(p[0])
REQUEST.set('permissions',perms)
results=[]
for ph in self.helpValues():
results.append(apply(getattr(ph, '__call__'), (REQUEST,) , kw))
return LazyCat(results)
searchResults=__call__
index_html=HTMLFile('frame', globals())
menu=HTMLFile('menu', globals())
search=HTMLFile('search', globals())
results=HTMLFile('results', globals())
main=HTML("""<html></html>""")
button=HTMLFile('button', globals())
def HelpButton(self, topic, product):
"""
Insert a help button linked to a help topic.
"""
return self.button(self, self.REQUEST, product=product, topic=topic)
helpURL=HTMLFile('helpURL',globals())
class ProductHelp(Acquisition.Implicit, ObjectManager, Item, Persistent):
"""
Manages a collection of Help Topics for a given Product.
Provides searching services to HelpSystem.
"""
meta_type='Product Help'
icon='p_/ProductHelp_icon'
lastRegistered=None
meta_types=({'name':'Help Topic',
'action':'addTopicForm',
'permission':'Add Documents, Images, and Files'},
)
manage_options=(
{'label':'Contents', 'action':'manage_main'},
{'label':'Import/Export', 'action':'manage_importExportForm'},
{'label':'Undo', 'action':'manage_UndoForm'},
)
__ac_permissions__=(
('Add Documents, Files, and Images', ('addTopicForm', 'addTopic')),
)
def __init__(self, id='Help', title=''):
self.id=id
self.title=title
self.catalog=ZCatalog('catalog')
c=self.catalog._catalog
# clear catalog
for index in c.indexes.keys():
c.delIndex(index)
for col in c.schema.keys():
c.delColumn(col)
c.addIndex('SearchableText', 'TextIndex')
c.addIndex('categories', 'KeywordIndex')
c.addIndex('permissions', 'KeywordIndex')
c.addColumn('categories')
c.addColumn('permissions')
c.addColumn('title_or_id')
c.addColumn('url')
c.addColumn('id')
addTopicForm=HTMLFile('addTopic', globals())
def addTopic(self, id, title, REQUEST=None):
"Add a Help Topic"
topic=HelpTopic.DTMLDocumentTopic(
HelpTopic.default_topic_content, __name__=id)
topic.title=title
self._setObject(id, topic)
if REQUEST is not None:
return self.manage_main(self, REQUEST,
manage_tabs_message='Help Topic added.')
def helpValues(self, REQUEST=None):
"""
Lists contained Help Topics.
Help Topics for which the user is not authorized
are not listed.
"""
topics=self.objectValues('Help Topic')
if REQUEST is None:
return topics
return filter(
lambda ht, u=REQUEST.AUTHENTICATED_USER: ht.authorized(u), topics)
def all_meta_types(self):
f=lambda x: x['name'] in ('Image', 'File')
return filter(f, Products.meta_types) + self.meta_types
def __call__(self, *args, **kw):
"""
Searchable interface
"""
return apply(self.catalog.__call__, args, kw)
standard_html_header=HTMLFile('topic_header', globals())
standard_html_footer=HTMLFile('topic_footer', globals())
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7