17.1.1   简单对象的属性和方法

在Zope编程中有一个基类称为SimpleItem，大多数Zope对象都是这个类的子类的对象， 因此可以调用SimpleItem上提供的方法。

17.1.2   文件夹操作

文件夹操作包括检查子对象的操作，还有剪切、拷贝、粘贴等

现在介绍一个剪切、复制和粘贴的实例。下面的脚本，其功能是把刚才创建的my_document文档复制到新文件夹my_folder里:

from Products.CMFCore.utils import getToolByName

urltool = getToolByName(context, "portal_url")
portal = urltool.getPortalObject()
cb_copy_data = portal.manage_copyObjects(["my_document"])
folder = getattr(portal, "my_folder")
folder.manage_pasteObjects(cb_copy_data)

17.1.3   属性操作

在ZMI中操作时很多对象都有一个 Properties 标签页，这些类型都是以 PropertyManager 为基类的， 这些属性都可以通过调用基类 PropertyManager 的方法来改变。

17.1.4   漫游方法

漫游是Zope发布对象时所采用的方法，因此所有Zope上可发布的对象都可以调用这些漫游方法。

17.1.5   DateTime类型

Python本身并未提供一个很好的表示时间日期和时区信息的类型， 为此Zope有一个DateTime类，用来表示和生成包括日期、时间、和时区信息的类型对象。

DateTime对象通过使用标准的int、long和float函数可以把从1901年1月1日以来的时间转换成整数、长整数和浮点数形式。 （兼容性注意：int、long 和float返回自从1901年以来的GMT天数，而不是按照本地时区计算的天数）。 DateTime对象还可以访问以浮点数格式表示的值，它可以和Python的time模块一起使用， 前提是对象的值属于这个基于新纪元的time模块的时间值的范围之内。 DateTime对象是不变的，所有转换和数值操作返回一个新的DateTime对象而不是修改当前的对象。 它总是按照绝对UTC时间维护数值，根据时区以及参数来提供数值。

DateTime对象可以通过形式多样的字符串或数值来创建，或者通过其它DateTime对象计算得到。DateTime可以把时间的格式转换成不同时区的格式，还可以在一个按照给定时区创建DateTime对象。如果没有指定时区，默认使用本地时区来表示时间。 创建DateTime对象可使用0到7个参数：

• 如果采用不带参数的方式调用函数，那么返回当前的日期时间，并且按照本地时区表示。

• 如果采用带有一个字符串参数的方式调用函数，其中这个字符串代表时区名称，那么返回指定时区示当前时间的DateTime对象。

• 如果采用带有唯一的字符串参数的方式调用函数，其中字符串表示一个有效的日期或时间，那么就返回相应的日期或时间对象。一般来说，任何北美居民可以明确识别的日期或时间格式都是可接受的。（其中的原因是：在北美，像2/1/1994这样的日期被认为是 February 1, 1994，然而在世界上的一些地方，它被认为是January 2, 1994。）一个日期时间对象包含两个部分：日期部分和可选的时间部分，由一个或多个空格分隔。如果时间部分忽略，则假定为12:00am。时区名称可以在日期时间字符串最后一个元素中指定，任何可以识别的时区名称用于计算日期时间值。（如果你用字符串Mar 9, 1997 1:45pm US/Pacific 创建一个DateTime对象，它的值在本质上等同于你在一台属于那个时区的机器上在指定的日期和时间捕捉的时间）:

  e=DateTime("US/Eastern") # returns current date/time, represented in US/Eastern.
  
  x=DateTime("1997/3/9 1:45pm") # returns specified time, represented in local machine zone.
  
  y=DateTime("Mar 9, 1997 13:45:00") # y is equal to x
  

  日期部分由年、月和日的值组成。年的值必须为1位、2位或4位数的整数。如果使用1位或2位数，年被假设属于20世纪。月可以是一个整数，从1到 12，也可以是月的名称或月的缩写，其中一个句点可以选择性的跟随在缩写后。日必须属于从1到该月的天数之间的整数。年、月和日的值可以用句点、连字号、右箭号或空格分隔。在分隔符周围允许使用额外的空格。年、月和日的值可以按照任何顺序给定，只要能够区分出组件。如果所有这三个组件都是小于13的数字，那么假定的顺序为月-日-年。

  time部分由小时、分钟和秒的值组成，用冒号分隔。小时的值必须是一个0至23（包含0和23）之间的整数，分钟的值必须为0至59（包含0和 59）之间的整数。秒的值可以为0至59.999（包含0和59.999）之间的整数。秒的值，或者分钟和秒的值，可以忽略。时间可以跟随大写或小写格式的am 或 pm，其被假定为12小时制。

