eeek...Zope 3 ZPTs now work in Zope 2 :-)

lib/python/Products/ZPT/ZPT.py

@@ -17,68 +17,364 @@ Zope object encapsulating a Page Template.
 
 __version__='$Revision: 1.48 $'[11:-2]
 
+import os, AccessControl, Acquisition, sys, types
 from types import StringType
-from Globals import DTMLFile, ImageFile, MessageDialog, package_home, Persistent
+from Globals import DTMLFile, ImageFile, MessageDialog, package_home
 from zLOG import LOG, ERROR, INFO
 from OFS.SimpleItem import SimpleItem
-import AccessControl
+from DateTime.DateTime import DateTime
+from Shared.DC.Scripts.Script import Script, BindingsUI
+from Shared.DC.Scripts.Signature import FuncCode
 from AccessControl import getSecurityManager
+try:
+    from AccessControl import Unauthorized
+except ImportError:
+    Unauthorized = "Unauthorized"
+from OFS.History import Historical, html_diff
+from OFS.Cache import Cacheable
+from OFS.Traversable import Traversable
+from OFS.PropertyManager import PropertyManager
+#from PageTemplate import PageTemplate
+from Products.PageTemplates.Expressions import SecureModuleImporter
+from Products.PageTemplates.PageTemplateFile import PageTemplateFile
+
+try:
+    from webdav.Lockable import ResourceLockedError
+    from webdav.WriteLockInterface import WriteLockInterface
+    SUPPORTS_WEBDAV_LOCKS = 1
+except ImportError:
+    SUPPORTS_WEBDAV_LOCKS = 0
+
 
 from zope.pagetemplate.pagetemplate import PageTemplate
-from Products.PageTemplates.PageTemplateFile import PageTemplateFile
 
-class ZPT(SimpleItem, PageTemplate):
+class Src(Acquisition.Explicit):
+    " "
+
+    PUT = document_src = Acquisition.Acquired
+    index_html = None
+
+    def __before_publishing_traverse__(self, ob, request):
+        if getattr(request, '_hacked_path', 0):
+            request._hacked_path = 0
+
+    def __call__(self, REQUEST, RESPONSE):
+        " "
+        return self.document_src(REQUEST)
+
+
+class ZPT(Script, PageTemplate, Historical, Cacheable,
+                       Traversable, PropertyManager):
     "Zope wrapper for Page Template using TAL, TALES, and METAL"
 
+    if SUPPORTS_WEBDAV_LOCKS:
+        __implements__ = (WriteLockInterface,)
+
     meta_type = 'ZPT'
 
+    func_defaults = None
+    func_code = FuncCode((), 0)
+
+    _default_bindings = {'name_subpath': 'traverse_subpath'}
+    _default_content_fn = os.path.join(package_home(globals()),
+                                       'www', 'default.html')
+
     manage_options = (
         {'label':'Edit', 'action':'pt_editForm',
          'help': ('PageTemplates', 'PageTemplate_Edit.stx')},
         {'label':'Test', 'action':'ZScriptHTML_tryForm'},
-        ) \
+        ) + PropertyManager.manage_options \
+        + Historical.manage_options \
         + SimpleItem.manage_options \
+        + Cacheable.manage_options
 
-    security = AccessControl.ClassSecurityInfo()
+    _properties=({'id':'title', 'type': 'string', 'mode': 'wd'},
+                 {'id':'content_type', 'type':'string', 'mode': 'w'},
+                 {'id':'expand', 'type':'boolean', 'mode': 'w'},
+                 )
 
     def __init__(self, id, text=None, content_type=None):
         self.id = str(id)
+        self.ZBindings_edit(self._default_bindings)
+        if text is None:
+            text = open(self._default_content_fn).read()
+        self.pt_edit(text, content_type)
 
+    def _setPropValue(self, id, value):
+        PropertyManager._setPropValue(self, id, value)
+        self.ZCacheable_invalidate()
+
+    security = AccessControl.ClassSecurityInfo()
+
+    security.declareObjectProtected('View')
     security.declareProtected('View', '__call__')
-    security.declareProtected('View', 'view')
-    def view(self):
-        """view """
-        return self()
+
+    security.declareProtected('View management screens',
+      'pt_editForm', 'manage_main', 'read',
+      'ZScriptHTML_tryForm', 'PrincipiaSearchSource',
+      'document_src', 'source_dot_xml')
+
+    security.declareProtected('FTP access',
+      'manage_FTPstat','manage_FTPget','manage_FTPlist')
+
+    pt_editForm = PageTemplateFile('www/ptEdit', globals(),
+                                   __name__='pt_editForm')
+    pt_editForm._owner = None
+    manage = manage_main = pt_editForm
+
+    source_dot_xml = Src()
 
     security.declareProtected('Change Page Templates',
       'pt_editAction', 'pt_setTitle', 'pt_edit',
       'pt_upload', 'pt_changePrefs')
     def pt_editAction(self, REQUEST, title, text, content_type, expand):
         """Change the title and document."""
