From: alecm <svn...@pl...> - 2006-09-02 21:14:13
|
Author: alecm Date: Sat Sep 2 21:14:06 2006 New Revision: 10760 Modified: CMFPlone/branches/2.5/TranslationServiceTool.py CMFPlone/branches/2.5/browser/interfaces.py Log: Fix a silly DOS formatted file and some security declarations Modified: CMFPlone/branches/2.5/TranslationServiceTool.py ============================================================================== --- CMFPlone/branches/2.5/TranslationServiceTool.py (original) +++ CMFPlone/branches/2.5/TranslationServiceTool.py Sat Sep 2 21:14:06 2006 @@ -120,7 +120,7 @@ """ return 'a' == format and monthname_msgid_abbr(number) or monthname_msgid(number) - security.declarePublic('monthname_english') + security.declarePublic('month_english') def month_english(self, number, format=''): """ Returns the english name of month by number. Format is either '' or 'a' (long or abbreviation). @@ -135,7 +135,7 @@ """ return monthname_english(number, format=format) - security.declarePublic('weekdayname_english') + security.declarePublic('weekday_english') def weekday_english(self, number, format=''): """ Returns the english name of a week by number. Format is either '', 'a' or 'p'. Modified: CMFPlone/branches/2.5/browser/interfaces.py ============================================================================== --- CMFPlone/branches/2.5/browser/interfaces.py (original) +++ CMFPlone/branches/2.5/browser/interfaces.py Sat Sep 2 21:14:06 2006 @@ -1,425 +1,425 @@ -from zope.interface import Interface, Attribute - - -class IDefaultPage(Interface): - - def isDefaultPage(obj): - """Finds out if the given obj is the default page for the - adapted object. - """ - - def getDefaultPage(): - """Returns the id of the default page for the adapted object. - """ - -class INavigationQueryBuilder(Interface): - """An object which returns a catalog query when called""" - def __call__(): - """Returns a mapping describing a catalog query used to build a - navigation structure. - """ - -class INavtreeStrategy(Interface): - - rootPath = Attribute("The path to the root of the navtree (None means use portal root)") - - showAllParents = Attribute("Whether or not to show all parents of the current context always") - - def nodeFilter(node): - """Return True or False to determine whether to include the given node - in the tree. Nodes are dicts with at least one key - 'item', the - catalog brain of the object the node represents. - """ - - def subtreeFilter(node): - """Return True or False to determine whether to expand the given - (folderish) node - """ - - def decoratorFactory(node): - """Inject any additional keys in the node that are needed and return - the new node. - """ - -class INavigationBreadcrumbs(Interface): - - def breadcrumbs(): - """Breadcrumbs for Navigation. - """ - -class INavigationTabs(Interface): - - def topLevelTabs(actions=None, category='portal_tabs'): - """Top level tabs - """ - -class INavigationTree(Interface): - - def navigationTreeRootPath(): - """Get the path to the root of the navigation tree - """ - - def navigationTree(): - """Navigation tree - """ - -class ISiteMap(Interface): - - def siteMap(): - """Site map - """ - -class INavigationRoot(Interface): - """A marker interface for signaling the navigation root. - """ - -class INavigationPortlet(Interface): - """Interface for portlet to display navigation tree""" - - def title(): - """The title of the navigation portlet (may be '' to fall back on default)""" - - def display(): - """Whether or not the navtree should be displayed""" - - def includeTop(): - """Whether or not to include the root element in the tree""" - - def navigationRoot(): - """Get the root object""" - - def rootTypeName(): - """Get a normalized content type name for the root object""" - - def createNavTree(): - """Build the actual tree""" - - def isPortalOrDefaultChild(): - """Determine if the context is the portal or a default-document""" - -class INewsPortlet(Interface): - """Interface for portlet to display recent news items""" - - def published_news_items(): - """Returns 5 most recently published News Items in reverse - chronological order - """ - - def all_news_link(): - """Returns URL, relative to the portal, of a page that display all - published News Items - """ - - -class IEventsPortlet(Interface): - """Interface for portlet to display recent news items""" - - def published_events(): - """Returns 5 most recently published News Items in reverse - chronological order - """ - - def all_events_link(): - """Returns URL, relative to the portal, of a page that display all - published News Items - """ - - def prev_events_link(): - """Returns URL, relative to the portal, of a page that display all - past events. - """ - - -class IRecentPortlet(Interface): - """Interface for portlet to display recently modified items""" - - def results(): - """Get the list of recently modified items""" - - -class ICalendarPortlet(Interface): - - def DateTime(): - """ """ - - def current(): - """ """ - - def current_day(): - """ """ - - def nextYearMax(): - """ """ - - def prevYearMin(): - """ """ - - def year(): - """ """ - - def month(): - """ """ - - def prevMonthTime(): - """ """ - - def nextMonthTime(): - """ """ - - def weeks(): - """ """ - - def showStates(): - """ """ - - def showPrevMonth(): - """ """ - - def showNextMonth(): - """ """ - - def getYearAndMonthToDisplay(): - """ """ - - def getPreviousMonth(month, year): - """ """ - - def getNextMonth(month, year): - """ """ - - def getWeekdays(self): - """Returns a list of Messages for the weekday names.""" - - def getEnglishMonthName(self, month): - """Returns the English month name.""" - - def getMonthName(self, month): - """Returns the month name as a Message.""" - - def isToday(self, day): - """Returns True if the given day and the current month and year equals - today, otherwise False. - """ - - -class ISitemapView(Interface): - """Interface to the view that creates a site map""" - - def createSiteMap(): - """Create the site map data structure""" - - -class IPlone(Interface): - """ """ - - - def globalize(): - """ A method which puts all of the following view attributes into the - globals of the current tal expression context (plus the - toLocalizedTime method): - - portal = Attribute("The portal object itself") - - portal_url = Attribute("The portal url") - - mtool = Attribute("The portal_membership tool") - - putils = Attribute("The plone_utils tool (PloneTool)") - - wtool = Attribute("The portal_workflow tool") - - ifacetool = Attribute("The portal_interface tool") - - syntool = Attribute("The portal_syndication tool") - - portal_title = Attribute("The title of the portal") - - object_title = Attribute("The title of the current object (context)") - - member = Attribute("The member object for the authenticated user in " - "context") - - checkPermission = Attribute("The checkPermission method of the membership" - " tool") - - membersfolder = Attribute("The portal's Members folder") - - isAnon = Attribute("Boolean indicating whether the current user is " - "anonymous") - - actions = Attribute("The result of listFilteredActionsFor(context) in the " - "portal_actions tool") - - keyed_actions = Attribute("A mapping of action categories to action ids " - "to action information: " - "mapping[cat][id] == actioninfo") - - user_actions = Attribute("Actions in the user category") - - workflow_actions = Attribute("Actions in the workflow category") - - folder_actions = Attribute("Actions in the folder category") - - global_actions = Attribute("Actions in the global category") - - portal_tabs = Attribute("The actions for the portal tabs") - - wf_state = Attribute("The review_state of the current object") - - portal_properties = Attribute("The portal_properties tool") - - site_properties = Attribute("The site_properties tool") - - ztu = Attribute("The ZTUtils module") - - isFolderish = Attribute("A boolean indicating whether the object is " - "folderish") - - slots_mapping = Attribute("A mapping containing a list of macros or " - "expressions for each slot") - - here_url = Attribute("The url of the current object") - - sl = Attribute("The elements in the left slot") - - sr = Attribute("The elements in the right slot") - - default_language = Attribute("The default language of the portal") - - language = Attribute("The language of the current request or context.") - - is_editable = Attribute("A boolean indicating if the current user has " - " edit permissions in this context") - - isLocked = Attribute("A boolean indicating that the object is webdav " - "locked") - - isRTL = Attribute("A boolean indicating that the current language is a " - "right-to-left language.") - - visible_ids = Attribute("A boolean indicating whether to show object ids " - "to the current user") - - current_page_url = Attribute("The full url with query string") - - isContextDefaultPage = Attribure("Boolean idicating that the context is " - "the default page of its parent folder.") - - isStructuralFolder = Attribute("Boolean indicating that the context is a " - "'Structural Folder'.") - - Iterator = Attribute("A factory for generating sinple integer Iterators.") - - tabindex = Attribute("An iterator for use in creating tabindexes.") - - uniqueItemIndex = Attribute("An iterator for help inc reading unique " - "html ids.") - - # BBB: deprecated elements - utool = Attribute("The portal_url tool") - portal_object = Attribute("A deprecated spelling of portal") - atool = Attribute("The portal_actions tool") - aitool = Attribute("The portal_actionicons tool") - gtool = Attribute("The portal_groups tool") - gdtool = Attribute("The portal_groupdata tool") - wf_actions = Attribute("A deprecated variant of workflow_actions") - hidecolumns = Attribute("The css class to use for the column container" - "which determines which columns to show") - isEditable = Attribute("A deprecated spelling of is_editable") - lockable = Attribute("A boolean indicating that the object capable of" - " being webdav locked") - """ - - def getCurrentUrl(): - """ Returns the actual url plus the query string. """ - - def keyFilteredActions(actions=None): - """ Returns a mapping of action categories to action ids to action - information: mapping[cat][id] == actioninfo - - Optionally takes an action list, if ommitted it will be calculated - """ - - def visibleIdsEnabled(): - """Determines whether to show object ids based on portal and user - settings. - """ - - def isRightToLeft(domain='plone'): - """Is the currently selected language a right to left language""" - - def toLocalizedTime(time, long_format=None): - """ The time parameter must be either a string that is suitable for - initializing a DateTime or a DateTime object. Returns a localized - string. - """ - - def isDefaultPageInFolder(): - """ Returns a boolean indicating whether the current context is the - default page of its parent folder. - """ - - def isStructuralFolder(): - """Checks if a given object is a "structural folder". - - That is, a folderish item which does not explicitly implement - INonStructuralFolder to declare that it doesn't wish to be treated - as a folder by the navtree, the tab generation etc. - """ - - def hide_columns(self, column_left, column_right): - """ Returns the CSS class used by the page layout hide empty - portlet columns. - """ - - def navigationRootPath(): - """Get the current navigation root path - """ - - def navigationRootUrl(): - """Get the url to the current navigation root - """ - - def getParentObject(): - """Returns the parent of the current object, equivalent to - aq_inner(aq_parent(context)), or context.aq_inner.getParentNode() - """ - - def getCurrentFolder(): - """If the context is the default page of a folder or is not itself a - folder, the parent is returned, otherwise the object itself is - returned. This is useful for providing a context for methods - which wish to act on what is considered the current folder in the - ui. - """ - - def getCurrentFolderUrl(): - """Returns the URL of the current folder as determined by - self.getCurrentFolder(), used heavily in actions. - """ - - def getCurrentObjectUrl(): - """Returns the URL of the current object unless that object is a - folder default page, in which case it returns the parent. - """ - - def isFolderOrFolderDefaultPage(): - """Returns true only if the current object is either a folder (as - determined by isStructuralFolder) or the default page in context. - """ - - def isPortalOrPortalDefaultPage(): - """Returns true only if the current object is either the portal object - or the default page of the portal. - """ - - def getViewTemplateId(): - """Returns the template Id corresponding to the default view method of - the context object. - """ - - def displayContentsTab(): - """Returns true if the contents tab should be displayed in the current - context. Evaluates whether the object is a folder or the default - page of a folder, and checks if the user has relevant permissions. - """ +from zope.interface import Interface, Attribute + + +class IDefaultPage(Interface): + + def isDefaultPage(obj): + """Finds out if the given obj is the default page for the + adapted object. + """ + + def getDefaultPage(): + """Returns the id of the default page for the adapted object. + """ + +class INavigationQueryBuilder(Interface): + """An object which returns a catalog query when called""" + def __call__(): + """Returns a mapping describing a catalog query used to build a + navigation structure. + """ + +class INavtreeStrategy(Interface): + + rootPath = Attribute("The path to the root of the navtree (None means use portal root)") + + showAllParents = Attribute("Whether or not to show all parents of the current context always") + + def nodeFilter(node): + """Return True or False to determine whether to include the given node + in the tree. Nodes are dicts with at least one key - 'item', the + catalog brain of the object the node represents. + """ + + def subtreeFilter(node): + """Return True or False to determine whether to expand the given + (folderish) node + """ + + def decoratorFactory(node): + """Inject any additional keys in the node that are needed and return + the new node. + """ + +class INavigationBreadcrumbs(Interface): + + def breadcrumbs(): + """Breadcrumbs for Navigation. + """ + +class INavigationTabs(Interface): + + def topLevelTabs(actions=None, category='portal_tabs'): + """Top level tabs + """ + +class INavigationTree(Interface): + + def navigationTreeRootPath(): + """Get the path to the root of the navigation tree + """ + + def navigationTree(): + """Navigation tree + """ + +class ISiteMap(Interface): + + def siteMap(): + """Site map + """ + +class INavigationRoot(Interface): + """A marker interface for signaling the navigation root. + """ + +class INavigationPortlet(Interface): + """Interface for portlet to display navigation tree""" + + def title(): + """The title of the navigation portlet (may be '' to fall back on default)""" + + def display(): + """Whether or not the navtree should be displayed""" + + def includeTop(): + """Whether or not to include the root element in the tree""" + + def navigationRoot(): + """Get the root object""" + + def rootTypeName(): + """Get a normalized content type name for the root object""" + + def createNavTree(): + """Build the actual tree""" + + def isPortalOrDefaultChild(): + """Determine if the context is the portal or a default-document""" + +class INewsPortlet(Interface): + """Interface for portlet to display recent news items""" + + def published_news_items(): + """Returns 5 most recently published News Items in reverse + chronological order + """ + + def all_news_link(): + """Returns URL, relative to the portal, of a page that display all + published News Items + """ + + +class IEventsPortlet(Interface): + """Interface for portlet to display recent news items""" + + def published_events(): + """Returns 5 most recently published News Items in reverse + chronological order + """ + + def all_events_link(): + """Returns URL, relative to the portal, of a page that display all + published News Items + """ + + def prev_events_link(): + """Returns URL, relative to the portal, of a page that display all + past events. + """ + + +class IRecentPortlet(Interface): + """Interface for portlet to display recently modified items""" + + def results(): + """Get the list of recently modified items""" + + +class ICalendarPortlet(Interface): + + def DateTime(): + """ """ + + def current(): + """ """ + + def current_day(): + """ """ + + def nextYearMax(): + """ """ + + def prevYearMin(): + """ """ + + def year(): + """ """ + + def month(): + """ """ + + def prevMonthTime(): + """ """ + + def nextMonthTime(): + """ """ + + def weeks(): + """ """ + + def showStates(): + """ """ + + def showPrevMonth(): + """ """ + + def showNextMonth(): + """ """ + + def getYearAndMonthToDisplay(): + """ """ + + def getPreviousMonth(month, year): + """ """ + + def getNextMonth(month, year): + """ """ + + def getWeekdays(self): + """Returns a list of Messages for the weekday names.""" + + def getEnglishMonthName(self, month): + """Returns the English month name.""" + + def getMonthName(self, month): + """Returns the month name as a Message.""" + + def isToday(self, day): + """Returns True if the given day and the current month and year equals + today, otherwise False. + """ + + +class ISitemapView(Interface): + """Interface to the view that creates a site map""" + + def createSiteMap(): + """Create the site map data structure""" + + +class IPlone(Interface): + """ """ + + + def globalize(): + """ A method which puts all of the following view attributes into the + globals of the current tal expression context (plus the + toLocalizedTime method): + + portal = Attribute("The portal object itself") + + portal_url = Attribute("The portal url") + + mtool = Attribute("The portal_membership tool") + + putils = Attribute("The plone_utils tool (PloneTool)") + + wtool = Attribute("The portal_workflow tool") + + ifacetool = Attribute("The portal_interface tool") + + syntool = Attribute("The portal_syndication tool") + + portal_title = Attribute("The title of the portal") + + object_title = Attribute("The title of the current object (context)") + + member = Attribute("The member object for the authenticated user in " + "context") + + checkPermission = Attribute("The checkPermission method of the membership" + " tool") + + membersfolder = Attribute("The portal's Members folder") + + isAnon = Attribute("Boolean indicating whether the current user is " + "anonymous") + + actions = Attribute("The result of listFilteredActionsFor(context) in the " + "portal_actions tool") + + keyed_actions = Attribute("A mapping of action categories to action ids " + "to action information: " + "mapping[cat][id] == actioninfo") + + user_actions = Attribute("Actions in the user category") + + workflow_actions = Attribute("Actions in the workflow category") + + folder_actions = Attribute("Actions in the folder category") + + global_actions = Attribute("Actions in the global category") + + portal_tabs = Attribute("The actions for the portal tabs") + + wf_state = Attribute("The review_state of the current object") + + portal_properties = Attribute("The portal_properties tool") + + site_properties = Attribute("The site_properties tool") + + ztu = Attribute("The ZTUtils module") + + isFolderish = Attribute("A boolean indicating whether the object is " + "folderish") + + slots_mapping = Attribute("A mapping containing a list of macros or " + "expressions for each slot") + + here_url = Attribute("The url of the current object") + + sl = Attribute("The elements in the left slot") + + sr = Attribute("The elements in the right slot") + + default_language = Attribute("The default language of the portal") + + language = Attribute("The language of the current request or context.") + + is_editable = Attribute("A boolean indicating if the current user has " + " edit permissions in this context") + + isLocked = Attribute("A boolean indicating that the object is webdav " + "locked") + + isRTL = Attribute("A boolean indicating that the current language is a " + "right-to-left language.") + + visible_ids = Attribute("A boolean indicating whether to show object ids " + "to the current user") + + current_page_url = Attribute("The full url with query string") + + isContextDefaultPage = Attribure("Boolean idicating that the context is " + "the default page of its parent folder.") + + isStructuralFolder = Attribute("Boolean indicating that the context is a " + "'Structural Folder'.") + + Iterator = Attribute("A factory for generating sinple integer Iterators.") + + tabindex = Attribute("An iterator for use in creating tabindexes.") + + uniqueItemIndex = Attribute("An iterator for help inc reading unique " + "html ids.") + + # BBB: deprecated elements + utool = Attribute("The portal_url tool") + portal_object = Attribute("A deprecated spelling of portal") + atool = Attribute("The portal_actions tool") + aitool = Attribute("The portal_actionicons tool") + gtool = Attribute("The portal_groups tool") + gdtool = Attribute("The portal_groupdata tool") + wf_actions = Attribute("A deprecated variant of workflow_actions") + hidecolumns = Attribute("The css class to use for the column container" + "which determines which columns to show") + isEditable = Attribute("A deprecated spelling of is_editable") + lockable = Attribute("A boolean indicating that the object capable of" + " being webdav locked") + """ + + def getCurrentUrl(): + """ Returns the actual url plus the query string. """ + + def keyFilteredActions(actions=None): + """ Returns a mapping of action categories to action ids to action + information: mapping[cat][id] == actioninfo + + Optionally takes an action list, if ommitted it will be calculated + """ + + def visibleIdsEnabled(): + """Determines whether to show object ids based on portal and user + settings. + """ + + def isRightToLeft(domain='plone'): + """Is the currently selected language a right to left language""" + + def toLocalizedTime(time, long_format=None): + """ The time parameter must be either a string that is suitable for + initializing a DateTime or a DateTime object. Returns a localized + string. + """ + + def isDefaultPageInFolder(): + """ Returns a boolean indicating whether the current context is the + default page of its parent folder. + """ + + def isStructuralFolder(): + """Checks if a given object is a "structural folder". + + That is, a folderish item which does not explicitly implement + INonStructuralFolder to declare that it doesn't wish to be treated + as a folder by the navtree, the tab generation etc. + """ + + def hide_columns(self, column_left, column_right): + """ Returns the CSS class used by the page layout hide empty + portlet columns. + """ + + def navigationRootPath(): + """Get the current navigation root path + """ + + def navigationRootUrl(): + """Get the url to the current navigation root + """ + + def getParentObject(): + """Returns the parent of the current object, equivalent to + aq_inner(aq_parent(context)), or context.aq_inner.getParentNode() + """ + + def getCurrentFolder(): + """If the context is the default page of a folder or is not itself a + folder, the parent is returned, otherwise the object itself is + returned. This is useful for providing a context for methods + which wish to act on what is considered the current folder in the + ui. + """ + + def getCurrentFolderUrl(): + """Returns the URL of the current folder as determined by + self.getCurrentFolder(), used heavily in actions. + """ + + def getCurrentObjectUrl(): + """Returns the URL of the current object unless that object is a + folder default page, in which case it returns the parent. + """ + + def isFolderOrFolderDefaultPage(): + """Returns true only if the current object is either a folder (as + determined by isStructuralFolder) or the default page in context. + """ + + def isPortalOrPortalDefaultPage(): + """Returns true only if the current object is either the portal object + or the default page of the portal. + """ + + def getViewTemplateId(): + """Returns the template Id corresponding to the default view method of + the context object. + """ + + def displayContentsTab(): + """Returns true if the contents tab should be displayed in the current + context. Evaluates whether the object is a folder or the default + page of a folder, and checks if the user has relevant permissions. + """ |