• 如果DateTime函数被调用时带有一个数字参数，这个数字被假定为浮点数值，例如由time.time()返回的值。返回的DateTime对象表示了用本地时区表示的浮点数形式的gmt值。

• 如果函数调用时带有两个数字参数，那么第一个被认为是一个整数年，第二个参数被认为是在本地时区中本年开始以来的天数偏移量。返回的日期时间值是用本地时区表示的给定年份开始以来的天数的给定偏移量。偏移量可以是正数或负数。两位数的年被假定为20世纪当中的年份。

• 如果函数调用时带有两个参数——第一个以浮点数形式提供的参数表示了在GMT里新纪元以来的秒数，就像那些由time.time()返回的数字，第二个以字符串形式提供的参数指定一个可识别的时区，返回具有GMT时间值的DateTime对象并按照给定时区形式表示:

  import time
  t=time.time()
  
  now_east=DateTime(t,'US/Eastern')
  # Time t represented as US/Eastern
  
  now_west=DateTime(t,'US/Pacific')
  # Time t represented as US/Pacific
  
  # now_east == now_west
  # only their representations are different
  

• 如果函数调用时带有三个或更多的数字参数，那么第一个被认为是整数年，第二个被认为是整数月，第三个被认为是整数天。如果结合在一起的值无效，那么引发一个DateTimeError。两位数的年被认为是20世纪中的年份。第4、5、6个参数分别指定小时、分钟和秒——小时和分钟应该为正整数，秒应该为一个正的浮点数——所有这些如果没有给定则默认为0。可以给定一个可选择的字符串，从而作为最后一个参数来表示时区（这个效果就好像是你已经在一台位于指定时区中的机器上选定了 time.time()的值。）

如果传递给DateTime构造器的字符串参数不能解析，它引发一个DateTime.SyntaxError错误。 无效的日期、时间或时区组件引发一个DateTime.DateTimeError 错误。

构造器返回的就是一个DateTime对象，对象上有很多有用的方法，见下表。

此外，DateTime对象还支持数值计算：

• 两个DateTime对象可以相减，从而获得两者间的时间差。
• 一个DateTime对象和一个正的或负的数字可以相加，从而获得一个新DateTime对象。
• 一个正的或负的数字和一个DateTime对象可以相加，从而获得一个新DateTime对象。
• 一个正的或负的数字可以从一个DateTime对象中减去，从而获得一个新DateTime对象。

17.1.6   REQUEST 和 RESPONSE

17.1.7   排序函数

Zope提供了专用的对对象序列进行排序的模块，就是sequence模块，这个模块中提供了sort函数用于排序。 可以用在脚本或者页面模板中。

sequence.sort是排序，用在模板中对列表进行排序，使用这个sort函数首先要定义一个排序函数。 排序函数是一个元组，元组中的每一个对象都是一个三元组， 三元组中的三个值分别是属性、比较方法、升序还是降序。

注意这里使用"排序函数"仅仅是一个形象的说法，并不是要真正定义一个Python函数。 并且待排序的对象上都应该有三元组中所定义的属性。

如这个例子中对当前文件夹中的对象以title进行大小写不敏感的比较以升序排列， 对title比较相等的对象进行修改时间的比较进行降序排列：

tal:define="objects here/objectValues;
            sort_on python:(('title', 'nocase', 'asc'),
                            ('bobobase_modification_time', 'cmp', 'desc'));
            sorted_objects python:sequence.sort(objects, sort_on)">

它也可以用在脚本中，首先要导入：

import sequence

然后就是定义排序函数，用法与在页面模板中相同。

17.1.8   Script (Python) 中已知可导入的模块

17.2.1   Plone的内容操作

reindexObject常用在脚本中设置了title或description之后需要更新索引信息时调用。 如:

folder.setTitle('another title')
folder.setDescription('another description')
folder.reindexObject()

17.2.2   Plone文件夹操作

在Plone中建立的文件夹由Plone(更准确地说是CMF)添加了一组操作：

下面介绍一个创建内容的例子。 创建一个文件夹，其id为my_folder:

portal.invokeFactory('Folder', 'my_folder')

这是创建文件夹设置其元数据并更新索引:

fld = portal.invokeFactory("Folder", "test_folder")
folder = getattr(portal, "test_folder")
folder.setTitle("My Folder")
folder.setDescription("This is the description of a test folder")
folder.reindexObject()

创建一个事件并编辑它的属性:

evt = folder.invokeFactory("Event", id="event")
event = getattr(folder, "event")
event.edit(title = "Foo",
           start_date="2003-09-18",
           end_date="2003-09-19",
           location="home",
           description="This is the description of a test event")