-
-        print text
-        print content_type
+        if SUPPORTS_WEBDAV_LOCKS and self.wl_isLocked():
+            raise ResourceLockedError, "File is locked via WebDAV"
+        self.expand=expand
+        self.pt_setTitle(title)
         self.pt_edit(text, content_type)
-        message= 'done'
+        REQUEST.set('text', self.read()) # May not equal 'text'!
+        REQUEST.set('title', self.title)
+        message = "Saved changes."
+        if getattr(self, '_v_warnings', None):
+            message = ("<strong>Warning:</strong> <i>%s</i>"
+                       % '<br>'.join(self._v_warnings))
         return self.pt_editForm(manage_tabs_message=message)
 
+    def pt_setTitle(self, title):
+        charset = getattr(self, 'management_page_charset', None)
+        if type(title) == types.StringType and charset:
+            try:
+                title.decode('us-ascii')
+                title = str(title)
+            except UnicodeError:
+                title = unicode(title, charset)
+        elif type(title) != types.UnicodeType:
+            title = str(title)
+        self._setPropValue('title', title)
 
-    pt_editForm = PageTemplateFile('www/ptEdit', globals(),
-                                   __name__='pt_editForm')
+    def pt_upload(self, REQUEST, file='', charset=None):
+        """Replace the document with the text in file."""
+        if SUPPORTS_WEBDAV_LOCKS and self.wl_isLocked():
+            raise ResourceLockedError, "File is locked via WebDAV"
+
+        if type(file) is not StringType:
+            if not file: raise ValueError, 'File not specified'
+            file = file.read()
+        if charset:
+            try:
+                unicode(file, 'us-ascii')
+                file = str(file)
+            except UnicodeDecodeError:
+                file = unicode(file, charset)
+        self.write(file)
+        message = 'Saved changes.'
+        return self.pt_editForm(manage_tabs_message=message)
+
+    def pt_changePrefs(self, REQUEST, height=None, width=None,
+                       dtpref_cols="100%", dtpref_rows="20"):
+        """Change editing preferences."""
+        dr = {"Taller":5, "Shorter":-5}.get(height, 0)
+        dc = {"Wider":5, "Narrower":-5}.get(width, 0)
+        if isinstance(height, int): dtpref_rows = height
+        if isinstance(width, int) or \
+           isinstance(width, str) and width.endswith('%'):
+            dtpref_cols = width
+        rows = str(max(1, int(dtpref_rows) + dr))
+        cols = str(dtpref_cols)
+        if cols.endswith('%'):
+           cols = str(min(100, max(25, int(cols[:-1]) + dc))) + '%'
+        else:
+           cols = str(max(35, int(cols) + dc))
+        e = (DateTime("GMT") + 365).rfc822()
+        setCookie = REQUEST["RESPONSE"].setCookie
+        setCookie("dtpref_rows", rows, path='/', expires=e)
+        setCookie("dtpref_cols", cols, path='/', expires=e)
+        REQUEST.other.update({"dtpref_cols":cols, "dtpref_rows":rows})
+        return self.manage_main()
 
+    def ZScriptHTML_tryParams(self):
+        """Parameters to test the script with."""
+        return []
 
