CMFPlone.PloneTool.PloneTool

Package CMFPlone :: Module PloneTool :: Class PloneTool

[show private | hide private]

Type PloneTool

              PloneBaseTool --+
                              |
         object --+           |
                  |           |
               Base --+       |
                      |       |
     object --+       |       |
              |       |       |
           Base --+   |       |
                  |   |       |
         CopySource --+       |
                      |       |
           Node --+   |       |
                  |   |       |
            Element --+       |
                      |       |
     object --+       |       |
              |       |       |
           Base --+   |       |
                  |   |       |
              Owned --+       |
                      |       |
     object --+       |       |
              |       |       |
           Base --+   |       |
                  |   |       |
EtagSupport --+   |   |       |
              |   |   |       |
   LockableItem --+   |       |
                  |   |       |
           Resource --+       |
                      |       |
     object --+       |       |
              |       |       |
           Base --+   |       |
                  |   |       |
               Tabs --+       |
                      |       |
        Traversable --+       |
                      |       |
     object --+       |       |
              |       |       |
           Base --+   |       |
                  |   |       |
        UndoSupport --+       |
                      |       |
                   Item --+   |
                          |   |
         object --+       |   |
                  |       |   |
               Base --+   |   |
                      |   |   |
         object --+   |   |   |
                  |   |   |   |
         Persistent --+   |   |
                      |   |   |
             Persistent --+   |
                          |   |
         object --+       |   |
                  |       |   |
               Base --+   |   |
                      |   |   |
        RoleManager --+   |   |
                      |   |   |
            RoleManager --+   |
                          |   |
         object --+       |   |
                  |       |   |
               Base --+   |   |
                      |   |   |
               Acquirer --+   |
                          |   |
                 SimpleItem --+
                              |
         object --+           |
                  |           |
               Base --+       |
                      |       |
            ImmutableId --+   |
                          |   |
               UniqueObject --+
                              |
                             PloneTool

Various utility methods.