event.editMetadata(subject="Appointment")
event.reindexObject()

创建一个文档:

doc = portal.invokeFactory("Document", "my_document")

17.2.3   Plone内容目录 (portal_catalog)

portal_catalog是Plone站点用来保存所有对象的索引信息， 在Plone界面中生成页首标签、导航树等都会用到它。

其中以searchResults或直接地调用(即调用 __call__)的形式使用最为广泛， 并且这个调用有多种传入参数的方法：

在portal_catalog中有几种不同类型的索引，其中的path索引使用的是ExtendedPathIndex， 这种类型的索引有更多的高级控制参数：

• catalog(path='some/path') 搜索位于某个路径之下的所有对象， (循环, 相当于depth = -1)
• catalog(path={'query' : 'some/path', 'depth' : 0}) 搜索位于某个路径的对象
• catalog(path={'query' : 'some/path', 'depth' : 2}) 搜索所有位于某个路径之下，且深度为2的对象
• catalog(path={'query' : 'some/path', 'navtree' : 1}) 搜索在某个路径用于导航树的对象。这包括所有该路径下深度为1的对象和所有的父对象。
• catalog(path={'query' : 'some/path', 'navtree' : 1, 'depth': 0 }) 搜索某路径用于显示当前路径的对象. 这包括所有的父对象。
• catalog(path={'query' : 'some/path', 'navtree':1, 'navtree_start':1}) 搜索某个路径下用于显示一个局部导航树。这包括所有位于该路径下、根结点1级下的对象。
• catalog(path={'query' : 'some/path', 'navtree':1, 'depth':0'navtree_start':1}) 搜索某个路径下的对象，用于显示一个局部的对象路径。 包括该路径上、根路径1级下的所有父对象。

此外，还可以传入特殊的参数以控制返回的对象列表的顺序，这样就省去了对返回对象列表的进一步排序操作：

返回的结果是一个列表，列表是由brain对象组成的， 而不是内容对象自身，但可以通过其属性来访问原对象:

下面的例子将列出这样一些对象，他们的创建日期晚于2005/11/30，而且创建者是用户admin。 下面的脚本说明了如何把一个record对象传递给searchResults方法。 参数Date接受一record对象，并按其中给定的日期查找创建时间在其之后的那些对象。参数Creator则过滤掉那些不是由用户admin创建的对象 示例:

results = context.portal_catalog.searchResults
           (Date={"query": DateTime("2005/11/30"), "range": "min"},
            Creator="admin")
print [i.getObject().Title() for i in results]
return printed

按id降序排列所有文档：

下面的脚本将把当前Portal中的所有文档按其id降序列出来。 注意其中的参数，portal_type限制内容对象的类型，而sort_on和sort_order则指定排序的依据以及排序的方式:

results = context.portal_catalog.searchResults(sort_on="id",
                                               portal_type="Document",
                                               sort_order="reverse")
print [i.getObject().id for i in results]
return printed

列出所有含有单词"texto"的私有对象：

每个content对象都定义了自己信息的哪部分可以参与搜索。 参数SearchableText就是对每个对象的那部分信息进行查找的。而参数review_state则是用来根据对象的状态进行过滤:

results = context.portal_catalog.searchResults(SearchableText="texto",
                                               review_state="private")
print [i.getObject().Title() for i in results]
return printed

17.2.4   用户管理

portal_membership和portal_registration和portal_groups工具在Plone中用于控制用户和组。 可以在自己的脚本中使用它们所提供的方法来增加或删除用户和组。

17.2.5   工作流操作 (portal_workflow)

工作流操作使用Plone站点根上的portal_workflow对象，这个对象提供了很多操作工作流的方法。

这些方法一般都用在为工作流设置的脚本中。

需要说明的是，在工作流中使用的脚本是带有一个参数运行的， 从这个参数上可以得到工作流的各种信息。 如，要访问存在于工作流中的对象，可以使用这个Python脚本来实现：

##parameters=state_change
obj = state_change.object

脚本为开发人员提供了机会，使他们可以在过渡之上执行一些逻辑——几乎可以是任何你想要的逻辑。 你可以检查一些条件是否已被执行（例如文档拼写检查是否执行了？）或者一些特殊动作是否已被执行。 当对象处于过渡时期，脚本就会被调用执行。

当脚本被调用执行时，会有一个额外的参数传递给它。 这个额外的参数提供了对与过渡相关的各种元素和属性的访问通路。 这个参数被称作state_change参数，它有如下属性或调用形式：