+#    def manage_historyCompare(self, rev1, rev2, REQUEST,
+#                              historyComparisonResults=''):
+#        return ZopePageTemplate.inheritedAttribute(
+#            'manage_historyCompare')(
+#            self, rev1, rev2, REQUEST,
+#            historyComparisonResults=html_diff(rev1._text, rev2._text) )
+
+    def pt_getContext(self, **kw):
+        root = self.getPhysicalRoot()
+        context = self._getContext()
+        c = {'template': self,
+             'here': context,
+             'context': context,
+             'container': self._getContainer(),
+             'nothing': None,
+             'options': {},
+             'root': root,
+             'request': getattr(root, 'REQUEST', None),
+             'modules': SecureModuleImporter,
+             }
+        return c
+
+#    def write(self, text):
+#        self.ZCacheable_invalidate()
+##        ZopePageTemplate.inheritedAttribute('write')(self, text)
+#        self.pt_edit(text, self.content_type)
+
+    def _exec(self, bound_names, args, kw):
+        """Call a Page Template"""
+        if not kw.has_key('args'):
+            kw['args'] = args
+        bound_names['options'] = kw
+
+        try:
+            response = self.REQUEST.RESPONSE
+            if not response.headers.has_key('content-type'):
+                response.setHeader('content-type', self.content_type)
+        except AttributeError:
+            pass
+
+        security=getSecurityManager()
+        bound_names['user'] = security.getUser()
+
+        # Retrieve the value from the cache.
+        keyset = None
+        if self.ZCacheable_isCachingEnabled():
+            # Prepare a cache key.
+            keyset = {'here': self._getContext(),
+                      'bound_names': bound_names}
+            result = self.ZCacheable_get(keywords=keyset)
+            if result is not None:
+                # Got a cached value.
+                return result
+
+        # Execute the template in a new security context.
+        security.addContext(self)
+        try:
+            result = self.pt_render(self.pt_getContext())
+
+#            result = self.pt_render(extra_context=bound_names)
+            if keyset is not None:
+                # Store the result in the cache.
+                self.ZCacheable_set(result, keywords=keyset)
+            return result
+        finally:
+            security.removeContext(self)
+
+    security.declareProtected('Change Page Templates',
+      'PUT', 'manage_FTPput', 'write',
+      'manage_historyCopy',
+      'manage_beforeHistoryCopy', 'manage_afterHistoryCopy')
+
+    def PUT(self, REQUEST, RESPONSE):
+        """ Handle HTTP PUT requests """
+        self.dav__init(REQUEST, RESPONSE)
+        if SUPPORTS_WEBDAV_LOCKS:
+            self.dav__simpleifhandler(REQUEST, RESPONSE, refresh=1)
+        self.write(REQUEST.get('BODY', ''))
+        RESPONSE.setStatus(204)
+        return RESPONSE
+
+    manage_FTPput = PUT
+
+    def manage_FTPget(self):
+        "Get source for FTP download"
+        self.REQUEST.RESPONSE.setHeader('Content-Type', self.content_type)
+        return self.read()
+
+    def get_size(self):
+        return len(self.read())
+    getSize = get_size
+
+    def PrincipiaSearchSource(self):
+        "Support for searching - the document's contents are searched."
+        return self.read()
+
+    def document_src(self, REQUEST=None, RESPONSE=None):
+        """Return expanded document source."""
+
+        if RESPONSE is not None:
+            RESPONSE.setHeader('Content-Type', 'text/plain')
+        if REQUEST is not None and REQUEST.get('raw'):
+            return self._text
+        return self.read()
+
+    def om_icons(self):
+        """Return a list of icon URLs to be displayed by an ObjectManager"""
+        icons = ({'path': 'misc_/PageTemplates/zpt.gif',
+                  'alt': self.meta_type, 'title': self.meta_type},)
+        if not self._v_cooked:
+            self._cook()
+        if self._v_errors:
+            icons = icons + ({'path': 'misc_/PageTemplates/exclamation.gif',
+                              'alt': 'Error',
+                              'title': 'This template has an error'},)
+        return icons
+
+    def pt_source_file(self):
+        """Returns a file name to be compiled into the TAL code."""
+        try:
+            return '/'.join(self.getPhysicalPath())
+        except:
+            # This page template is being compiled without an
+            # acquisition context, so we don't know where it is. :-(
+            return None
+
+    if not SUPPORTS_WEBDAV_LOCKS:
+        def wl_isLocked(self):
+            return 0
+
+#setattr(ZopePageTemplate, 'source.xml',  ZopePageTemplate.source_dot_xml)
+#setattr(ZopePageTemplate, 'source.html', ZopePageTemplate.source_dot_xml)
+
+# Product registration and Add support
+manage_addZPTForm= PageTemplateFile(
+    'www/ptAdd', globals(), __name__='manage_addPageTemplateForm')
+
+from urllib import quote
 
 def manage_addZPT(self, id, title=None, text=None,
                            REQUEST=None, submit=None):
     "Add a Page Template with optional file content."
 
+    id = str(id)
+    if REQUEST is None:
         self._setObject(id, ZPT(id, text))
         ob = getattr(self, id)
-    REQUEST.RESPONSE.redirect(self.absolute_url() + '/manage_main')
+        if title:
+            ob.pt_setTitle(title)
+        return ob
+    else:
+        file = REQUEST.form.get('file')
+        headers = getattr(file, 'headers', None)
+        if headers is None or not file.filename:
+            zpt = ZPT(id, text) # collector 596
+        else:
+            zpt = ZPT(id, file, headers.get('content_type'))
 
+        self._setObject(id, zpt)
 
-manage_addZPTForm = PageTemplateFile(
-    'www/ptAdd', globals(), __name__='manage_addPageTemplateForm')
+        # collector 596
+        if title:
+            ob = getattr(self, id)
+            ob.pt_setTitle(title)
+
+        try:
+            u = self.DestinationURL()
+        except AttributeError:
+            u = REQUEST['URL1']
+
+        if submit == " Add and Edit ":
+            u = "%s/%s" % (u, quote(id))
+        REQUEST.RESPONSE.redirect(u+'/manage_main')
+    return ''
+
+from Products.PageTemplates import misc_
+misc_['exclamation.gif'] = ImageFile('www/exclamation.gif', globals())
 
 def initialize(context):
     context.registerClass(