Method Summary
	`acquireLocalRoles(self, obj, status)` If status is 1, allow acquisition of local roles (regular behaviour).
	`availableMIMETypes(self)` Returns a map of mimetypes.
	`bad_chars(self, id)` Returns a list of the Bad characters.
	`browserDefault(self, obj)` Sets default so we can return whatever we want instead of index_html.
	`changeOwnershipOf(self, object, owner, recursive)` Changes the ownership of an object.
	`contentEdit(self, obj, **kwargs)` Encapsulates how the editing of content occurs.
	`createBreadCrumbs(self, context)` Returns a structure for the portal breadcumbs.
	`createNavTree(self, context, sitemap)` Returns a structure that can be used by navigation_tree_slot.
	`createSitemap(self, context)` Returns a sitemap navtree structure.
	`createTopLevelTabs(self, actions)` Returns a structure for the top level tabs.
	`editMetadata(self, obj, allowDiscussion, title, subject, description, contributors, effective_date, expiration_date, format, language, rights, **kwargs)` Responsible for setting metadata on a content object.
	`exceptionString(self)`
	`getDefaultPage(self, obj)` Given a folderish item, find out if it has a default-page using the following lookup rules:
	`getDiscussionThread(self, discussionContainer)` Given a discussionContainer, return the thread it is in, upwards, including the parent object that is being discussed.
	`getEmptyTitle(self, translated)` Returns string to be used for objects with no title or id
	`getIconFor(self, category, id, default)` Cache point for actionicons.getActionIcon call.
	`getInheritedLocalRoles(self, here)` Returns a tuple with the acquired local roles.
	`getMailHost(self)` Gets the MailHost.
	`getMethodAliases(self, typeInfo)` Given an FTI, return the dict of method aliases defined on that FTI.
	`getOwnerName(self, obj)` Returns the userid of the owner of an object.
	`getReviewStateTitleFor(self, obj)` Utility method that gets the workflow state title for the object's review_state.
	`getSiteEncoding(self)` Get the default_charset or fallback to utf8.
	`getUserFriendlyTypes(self, typesList)` Get a list of types which are considered "user friendly" for search and selection purposes.
	`getWorkflowChainFor(self, object)` Proxy the request for the chain to the workflow tool, as this method is private there.
	`good_id(self, id)` Exposes ObjectManager's bad_id test to skin scripts.
	`isDefaultPage(self, obj)` Finds out if the given obj is the default page in its parent folder.
	`isIDAutoGenerated(self, id)` Determine if an id is autogenerated
	`isLocalRoleAcquired(self, obj)` Returns local role acquisition blocking status.
	`isStructuralFolder(self, obj)` Checks if a given object is a "structural folder".
	`isTranslatable(self, obj)` Checks if a given object implements the ITranslatable interface.
	`listMetaTags(self, context)` Lists meta tags helper.
	`logException(self)` Dumps most recent exception to the log.
	`normalizeString(self, text)` Normalizes a title to an id.
	`portal_utf8(self, str, errors)` Transforms an string in portal encoding to utf8.
	`pretty_title_or_id(self, obj, empty_value)` Return the best possible title or id of an item, regardless of whether obj is a catalog brain or an object, but returning an empty title marker if the id is not set (i.e.
	`reindexOnReorder(self, parent)` Catalog ordering support
	`sendto(self, send_to_address, send_from_address, comment, subject, **kwargs)` Sends a link of a page to someone.
	`setCurrentSkin(self, skin_name)` Sets the current skin.
	`setDefaultSkin(self, default_skin)` Sets the default skin.
	`setMemberProperties(self, member, **properties)`
	`typesToList(self)`
	`urlparse(self, url)` Returns the pieces of url in a six-part tuple.
	`urlunparse(self, url_tuple)` Puts a url back together again, in the manner that urlparse breaks it.
	`utf8_portal(self, str, errors)` Transforms an utf8 string to portal encoding.
	`validateEmailAddresses(self, addresses)` Validate a list of possibly several email addresses, see also validateSingleEmailAddress.
	`validateSingleEmailAddress(self, address)` Validate a single email address, see also validateEmailAddresses.
	`validateSingleNormalizedEmailAddress(self, address)` Lower-level function to validate a single normalized email address, see validateEmailAddress.
Inherited from Item
	`__len__(self)`
	`__repr__(self)` Show the physical path of the object and its context if available.
	`analyseDocumentation(self, object, type, filter)`
	`getId(self)` Return the id of the object as a string.
	`manage(self, URL1)`
	`manage_afterAdd(self, item, container)`
	`manage_afterClone(self, item)`
	`manage_beforeDelete(self, item, container)`
	`manage_editedDialog(self, REQUEST, **args)`
	`manage_FTPlist(self, REQUEST)` Directory listing for FTP.
	`manage_FTPstat(self, REQUEST)` Psuedo stat, used by FTP for directory listings.
	`objectIds(self, spec)`
	`objectItems(self, spec)`
	`objectValues(self, spec)`
	`raise_standardErrorMessage(self, client, REQUEST, error_type, error_value, tb, error_tb, error_message, tagSearch, error_log_url)`
	`this(self)`
	`title_and_id(self)` Return the title if it is not blank and the id otherwise.
	`title_or_id(self)` Return the title if it is not blank and the id otherwise.
	`tpURL(self)`
	`tpValues(self)`
Inherited from Resource
	`COPY(self, REQUEST, RESPONSE)` Create a duplicate of the source resource whose state and behavior match that of the source resource as closely as possible.
	`dav__init(self, request, response)`
	`dav__simpleifhandler(self, request, response, method, col, url, refresh)`
	`dav__validate(self, object, methodname, REQUEST)`
	`DELETE(self, REQUEST, RESPONSE)` Delete a resource.
	`HEAD(self, REQUEST, RESPONSE)` Retrieve resource information without a response body.
	`listDAVObjects(self)`
	`LOCK(self, REQUEST, RESPONSE)` Lock a resource
	`manage_DAVget(self)` Gets the document source
	`MKCOL(self, REQUEST, RESPONSE)` Create a new collection resource.
	`MOVE(self, REQUEST, RESPONSE)` Move a resource to a new location.
	`OPTIONS(self, REQUEST, RESPONSE)` Retrieve communication options.
	`PROPFIND(self, REQUEST, RESPONSE)` Retrieve properties defined on the resource.
	`PROPPATCH(self, REQUEST, RESPONSE)` Set and/or remove properties defined on the resource.
	`PUT(self, REQUEST, RESPONSE)` Replace the GET response entity of an existing resource.
	`TRACE(self, REQUEST, RESPONSE)` Return the HTTP message received back to the client as the entity-body of a 200 (OK) response.
	`UNLOCK(self, REQUEST, RESPONSE)` Remove an existing lock on a resource.
Inherited from LockableItem
	`wl_clearLocks(self)`
	`wl_delLock(self, locktoken)`
	`wl_getLock(self, locktoken)`
	`wl_hasLock(self, token, killinvalids)`
	`wl_isLocked(self)`
	`wl_lockItems(self, killinvalids)`
	`wl_lockmapping(self, killinvalids, create)` if 'killinvalids' is 1, locks who are no longer valid will be deleted
	`wl_lockTokens(self, killinvalids)`
	`wl_lockValues(self, killinvalids)`
	`wl_setLock(self, locktoken, lock)`
Inherited from EtagSupport
	`http__etag(self, readonly)`
	`http__parseMatchList(self, REQUEST, header)`
	`http__processMatchHeaders(self, REQUEST)`
	`http__refreshEtag(self)`
Inherited from CopySource
	`cb_isCopyable(self)`
	`cb_isMoveable(self)`
	`cb_userHasCopyOrMovePermission(self)`
Inherited from Tabs
	`_old_filtered_manage_options(self, REQUEST)`
	`class_manage_path(self)`
	`filtered_manage_options(self, REQUEST)`
	`manage_workspace(self, REQUEST)` Dispatch to first interface in manage_options
	`tabs_path_default(self, REQUEST, unquote)`
	`tabs_path_info(self, script, path, quote)`
Inherited from Traversable
	`absolute_url(self, relative)` Return the absolute URL of the object.
	`absolute_url_path(self)` Return the path portion of the absolute URL of the object.
	`getPhysicalPath(self)` Get the physical path of the object.
	`restrictedTraverse(self, path, default)`
	`unrestrictedTraverse(self, path, default, restricted)` Lookup an object by path.
	`virtual_url_path(self)` Return a URL for the object, relative to the site root.
Inherited from Element
	`getAttribute(self, name)` Retrieves an attribute value by name.
	`getAttributeNode(self, name)` Retrieves an Attr node by name or None if there is no such attribute.
	`getChildNodes(self)` Returns a NodeList that contains all children of this node.
	`getElementsByTagName(self, tagname)` Returns a NodeList of all the Elements with a given tag name in the order in which they would be encountered in a preorder traversal of the Document tree.
	`getFirstChild(self)` The first child of this node.
	`getLastChild(self)` The last child of this node.
	`getNextSibling(self)` The node immediately preceding this node.
	`getNodeName(self)` The name of this node, depending on its type
	`getNodeType(self)` A code representing the type of the node.
	`getParentNode(self)` The parent of this node.
	`getPreviousSibling(self)` The node immediately preceding this node.
	`getTagName(self)` The name of the element
Inherited from Node
	`getAttributes(self)` Returns a NamedNodeMap containing the attributes of this node (if it is an element) or None otherwise.
	`getNodeValue(self)` The value of this node, depending on its type
	`getOwnerDocument(self)` The Document object associated with this node.
	`hasChildNodes(self)` Returns true if the node has any children, false if it doesn't.
Inherited from Owned
	`changeOwnership(self, user, recursive)` Change the ownership to the given user.
	`getOwner(self, info, aq_get, UnownableOwner, getSecurityManager)` Get the owner
	`getOwnerTuple(self)` Return a tuple, (userdb_path, user_id) for the owner.
	`getWrappedOwner(self)` Get the owner, modestly wrapped in the user folder.
	`manage_changeOwnershipType(self, explicit, RESPONSE, REQUEST)` Change the type (implicit or explicit) of ownership.
	`manage_fixupOwnershipAfterAdd(self)`
	`manage_takeOwnership(self, REQUEST, RESPONSE, recursive)` Take ownership (responsibility) for an object.
	`owner_info(self)` Get ownership info for display
	`userCanTakeOwnership(self)`
Inherited from UndoSupport
	`get_request_var_or_attr(self, name, default)`
	`manage_undo_transactions(self, transaction_info, REQUEST)`
	`undoable_transactions(self, first_transaction, last_transaction, PrincipiaUndoBatchSize)`
Inherited from Persistent
	`__class_init__(self)`
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`bobobase_modification_time(self)`
	`locked_in_version(self)` Was the object modified in any version?
	`modified_in_version(self)` Was the object modified in this version?
Inherited from Persistent
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getstate__(...)` Get the object serialization state
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` Reduce an object to contituent parts for serialization
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__setstate__(...)` Set the object serialization state The state should be in one of 3 forms: - None Ignored - A dictionary In this case, the object's instance dictionary will be cleared and updated with the new state.
Inherited from RoleManager
	`ac_inherited_permissions(self, all)`
	`access_debug_info(self)` Return debug info.
	`acquiredRolesAreUsedBy(self, permission)` Used by management screen.
	`get_local_roles(self)`
	`get_local_roles_for_userid(self, userid)`
	`get_valid_userids(self)`
	`has_local_roles(self)`
	`manage_access(self, REQUEST, **kw)` Return an interface for making permissions settings.
	`manage_acquiredPermissions(self, permissions, REQUEST)` Change the permissions that acquire.
	`manage_addLocalRoles(self, userid, roles, REQUEST)` Set local roles for a user.
	`manage_changePermissions(self, REQUEST)` Change all permissions settings, called by management screen.
	`manage_defined_roles(self, submit, REQUEST)` Called by management screen.
	`manage_delLocalRoles(self, userids, REQUEST)` Remove all local roles for a user.
	`manage_editRoles(self, REQUEST, acl_type, acl_roles)`
	`manage_permission(self, permission_to_manage, roles, acquire, REQUEST)` Change the settings for the given permission.
	`manage_role(self, role_to_manage, permissions, REQUEST)` Change the permissions given to the given role.
	`manage_setLocalRoles(self, userid, roles, REQUEST)` Set local roles for a user.
	`permission_settings(self, permission)` Return user-role permission settings.
	`permissionsOfRole(self, role)` Used by management screen.
	`possible_permissions(self)`
	`rolesOfPermission(self, permission)` Used by management screen.
	`userdefined_roles(self)` Return list of user-defined roles.
	`users_with_local_role(self, role)`
	`valid_roles(self)` Return list of valid roles.
	`validate_roles(self, roles)` Return true if all given roles are valid.
	`validRoles(self)` Return list of valid roles.
Inherited from RoleManager
	`manage_getPermissionMapping(self)` Return the permission mapping for the object This is a list of dictionaries with: permission_name -- The name of the native object permission class_permission -- The class permission the permission is mapped to.
	`manage_setPermissionMapping(self, permission_names, class_permissions, REQUEST)` Change the permission mapping
Inherited from Base
	`__getnewargs__(...)` Get arguments to be passed to __new__
Inherited from object
	`__init__(...)` x.__init__(...) initializes x; see x.__class__.__doc__ for signature
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__reduce_ex__(...)` helper for pickle
	`__str__(x)` x.__str__() <==> str(x)

Class Variable Summary
`tuple`	`__ac_permissions__` = `(('Access contents information', ('...`
`tuple`	`__implements__` = `(<Interface Products.CMFPlone.interface...`
`NoneType`	`acquireLocalRoles__roles__` = None
`NoneType`	`availableMIMETypes__roles__` = None
`NoneType`	`bad_chars__roles__` = None
`NoneType`	`browserDefault__roles__` = None
`PermissionRole`	`changeOwnershipOf__roles__` = `<PermissionRole object at 0...`
`NoneType`	`contentEdit__roles__` = None
`NoneType`	`createBreadCrumbs__roles__` = None
`NoneType`	`createNavTree__roles__` = None
`NoneType`	`createSitemap__roles__` = None
`NoneType`	`createTopLevelTabs__roles__` = None
`NoneType`	`editMetadata__roles__` = None
`str`	`field_prefix` = `'field_'`
`NoneType`	`getDefaultPage__roles__` = None
`PermissionRole`	`getDiscussionThread__roles__` = `<PermissionRole object at...`
`NoneType`	`getEmptyTitle__roles__` = None
`PermissionRole`	`getIconFor__roles__` = `<PermissionRole object at 0xb47661...`
`NoneType`	`getInheritedLocalRoles__roles__` = None
`tuple`	`getMailHost__roles__` = `()`
`NoneType`	`getMethodAliases__roles__` = None
`NoneType`	`getOwnerName__roles__` = None
`PermissionRole`	`getReviewStateTitleFor__roles__` = `<PermissionRole object...`
`NoneType`	`getSiteEncoding__roles__` = None
`NoneType`	`getUserFriendlyTypes__roles__` = None
`PermissionRole`	`getWorkflowChainFor__roles__` = `<PermissionRole object at...`
`NoneType`	`good_id__roles__` = None
`str`	`id` = `'plone_utils'`
`NoneType`	`isDefaultPage__roles__` = None
`NoneType`	`isIDAutoGenerated__roles__` = None
`NoneType`	`isLocalRoleAcquired__roles__` = None
`NoneType`	`isStructuralFolder__roles__` = None
`NoneType`	`isTranslatable__roles__` = None
`NoneType`	`listMetaTags__roles__` = None
`str`	`meta_type` = `'Plone Utility Tool'`
`NoneType`	`normalizeString__roles__` = None
`int`	`plone_tool` = 1
`NoneType`	`portal_utf8__roles__` = None
`NoneType`	`pretty_title_or_id__roles__` = None
`NoneType`	`reindexOnReorder__roles__` = None
`PermissionRole`	`sendto__roles__` = `<PermissionRole object at 0xb4766d88>`
`NoneType`	`setCurrentSkin__roles__` = None
`PermissionRole`	`setDefaultSkin__roles__` = `<PermissionRole object at 0xb4...`
`PermissionRole`	`setMemberProperties__roles__` = `<PermissionRole object at...`
`str`	`toolicon` = `'skins/plone_images/site_icon.gif'`
`PermissionRole`	`typesToList__roles__` = `<PermissionRole object at 0xb4766...`
`NoneType`	`urlparse__roles__` = None
`NoneType`	`urlunparse__roles__` = None
`NoneType`	`utf8_portal__roles__` = None
`NoneType`	`validateEmailAddresses__roles__` = None
`NoneType`	`validateSingleEmailAddress__roles__` = None
`NoneType`	`validateSingleNormalizedEmailAddress__roles__` = None
Inherited from UniqueObject
`Implements`	`__implemented__` = `<implementedBy Products.CMFCore.utils....`
`ClassProvides`	`__provides__` = `<zope.interface.declarations.ClassProvide...`
`int`	`__replaceable__` = 2
Inherited from ImmutableId
`ClassProvides`	`__providedBy__` = `<zope.interface.declarations.ClassProvi...`
Inherited from SimpleItem
`tuple`	`manage_options` = `({'action': 'manage_UndoForm', 'help': ...`
Inherited from Item
`int`	`__allow_access_to_unprotected_subobjects__` = 1
`str`	`__name__` = `'Item'`
`tuple`	`__propsets__` = `()`
`PermissionRole`	`analyseDocumentation__roles__` = `<PermissionRole object a...`
`NoneType`	`getId__roles__` = None
`str`	`icon` = `''`
`int`	`isPrincipiaFolderish` = 0
`int`	`isTopLevelPrincipiaApplicationObject` = 0
`tuple`	`manage__roles__` = `('Manager',)`
`tuple`	`manage_afterAdd__roles__` = `('Manager',)`
`tuple`	`manage_afterClone__roles__` = `('Manager',)`
`tuple`	`manage_beforeDelete__roles__` = `('Manager',)`
`tuple`	`manage_editedDialog__roles__` = `('Manager',)`
`tuple`	`manage_FTPlist__roles__` = `('Manager',)`
`tuple`	`manage_FTPstat__roles__` = `('Manager',)`
`str`	`REQUEST` = `'<Special Object Used to Force Acquisition>'`
`ClassicHTMLFile`	`showDocumentation` = `<App.special_dtml.ClassicHTMLFile ob...`
`PermissionRole`	`showDocumentation__roles__` = `<PermissionRole object at 0...`
`str`	`title` = `''`
Inherited from Resource
`int`	`__dav_resource__` = 1
`tuple`	`__http_methods__` = `('GET', 'HEAD', 'POST', 'PUT', 'DELET...`
`tuple`	`COPY__roles__` = `('Anonymous',)`
`PermissionRole`	`DELETE__roles__` = `<PermissionRole object at 0xb7457188>`
`PermissionRole`	`HEAD__roles__` = `<PermissionRole object at 0xb7457140>`
`PermissionRole`	`listDAVObjects__roles__` = `<PermissionRole object at 0xb7...`
`PermissionRole`	`LOCK__roles__` = `<PermissionRole object at 0xb74571a0>`
`PermissionRole`	`manage_DAVget__roles__` = `<PermissionRole object at 0xb74...`
`tuple`	`MOVE__roles__` = `('Anonymous',)`
`NoneType`	`OPTIONS__roles__` = None &