[CMF-checkins] CVS: CMF/CMFCore - URLTool.py:1.2

[Yvo Schubbe]

Update of /cvs-repository/CMF/CMFCore
In directory cvs.zope.org:/tmp/cvs-serv7076/CMFCore

Added Files:
	URLTool.py 
Log Message:
Merged yuppie-collector067-branch:

- Moved URLTool to CMFCore. (Collector #67)


=== CMF/CMFCore/URLTool.py 1.1 => 1.2 ===
--- /dev/null	Wed Dec 11 17:22:19 2002
+++ CMF/CMFCore/URLTool.py	Wed Dec 11 17:21:49 2002
@@ -0,0 +1,99 @@
+##############################################################################
+#
+# Copyright (c) 2001 Zope Corporation and Contributors. All Rights Reserved.
+# 
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE
+# 
+##############################################################################
+""" CMFCore portal_url tool.
+
+$Id$
+"""
+
+from AccessControl import ClassSecurityInfo
+from Acquisition import aq_inner
+from Acquisition import aq_parent
+from Globals import DTMLFile
+from Globals import InitializeClass
+from OFS.SimpleItem import SimpleItem
+
+from ActionProviderBase import ActionProviderBase
+from CMFCorePermissions import ManagePortal
+from CMFCorePermissions import View
+from utils import _dtmldir
+from utils import UniqueObject
+
+from interfaces.portal_url import portal_url as IURLTool
+
+
+class URLTool(UniqueObject, SimpleItem, ActionProviderBase):
+    """ CMF URL Tool.
+    """
+
+    __implements__ = (IURLTool, ActionProviderBase.__implements__)
+
+    id = 'portal_url'
+    meta_type = 'CMF URL Tool'
+    _actions = []
+
+    security = ClassSecurityInfo()
+    security.declareObjectProtected(View)
+
+    manage_options = ( ActionProviderBase.manage_options
+                     + ( {'label':'Overview'
+                         ,'action':'manage_overview'}
+                       ,
+                       )
+                     + SimpleItem.manage_options
+                     )
+
+    #
+    #   ZMI methods
+    #
+    security.declareProtected(ManagePortal, 'manage_overview')
+    manage_overview = DTMLFile('explainURLTool', _dtmldir)
+
+    #
+    #   'portal_url' interface methods
+    #
+    security.declarePublic('__call__')
+    def __call__(self, relative=0, *args, **kw):
+        """ Get by default the absolute URL of the portal.
+        """
+        return self.getPortalObject().absolute_url(relative=relative)
+
+    security.declarePublic('getPortalObject')
+    def getPortalObject(self):
+        """ Get the portal object itself.
+        """
+        return aq_parent( aq_inner(self) )
+
+    security.declarePublic('getRelativeContentPath')
+    def getRelativeContentPath(self, content):
+        """ Get the path for an object, relative to the portal root.
+        """
+        portal_path_length = len( self.getPortalObject().getPhysicalPath() )
+        content_path = content.getPhysicalPath()
+        return content_path[portal_path_length:]
+
+    security.declarePublic('getRelativeContentURL')
+    def getRelativeContentURL(self, content):
+        """ Get the URL for an object, relative to the portal root.
+        """
+        return '/'.join( self.getRelativeContentPath(content) )
+
+    security.declarePublic('getRelativeUrl')
+    getRelativeUrl = getRelativeContentURL
+
+    security.declarePublic('getPortalPath')
+    def getPortalPath(self):
+        """ Get the portal object's URL without the server URL component.
+        """
+        return '/'.join( self.getPortalObject().getPhysicalPath() )
+
+InitializeClass(URLTool)