这个脚本中将会发生的事情完全要依赖于开发者——作为开发者，你在这里几乎可以做任何事情。 你可以引发事件，你也可以访问其他的工作流和过渡。 当脚本执行时，往往是启动了过渡的用户同时启动了脚本。 如果需要让其他人来这样做，你可以把代理人角色（proxy roles）分配到脚本中。 在返回过渡时，你可以在 script(after) 和 script(before) 设置中把脚本分配给任意数量的过渡。你可以在过渡发生之前或之后执行脚本。

下面举一个例子说明。在程序中一般需要根据条件来改变某个Plone内容的工作流状态， 常用的就是先使用getInfoFor来获取对象的状态，再使用doActionFor执行一个工作流的动作。 如这个例子是通过Python脚本改变私有文档的状态

from Products.CMFCore.utils import getToolByName
urltool = getToolByName(context, "portal_url")
portal  = urltool.getPortalObject()
document = getattr(portal, "my_document")
review_state = document.portal_workflow.getInfoFor(document, "review_state", "")
print "The initial state is: " + review_state + "\n"

if not review_state in ("rejected", "retracted", "private"):
  document.portal_workflow.doActionFor(document, "hide", comment="")
  review_state = document.portal_workflow.getInfoFor(document, "review_state", "")
  print "The final state is: " + review_state + "\n"
return printed

下面是一个工作流操作的例子， 管理工作流一章介绍了自定义工作流，但那一章还没有介绍到脚本， 因此在这里补充一个以脚本定制工作流的例子。 原文可以查看 http://plone.org/documentation/how-to/object-with-parent-state 。

对于简单的内容发布网站而言， 可以将文件夹中内容的初始工作流状态设置为与父对象一致， 这样只要设好几个文件夹的初始状态就可以控制其中所新建内容的状态， 这就是这个例子定制的目的。

首先至Zope管理界面中找到portal_workflow/plone_workflow并选择scripts标签页， 在其中添加一个脚本，命名为setState，并设置一个参数state_change，内容如下：

# set state to state of container
# called by intialTransition upon creation of an object

obj = state_change.object

# get the parent state
parent = obj.aq_parent
try:
  parentState = context.portal_workflow.getInfoFor(parent, 'review_state')
except:
  # use default state of object if no review_state available for parent object
  parentState = context.portal_workflow.getInfoFor(obj, 'review_state')

# get possible transitions for object in current state
actions = context.portal_workflow.getActionsFor(obj)
transitions = []
for item in actions:
    if item.has_key('transition'):
      transitions.append(item['transition'])

# find transition that brings us to the state of parent object
for item in transitions:
  if item.new_state_id == parentState:
    context.portal_workflow.doActionFor(obj, item.id)

可以看到，这段内容首先获得父对象的工作流状态， 然后将新添加对象的状态设为与其一致。

然后是将这个脚本用在工作流中，这在Zope管理界面中操作如下：

• 在plone_workflow中增加一个转换(transition)，命名为intialTransition， 触发条件设为automatic，目标状态设为visible，在script中选择上面定义的setState。
• 再给plone_workflow增加一个初始状态(state)， 就是命名为initialState的状态，并设置为缺省状态。

这样设置之后，对于私有文件夹中创建的内容缺省就是私有状态， 已发布文件夹中创建的内容缺省就是已发布状态， 这样的设置比较适合简单的管理方式的网站需求。

17.2.6   发送邮件 (MailHost)

在Plone站点根上有一个MailHost对象，使用这个对象可以发送邮件。

可使用secureSend方法发送邮件，这是它在源代码里面的声明:

security.declareProtected(use_mailhost_services, 'secureSend')
def secureSend(self, message, mto=None, mfrom=None, subject='[No Subject]',
               mcc=None, mbcc=None, subtype='plain', charset='utf-8',
               debug=False, **kwargs)

由此可知它是use_mailhost_services权限所保护的，在站点上一般只有管理员有这个权限， 解决方法是在脚本中使用这个方法并给脚本设置 proxy 为管理员。

下面是一个示例，从context上获取到MailHost对象，并准备一些参数:

mailhost = context.MailHost
message = """这是一个例子, 发送看看.

            特别是看看中文支持情况如何？

            收到了吗？
            """
mto = "YOUR_NAME@gmail.com"
mfrom = "MY_NAME@zopen.cn"
subject = "测试邮件"

发送邮件:

mailhost.secureSend(message, mto=mto, mfrom=mfrom,
  subject=subject + '(secureSend)', charset="utf-8")

MailHost还有一个传统的发送邮件的接口是send，但它不支持中文， 在新的代码中应该使用secureSend替换。

17.2.7   Plone工具 (plone_utils)