Merge lp:~salgado/launchpad/apidoc into lp:launchpad

[Guilherme Salgado]

Add a new vhost (apidoc.launchpad.dev), enabled only when devmode is on, for Launchpad's apidoc using zope.app.apidoc.

Make zope.app.apidoc available on the new apidoc.lp.dev vhost.

[Gary Poster (gary)]

Hi Salgado. Very cool. Thank you. Comments below.

Requested:

- Let's put the changes from lib/canonical/launchpad/webapp/configure.zcml into apidoc-configure-normal.zcml.

Questions and comments:

- Why is this necessary, do you know? I realize it is an existing code that you moved around, but neither the comment nor the "provides" made much sense to me, though Google did show me some hints that it might be standard practice for enabling the apidoc for some reason. Did you try removing it?
+ <!-- Turn on devmode for the following includes principal=work -->
+ <meta:provides feature="devmode" />

- I'm concerned that the tests are going to be run with even more registrations that will not be part of production. I wish there were a light, easy way to start up another LP instance for the apidoc smoke test that then would not pollute the rest of the tests with the apidoc registrations in the zcml file. However, I don't know of one, and unless you do, I won't insist that we address this concern. It's certainly just slightly enlarging an existing problem, rather than making a new one.

- Did you audit zope.login to make sure it's registrations don't do something we need to be worried about from a security perspective? If not, one of us should. I'd feel somewhat happier if ``<include package="zope.login" />`` were part of the apidoc zcml, but then we're exacerbating the previous problem (that is, production registrations are more and more different from test registrations).

Suggested:

- I suggest renaming LaunchpadPrincipalAnnotations to TemporaryPrincipalAnnotations: the behavior (and the fact that the implementation is effectively a stub) is something worth highlighting. Calling it "Launchpad" doesn't buy us anything.

- FWIW, LaunchpadPrincipalAnnotations could subclass UserDict.UserDict and be shortened to the __init__ plus a call to the shared constructor and the interface declarations. Do it if you want.

- For this comment:
+ <!-- XXX: Copied from zope.browserresource as apidoc breaks if we make
+ IAPIDocRoot implement ISite so that the original registration works
+ for us. -->
I suggest that this is not an XXX. To that point, this is not "Copied" but "Modified" (the "for" is different, and that's the key).

- For this comment:
+ <!-- XXX Probably make this in overrides for ISimpleReadContainer. Safer:
+ register for all apidoc containers, one way or another -->
You mentioned that these comments came from me. I think we can just remove the comment entirely. As I said on IRC, for the first half, I think I expected that this was going to have to go in overrides. Since it works without being in overrides, this is a "never mind...". For the second half ("Safer:..."), I think we're probably fine. It would be nice if we could easily register this only for the bots we care about, but, eh. It's all right, I think.

- I have said that I was fine with the change to authorization.py, but actually I had another idea. I'm not 100% convinced the new idea is better, but it is simpler, at least. The idea is to revert all current changes from that file, and then add ``from zope.proxy import removeAllProx...

[Gary Poster (gary)]

review: Needs Information

[Guilherme Salgado (salgado)]

On Wed, 2010-07-21 at 17:08 +0000, Gary Poster wrote:
> Hi Salgado. Very cool. Thank you. Comments below.
>
> Requested:
>
> - Let's put the changes from
> lib/canonical/launchpad/webapp/configure.zcml into
> apidoc-configure-normal.zcml.

Good catch. Done.

>
> Questions and comments:
>
> - Why is this necessary, do you know? I realize it is an existing
> code that you moved around, but neither the comment nor the "provides"
> made much sense to me, though Google did show me some hints that it
> might be standard practice for enabling the apidoc for some reason.
> Did you try removing it?
> + <!-- Turn on devmode for the following includes principal=work
> -->
> + <meta:provides feature="devmode" />

For some reason it became necessary when I moved the zcml to
apidoc-configure-normal.zcml. I've moved the principal= part.

>
> - I'm concerned that the tests are going to be run with even more
> registrations that will not be part of production. I wish there were
> a light, easy way to start up another LP instance for the apidoc smoke
> test that then would not pollute the rest of the tests with the apidoc
> registrations in the zcml file. However, I don't know of one, and
> unless you do, I won't insist that we address this concern. It's
> certainly just slightly enlarging an existing problem, rather than
> making a new one.

I hadn't thought about that, but I'll see if I can find a way to not
make this situation any worse.

>
> - Did you audit zope.login to make sure it's registrations don't do
> something we need to be worried about from a security perspective? If
> not, one of us should. I'd feel somewhat happier if ``<include
> package="zope.login" />`` were part of the apidoc zcml, but then we're
> exacerbating the previous problem (that is, production registrations
> are more and more different from test registrations).

zope.login is now needed because the ILoginPassword adapter has been
moved there from zope.publisher, but you have a good point that it
should be audited.

I've just checked and it just registers the ILoginPassword adapters for
both IHTTPCredentials and IFTPCredentials as zope.publisher did until
version 3.10.

I'm now wondering if I should do the same for all the eggs that I've
updated as part of this -- they could also register new things that
we're not expecting.

>
> Suggested:
>
> - I suggest renaming LaunchpadPrincipalAnnotations to
> TemporaryPrincipalAnnotations: the behavior (and the fact that the
> implementation is effectively a stub) is something worth highlighting.
> Calling it "Launchpad" doesn't buy us anything.

I like your suggestion; renamed.

>
> - FWIW, LaunchpadPrincipalAnnotations could subclass UserDict.UserDict
> and be shortened to the __init__ plus a call to the shared constructor
> and the interface declarations. Do it if you want.

I'm all for it!

Also, I thought I could make apidoc.lp.dev work for anonymous users by
just registering an adapter like the above for
IUnauthenticatedPrincipal, but then I got
http://paste.ubuntu.com/467401/

I'm thinking that it may be better to actually require a logged-in user
to use apidoc.lp.dev and ask them to login in case they're no...

[Guilherme Salgado (salgado)]

Another alternative to deal with the fact that apidoc.lp.dev doesn't seem to work for anonymous users would be to somehow pretend all requests on apidoc.lp.dev are authenticated. I did that by making APIDocBrowserPublication.getPrincipal() return a fixed principal, but now I always get that same LocationError traceback: http://paste.ubuntu.com/467401/

[Gary Poster (gary)]

Hey Salgado. Thank you. Below, I've deleted sections for which I thought no further discussion was necessary.

On Jul 22, 2010, at 5:15 AM, Guilherme Salgado wrote:

> On Wed, 2010-07-21 at 17:08 +0000, Gary Poster wrote:
>> Hi Salgado. Very cool. Thank you. Comments below.
>>
>> Requested:
>>
>> - Let's put the changes from
>> lib/canonical/launchpad/webapp/configure.zcml into
>> apidoc-configure-normal.zcml.
>
> Good catch. Done.

I don't understand why you didn't also move this:
+ <utility
+ component="canonical.launchpad.systemhomes.apidocroot"
+ provides="canonical.launchpad.webapp.interfaces.IAPIDocRoot" />
Was it an oversight, or is there a reason to keep it where it is?

...

>> - I'm concerned that the tests are going to be run with even more
>> registrations that will not be part of production. I wish there were
>> a light, easy way to start up another LP instance for the apidoc smoke
>> test that then would not pollute the rest of the tests with the apidoc
>> registrations in the zcml file. However, I don't know of one, and
>> unless you do, I won't insist that we address this concern. It's
>> certainly just slightly enlarging an existing problem, rather than
>> making a new one.
>
> I hadn't thought about that, but I'll see if I can find a way to not
> make this situation any worse.

Ack, thanks.

>> - Did you audit zope.login to make sure it's registrations don't do
>> something we need to be worried about from a security perspective? If
>> not, one of us should. I'd feel somewhat happier if ``<include
>> package="zope.login" />`` were part of the apidoc zcml, but then we're
>> exacerbating the previous problem (that is, production registrations
>> are more and more different from test registrations).
>
> zope.login is now needed because the ILoginPassword adapter has been
> moved there from zope.publisher, but you have a good point that it
> should be audited.
>
> I've just checked and it just registers the ILoginPassword adapters for
> both IHTTPCredentials and IFTPCredentials as zope.publisher did until
> version 3.10.

Cool.

> I'm now wondering if I should do the same for all the eggs that I've
> updated as part of this -- they could also register new things that
> we're not expecting.

The reason why I singled in on this one is that it is registered in zopeapp.zcml, so it will affect production. The rest will only affect tests and development, so I'm less concerned in this regard.

zope.publisher's update I guess is worth a look, actually. But that's the only other one I see.

> - FWIW, LaunchpadPrincipalAnnotations could subclass UserDict.UserDict
>> and be shortened to the __init__ plus a call to the shared constructor
>> and the interface declarations. Do it if you want.
>
> I'm all for it!
>
> Also, I thought I could make apidoc.lp.dev work for anonymous users by
> just registering an adapter like the above for
> IUnauthenticatedPrincipal, but then I got
> http://paste.ubuntu.com/467401/

Meh, digging into it just a bit, I see that preference group thing is doing somewhat unusual security dances. I wouldn't be all that surprised if that LocationError were actually hiding a Forbidd...

[Gary Poster (gary)]

review: Approve

[Guilherme Salgado (salgado)]

On Fri, 2010-07-23 at 12:42 +0000, Gary Poster wrote:
> Hey Salgado. Thank you. Below, I've deleted sections for which I thought no further discussion was necessary.
>
> On Jul 22, 2010, at 5:15 AM, Guilherme Salgado wrote:
>
> > On Wed, 2010-07-21 at 17:08 +0000, Gary Poster wrote:
> >> Hi Salgado. Very cool. Thank you. Comments below.
> >>
> >> Requested:
> >>
> >> - Let's put the changes from
> >> lib/canonical/launchpad/webapp/configure.zcml into
> >> apidoc-configure-normal.zcml.
> >
> > Good catch. Done.
>
> I don't understand why you didn't also move this:
> + <utility
> + component="canonical.launchpad.systemhomes.apidocroot"
> + provides="canonical.launchpad.webapp.interfaces.IAPIDocRoot" />
> Was it an oversight, or is there a reason to keep it where it is?

Yep, oversight. Moved.

>
> > I'm now wondering if I should do the same for all the eggs that I've
> > updated as part of this -- they could also register new things that
> > we're not expecting.
>
> The reason why I singled in on this one is that it is registered in
> zopeapp.zcml, so it will affect production. The rest will only affect
> tests and development, so I'm less concerned in this regard.
>
> zope.publisher's update I guess is worth a look, actually. But that's
> the only other one I see.
>

http://paste.ubuntu.com/467986/ is the diff between the previous
configure.zcml and the current version, so nothing to worry about, I
think?

> > - FWIW, LaunchpadPrincipalAnnotations could subclass UserDict.UserDict
> >> and be shortened to the __init__ plus a call to the shared constructor
> >> and the interface declarations. Do it if you want.
> >
> > I'm all for it!
> >
> > Also, I thought I could make apidoc.lp.dev work for anonymous users by
> > just registering an adapter like the above for
> > IUnauthenticatedPrincipal, but then I got
> > http://paste.ubuntu.com/467401/
>
> Meh, digging into it just a bit, I see that preference group thing is
> doing somewhat unusual security dances. I wouldn't be all that
> surprised if that LocationError were actually hiding a
> ForbiddenAttribute on a value that should be there, but maybe I'm
> wrong.
>
> > I'm thinking that it may be better to actually require a logged-in user
> > to use apidoc.lp.dev and ask them to login in case they're not, just
> > like we do on other launchpad.AnyPerson pages. What do you think?
>
> Since this is only for devel instances, in the abstract there's no
> reason not to expose this for anonymous users that I see. That will
> also make it easier to make a static version of the apidoc, which I
> think is part of the plan.

Agreed. All I wanted was to make sure we require people to login as
early as possible so that they don't see these obscure errors that one
has no idea can be worked around just by logging in.

>
> If you want me to look into the traceback further just ask.

I'd really appreciate as I wouldn't know where to start. Just some
pointers so I can get started would be great.

>
> ...
>
> >> - I have said that I was fine with the change to authorization.py, but
> >> actually I had another idea. I'm not 100% convinced the new idea is
> >> better, ...

[Gary Poster (gary)]

On Jul 23, 2010, at 9:12 AM, Guilherme Salgado wrote:

> On Fri, 2010-07-23 at 12:42 +0000, Gary Poster wrote:
>> Hey Salgado. Thank you. Below, I've deleted sections for which I thought no further discussion was necessary.

Doing that again.

>>
>> On Jul 22, 2010, at 5:15 AM, Guilherme Salgado wrote:
>>
>>> On Wed, 2010-07-21 at 17:08 +0000, Gary Poster wrote:
>
...

>>
>>> I'm now wondering if I should do the same for all the eggs that I've
>>> updated as part of this -- they could also register new things that
>>> we're not expecting.
>>
>> The reason why I singled in on this one is that it is registered in
>> zopeapp.zcml, so it will affect production. The rest will only affect
>> tests and development, so I'm less concerned in this regard.
>>
>> zope.publisher's update I guess is worth a look, actually. But that's
>> the only other one I see.
>>
>
> http://paste.ubuntu.com/467986/ is the diff between the previous
> configure.zcml and the current version, so nothing to worry about, I
> think?

Agreed, thanks.

>
>
>>> - FWIW, LaunchpadPrincipalAnnotations could subclass UserDict.UserDict
>>>> and be shortened to the __init__ plus a call to the shared constructor
>>>> and the interface declarations. Do it if you want.
>>>
>>> I'm all for it!
>>>
>>> Also, I thought I could make apidoc.lp.dev work for anonymous users by
>>> just registering an adapter like the above for
>>> IUnauthenticatedPrincipal, but then I got
>>> http://paste.ubuntu.com/467401/
>>
>> Meh, digging into it just a bit, I see that preference group thing is
>> doing somewhat unusual security dances. I wouldn't be all that
>> surprised if that LocationError were actually hiding a
>> ForbiddenAttribute on a value that should be there, but maybe I'm
>> wrong.
>>
>>> I'm thinking that it may be better to actually require a logged-in user
>>> to use apidoc.lp.dev and ask them to login in case they're not, just
>>> like we do on other launchpad.AnyPerson pages. What do you think?
>>
>> Since this is only for devel instances, in the abstract there's no
>> reason not to expose this for anonymous users that I see. That will
>> also make it easier to make a static version of the apidoc, which I
>> think is part of the plan.
>
> Agreed. All I wanted was to make sure we require people to login as
> early as possible so that they don't see these obscure errors that one
> has no idea can be worked around just by logging in.
>
>>
>> If you want me to look into the traceback further just ask.
>
> I'd really appreciate as I wouldn't know where to start. Just some
> pointers so I can get started would be great.

I was skeptical of the way you were using object and UserDict together--that doesn't make UserDict a new-style class, so it doesn't play the "super" game. This fixes the traceback for unauthenticated users, and is generally more correct:

=== modified file 'lib/canonical/launchpad/webapp/authentication.py'
--- lib/canonical/launchpad/webapp/authentication.py 2010-07-22 09:12:46 +0000
+++ lib/canonical/launchpad/webapp/authentication.py 2010-07-23 14:54:07 +0000
@@ -326,12 +326,12 @@

 # zope.app.apidoc expects our principals to be adaptable into IAnno...

[Gary Poster (gary)]

One more thing, but it's really important.

I think LP devs might get a lot more excited about this if you just add this little bit.

=== modified file 'configs/development/apidoc-configure-normal.zcml'
--- configs/development/apidoc-configure-normal.zcml 2010-07-22 09:12:46 +0000
+++ configs/development/apidoc-configure-normal.zcml 2010-07-23 18:25:06 +0000
@@ -3,6 +3,7 @@
     xmlns:browser="http://namespaces.zope.org/browser"
     xmlns:meta="http://namespaces.zope.org/meta"
     xmlns:i18n="http://namespaces.zope.org/i18n"
+ xmlns:apidoc="http://namespaces.zope.org/apidoc"
     i18n_domain="canonical">

     <!-- These packages/declarations are required by apidoc. If they are
@@ -48,7 +49,7 @@
     <!-- apidoc.lp.dev breaks if we make IAPIDocRoot subclass ISite, so we
       need to register this view here. -->
     <view
- for="canonical.launchpad.webapp.interfaces.IAPIDocRoot"
+ for="canonical.launchpad.webapp.interfaces.IAPIDocRoot"
         type="zope.publisher.interfaces.browser.IDefaultBrowserLayer"
         name=""
         factory="zope.browserresource.resources.Resources"
@@ -74,5 +75,15 @@
     <include package="zope.app.tree" />
     <include package="zope.app.apidoc" />

+ <apidoc:rootModule module="canonical" />
+ <apidoc:rootModule module="lp" />
+ <apidoc:rootModule module="lazr" />
+ <apidoc:rootModule module="zc" />
+ <apidoc:rootModule module="wadllib" />
+ <apidoc:rootModule module="martian" />
+ <apidoc:rootModule module="manuel" />
+ <apidoc:rootModule module="chameleon" />
+ <apidoc:rootModule module="bzrlib" />
+ <apidoc:rootModule module="storm" />
+
 </configure>
-

With this, all of that code is browsable and searchable, and the work you've done shows what we expect in the apidoc. It's pretty cool, I think.

=== renamed file 'configs/development/apidoc-configure-normal.zcml.OFF' => 'configs/development/apidoc-configure-normal.zcml'
--- configs/development/apidoc-configure-normal.zcml.OFF	2008-09-02 16:03:35 +0000
+++ configs/development/apidoc-configure-normal.zcml	2010-07-23 19:21:07 +0000
@@ -1,48 +1,93 @@
 <configure
     xmlns="http://namespaces.zope.org/zope"
-    xmlns:meta="http://namespaces.zope.org/meta">
-    <!-- These packages are required by apidoc. If they are deemed
-    generally useful, move them to zopeapp.zcml
-    -->
-    <!--
-    How frustrating.  This is needed for just one page registration
-    in introspector.zcml.
-    -->
-    <include package="zope.app" file="menus.zcml" />
-    <include package="zope.app.tree.browser" />
-    <include package="zope.app.tree" />  
-    <include package="zope.app.renderer" file="meta.zcml" />
+    xmlns:browser="http://namespaces.zope.org/browser"
+    xmlns:meta="http://namespaces.zope.org/meta"
+    xmlns:i18n="http://namespaces.zope.org/i18n"
+    xmlns:apidoc="http://namespaces.zope.org/apidoc"
+    i18n_domain="canonical">
+
+    <!-- These packages/declarations are required by apidoc. If they are
+      deemed generally useful, move them to zopeapp.zcml -->
+
+    <browser:menu
+        id="zmi_views"
+        title="Views"
+        description="Menu for displaying alternate representations of an object"
+        />
+    <browser:menu
+        id="zmi_actions"
+        title="Actions"
+        description="Menu for displaying actions to be performed"
+        />
+
+    <!-- Use the default IAbsoluteURL adapter for requests on the apidoc
+         vhost. -->
+    <adapter
+        for="zope.interface.Interface
+             canonical.launchpad.webapp.servers.APIDocBrowserRequest"
+        provides="zope.traversing.browser.interfaces.IAbsoluteURL"
+        factory="zope.traversing.browser.AbsoluteURL"
+        />
+
+    <view
+      for="zope.container.interfaces.IReadContainer"
+      type="zope.publisher.interfaces.http.IHTTPRequest"
+      provides="zope.publisher.interfaces.IPublishTraverse"
+      factory="zope.container.traversal.ContainerTraverser"
+      permission="zope.Public"
+      allowed_interface="zope.publisher.interfaces.IPublishTraverse"
+      />
+
+    <utility
+        component="canonical.launchpad.systemhomes.apidocroot"
+        provides="canonical.launchpad.webapp.interfaces.IAPIDocRoot" />
+
+    <adapter factory="canonical.launchpad.webapp.authentication.TemporaryPrincipalAnnotations" />
+    <adapter
+      factory="canonical.launchpad.webapp.authentication.TemporaryUnauthenticatedPrincipalAnnotations" />
+
+    <class class="canonical.launchpad.webapp.servers.LaunchpadBrowserRequest">
+      <implements interface="zope.app.apidoc.browser.skin.APIDOC" />
+    </class>
+
+    <!-- apidoc.lp.dev breaks if we make IAPIDocRoot subclass ISite, so we
+      need to register this view here. -->
+    <view
+        for="canonical.launchpad.webapp.interfaces.IAPIDocRoot"
+        type="zope.publisher.interfaces.browser.IDefaultBrowserLayer"
+        name=""
+        factory="zope.browserresource.resources.Resources"
+        permission="zope.Public"
+        allowed_interface="zope.publisher.interfaces.browser.IBrowserPublisher"
+        />
+
+    <browser:defaultView
+        for="canonical.launchpad.webapp.interfaces.IAPIDocRoot"
+        name="++apidoc++"
+        />
+
+    <!-- Turn on devmode for the following includes to work -->
+    <meta:provides feature="devmode" />
+
+    <include package="zope.location" />
+    <include package="zope.app.applicationcontrol" />
     <include package="zope.app.renderer" />
-
-    <!-- XXX: StuartBishop 2005-03-13 bug=39834:
-    We also need the Z3 preference junk, whatever that is.
-    Unfortunately, this depends on annotatable principals so will not
-    currently work with Launchpad. We can still get some apidoc functionality,
-    such as the ZCML browser, but the bulk of it is not functional.
-    -->
     <include package="zope.app.preference" file="meta.zcml" />
-    <!--
+    <include package="zope.app.apidoc.codemodule" file="meta.zcml" />
+    <include package="zope.app.apidoc.bookmodule" file="meta.zcml" />
     <include package="zope.app.preference" />
-    -->
-
-
-    <!-- Turn on devmode for the following includes principal=work -->
-    <meta:provides feature="devmode" />
-
-    <include package="zope.app.apidoc" file="meta.zcml" />
+    <include package="zope.app.tree" />
     <include package="zope.app.apidoc" />
 
-    <meta:redefinePermission
-        from="zope.app.apidoc.UseAPIDoc"  to="zope.Public"
-        />
-
-    <!-- Override a strange permission in apidoc -->
-    <class class="zope.app.apidoc.apidoc.APIDocumentation">
-        <require
-            interface="zope.app.container.interfaces.IReadContainer"
-            permission="zope.Public"
-            />
-    </class>
+    <apidoc:rootModule module="canonical" />
+    <apidoc:rootModule module="lp" />
+    <apidoc:rootModule module="lazr" />
+    <apidoc:rootModule module="zc" />
+    <apidoc:rootModule module="wadllib" />
+    <apidoc:rootModule module="martian" />
+    <apidoc:rootModule module="manuel" />
+    <apidoc:rootModule module="chameleon" />
+    <apidoc:rootModule module="bzrlib" />
+    <apidoc:rootModule module="storm" />
 
 </configure>
-

=== modified file 'configs/development/launchpad-lazr.conf'
--- configs/development/launchpad-lazr.conf	2010-07-15 15:57:40 +0000
+++ configs/development/launchpad-lazr.conf	2010-07-23 19:21:07 +0000
@@ -300,6 +300,9 @@
 [vhost.openid]
 hostname: openid.launchpad.dev
 
+[vhost.apidoc]
+hostname: apidoc.launchpad.dev
+
 [vhost.testopenid]
 hostname: testopenid.dev
 

=== added symlink 'configs/testrunner/apidoc-configure-normal.zcml'
=== target is u'../development/apidoc-configure-normal.zcml'
=== modified file 'lib/canonical/config/schema-lazr.conf'
--- lib/canonical/config/schema-lazr.conf	2010-07-16 20:55:50 +0000
+++ lib/canonical/config/schema-lazr.conf	2010-07-23 19:21:07 +0000
@@ -1977,6 +1977,8 @@
 
 [vhost.testopenid]
 
+[vhost.apidoc]
+
 [vhost.ubuntu_openid]
 
 [vhost.shipitubuntu]

=== modified file 'lib/canonical/launchpad/browser/launchpad.py'
--- lib/canonical/launchpad/browser/launchpad.py	2010-07-14 13:54:20 +0000
+++ lib/canonical/launchpad/browser/launchpad.py	2010-07-23 19:21:07 +0000
@@ -62,8 +62,8 @@
     stepto)
 from canonical.launchpad.webapp.breadcrumb import Breadcrumb
 from canonical.launchpad.webapp.interfaces import (
-    GoneError, IBreadcrumb, ILaunchBag, ILaunchpadRoot, INavigationMenu,
-    NotFoundError, POSTToNonCanonicalURL)
+    GoneError, IBreadcrumb, ILaunchBag, ILaunchpadRoot,
+    INavigationMenu, NotFoundError, POSTToNonCanonicalURL)
 from canonical.launchpad.webapp.publisher import RedirectionView
 from canonical.launchpad.webapp.authorization import check_permission
 from canonical.launchpad.webapp.tales import PageTemplateContextsAPI

=== modified file 'lib/canonical/launchpad/doc/webapp-publication.txt'
--- lib/canonical/launchpad/doc/webapp-publication.txt	2010-07-21 00:34:38 +0000
+++ lib/canonical/launchpad/doc/webapp-publication.txt	2010-07-23 19:21:07 +0000
@@ -41,6 +41,10 @@
     rooturl: http://api.launchpad.dev/
     althosts:
     ----
+    apidoc @ apidoc.launchpad.dev
+    rooturl: http://apidoc.launchpad.dev/
+    althosts:
+    ----
     blueprints @ blueprints.launchpad.dev
     rooturl: http://blueprints.launchpad.dev/
     althosts:
@@ -106,6 +110,7 @@
     ...     print hostname
     answers.launchpad.dev
     api.launchpad.dev
+    apidoc.launchpad.dev
     blueprints.launchpad.dev
     bugs.launchpad.dev
     code.launchpad.dev

=== modified file 'lib/canonical/launchpad/layers.py'
--- lib/canonical/launchpad/layers.py	2010-07-21 22:09:39 +0000
+++ lib/canonical/launchpad/layers.py	2010-07-23 19:21:07 +0000
@@ -36,6 +36,10 @@
     """
 
 
+class APIDocLayer(IBrowserRequest, IDefaultBrowserLayer):
+    """The `APIDocLayer` layer."""
+
+
 class TestOpenIDLayer(LaunchpadLayer):
     """The `TestOpenIDLayer` layer."""
 

=== modified file 'lib/canonical/launchpad/permissions.zcml'
--- lib/canonical/launchpad/permissions.zcml	2009-11-15 01:05:49 +0000
+++ lib/canonical/launchpad/permissions.zcml	2010-07-23 19:21:07 +0000
@@ -85,5 +85,10 @@
     title="Review Launchpad projects"
     access_level="write" />
 
+  <!-- This permission only exists to please apidoc.launchpad.dev and
+       shouldn't be used anywhere else. -->
+  <permission
+    id="zope.ManageApplication" title="Needed by zope.app.apidoc"
+    access_level="read" />
 
 </configure>

=== modified file 'lib/canonical/launchpad/security.py'
--- lib/canonical/launchpad/security.py	2010-07-20 12:33:43 +0000
+++ lib/canonical/launchpad/security.py	2010-07-23 19:21:07 +0000
@@ -1080,13 +1080,27 @@
 
 
 class UseApiDoc(AuthorizationBase):
+    """This is just to please apidoc.launchpad.dev."""
     permission = 'zope.app.apidoc.UseAPIDoc'
     usedfor = Interface
 
+    def checkUnauthenticated(self):
+        return True
+
     def checkAuthenticated(self, user):
         return True
 
 
+class ManageApplicationForEverybody(UseApiDoc):
+    """This is just to please apidoc.launchpad.dev.
+
+    We do this because zope.app.apidoc uses that permission, but nothing else
+    should be using it.
+    """
+    permission = 'zope.ManageApplication'
+    usedfor = Interface
+
+
 class OnlyBazaarExpertsAndAdmins(AuthorizationBase):
     """Base class that allows only the Launchpad admins and Bazaar
     experts."""

=== modified file 'lib/canonical/launchpad/systemhomes.py'
--- lib/canonical/launchpad/systemhomes.py	2010-04-19 06:35:23 +0000
+++ lib/canonical/launchpad/systemhomes.py	2010-07-23 19:21:07 +0000
@@ -6,7 +6,7 @@
 __all__ = [
     'AuthServerApplication',
     'BazaarApplication',
-    'CodeImportScheduler',
+    'CodeImportSchedulerApplication',
     'FeedsApplication',
     'MailingListApplication',
     'MaloneApplication',
@@ -39,7 +39,8 @@
 from lp.hardwaredb.interfaces.hwdb import (
     IHWDeviceSet, IHWDriverSet, IHWSubmissionDeviceSet, IHWSubmissionSet,
     IHWVendorIDSet, ParameterError)
-from canonical.launchpad.webapp.interfaces import ICanonicalUrlData
+from canonical.launchpad.webapp.interfaces import (
+    IAPIDocRoot, ICanonicalUrlData)
 from lp.bugs.interfaces.bug import (
     CreateBugParams, IBugSet, InvalidBugTargetType)
 from lp.code.interfaces.codehosting import ICodehostingApplication
@@ -388,3 +389,11 @@
 
 class TestOpenIDApplication:
     implements(ITestOpenIDApplication)
+
+
+class APIDocRoot:
+    implements(IAPIDocRoot)
+    __parent__ = None
+    __name__ = None
+
+apidocroot = APIDocRoot()

=== modified file 'lib/canonical/launchpad/webapp/authentication.py'
--- lib/canonical/launchpad/webapp/authentication.py	2010-02-16 14:25:51 +0000
+++ lib/canonical/launchpad/webapp/authentication.py	2010-07-23 19:21:07 +0000
@@ -16,12 +16,16 @@
 import binascii
 import hashlib
 import random
+from UserDict import UserDict
 
 from contrib.oauth import OAuthRequest
 
+from zope.annotation.interfaces import IAnnotations
+from zope.authentication.interfaces import IUnauthenticatedPrincipal
 from zope.interface import implements
-from zope.component import getUtility
+from zope.component import adapts, getUtility
 from zope.event import notify
+from zope.preference.interfaces import IPreferenceGroup
 
 from zope.security.proxy import removeSecurityProxy
 
@@ -320,6 +324,22 @@
         return encryptor.validate(pw1, pw2)
 
 
+# zope.app.apidoc expects our principals to be adaptable into IAnnotations, so
+# we use these dummy adapters here just to make that code not OOPS.
+class TemporaryPrincipalAnnotations(UserDict):
+    implements(IAnnotations)
+    adapts(ILaunchpadPrincipal, IPreferenceGroup)
+
+    def __init__(self, principal, pref_group):
+        UserDict.__init__(self)
+
+
+class TemporaryUnauthenticatedPrincipalAnnotations(
+        TemporaryPrincipalAnnotations):
+    implements(IAnnotations)
+    adapts(IUnauthenticatedPrincipal, IPreferenceGroup)
+
+
 def get_oauth_authorization(request):
     """Retrieve OAuth authorization information from a request.
 

=== modified file 'lib/canonical/launchpad/webapp/authorization.py'
--- lib/canonical/launchpad/webapp/authorization.py	2010-01-14 13:25:34 +0000
+++ lib/canonical/launchpad/webapp/authorization.py	2010-07-23 19:21:07 +0000
@@ -10,6 +10,7 @@
 from zope.component import getUtility, queryAdapter
 from zope.browser.interfaces import IView
 
+from zope.proxy import removeAllProxies
 from zope.publisher.interfaces import IApplicationRequest
 from zope.security.interfaces import ISecurityPolicy
 from zope.security.checker import CheckerPublic
@@ -138,8 +139,11 @@
             # We will not be able to lookup an adapter for this, so we can
             # return False already.
             return False
-        # Remove security proxies from object to authorize.
-        objecttoauthorize = removeSecurityProxy(objecttoauthorize)
+        # Remove all proxies from object to authorize. The security proxy is
+        # removed for obvious reasons but we also need to remove the location
+        # proxy (which is used on apidoc.lp.dev) because otherwise we can't
+        # create a weak reference to our object in our security policy cache.
+        objecttoauthorize = removeAllProxies(objecttoauthorize)
 
         participations = [participation
                           for participation in self.participations

=== modified file 'lib/canonical/launchpad/webapp/configure.zcml'
--- lib/canonical/launchpad/webapp/configure.zcml	2010-07-15 15:57:40 +0000
+++ lib/canonical/launchpad/webapp/configure.zcml	2010-07-23 19:21:07 +0000
@@ -672,7 +672,7 @@
         permission="zope.Public"
         class="canonical.launchpad.webapp.launchbag.LaunchBagView"
         />
-
+ 
     <!-- Resource unnamed view, allowing Z3 preferred spelling
         /@@/launchpad-icon-small to access the images directory -->
     <browser:page

=== modified file 'lib/canonical/launchpad/webapp/interfaces.py'
--- lib/canonical/launchpad/webapp/interfaces.py	2010-07-15 15:59:24 +0000
+++ lib/canonical/launchpad/webapp/interfaces.py	2010-07-23 19:21:07 +0000
@@ -65,6 +65,10 @@
     """
 
 
+class IAPIDocRoot(IContainmentRoot):
+    """Marker interface for the root object of the apidoc vhost."""
+
+
 class ILaunchpadContainer(Interface):
     """Marker interface for objects used as the context of something."""
 

=== modified file 'lib/canonical/launchpad/webapp/publisher.py'
--- lib/canonical/launchpad/webapp/publisher.py	2010-03-15 17:17:05 +0000
+++ lib/canonical/launchpad/webapp/publisher.py	2010-07-23 19:21:07 +0000
@@ -544,9 +544,6 @@
 
 class RootObject:
     implements(ILaunchpadApplication, ILaunchpadRoot)
-    # These next two needed by the Z3 API browser
-    __parent__ = None
-    __name__ = 'Launchpad'
 
 
 rootObject = ProxyFactory(RootObject(), NamesChecker(["__class__"]))

=== modified file 'lib/canonical/launchpad/webapp/servers.py'
--- lib/canonical/launchpad/webapp/servers.py	2010-07-23 18:54:44 +0000
+++ lib/canonical/launchpad/webapp/servers.py	2010-07-23 19:21:07 +0000
@@ -61,7 +61,7 @@
 from canonical.launchpad.webapp.notifications import (
     NotificationRequest, NotificationResponse, NotificationList)
 from canonical.launchpad.webapp.interfaces import (
-    IBasicLaunchpadRequest, IBrowserFormNG,
+    IAPIDocRoot, IBasicLaunchpadRequest, IBrowserFormNG,
     ILaunchpadBrowserApplicationRequest, ILaunchpadProtocolError,
     INotificationRequest, INotificationResponse, IPlacelessAuthUtility,
     IPlacelessLoginSource, OAuthPermission, UnexpectedFormData)
@@ -1077,6 +1077,16 @@
     implements(canonical.launchpad.layers.FeedsLayer)
 
 
+# ---- apidoc
+
+class APIDocBrowserRequest(LaunchpadBrowserRequest):
+    implements(canonical.launchpad.layers.APIDocLayer)
+
+
+class APIDocBrowserPublication(LaunchpadBrowserPublication):
+    root_object_interface = IAPIDocRoot
+
+
 # ---- testopenid
 
 class TestOpenIDBrowserRequest(LaunchpadBrowserRequest):
@@ -1442,6 +1452,10 @@
         factories.append(VHRP('testopenid', TestOpenIDBrowserRequest,
                               TestOpenIDBrowserPublication))
 
+    if config.devmode:
+        factories.append(
+            VHRP('apidoc', APIDocBrowserRequest, APIDocBrowserPublication))
+
     # We may also have a private XML-RPC server.
     private_port = None
     for server in config.servers:

=== added file 'lib/lp/app/stories/apidoc.txt'
--- lib/lp/app/stories/apidoc.txt	1970-01-01 00:00:00 +0000
+++ lib/lp/app/stories/apidoc.txt	2010-07-23 19:21:07 +0000
@@ -0,0 +1,25 @@
+Launchpad's API docs
+====================
+
+It is generated by the zope.app.apidoc package, and can be seen on
+apidoc.launchpad.dev. (Note that this is just a smoke test)
+
+    >>> browser.open('http://apidoc.launchpad.dev')
+    >>> print extract_text(browser.contents)
+    Zope 3 API Documentation
+
+It uses frames, so here we open the URL of the main frame manually.
+
+    >>> browser.open('http://apidoc.launchpad.dev/++apidoc++/contents.html')
+    >>> print extract_text(browser.contents)
+    Zope 3 apidoc...
+    Welcome to the Zope 3 API documentation tool...
+    Code Browser...
+    Interfaces...
+
+And here we open the page of one of our interfaces, just to make sure they
+render fine.
+
+    >>> browser.open('http://apidoc.launchpad.dev/++apidoc++/Interface/'
+    ...              'lp.code.interfaces.branchcollection.IAllBranches/'
+    ...              'index.html')

=== modified file 'setup.py'
--- setup.py	2010-07-21 18:51:37 +0000
+++ setup.py	2010-07-23 19:21:07 +0000
@@ -71,6 +71,7 @@
         'z3c.pt',
         'z3c.ptcompat',
         'zc.zservertracelog',
+        'zope.app.apidoc',
         'zope.app.appsetup',
         'zope.app.component',
         'zope.app.dav', # ./package-includes/dav-configure.zcml
@@ -78,7 +79,9 @@
         'zope.app.exception',
         'zope.app.file',
         'zope.app.form',
+        'zope.app.onlinehelp',
         'zope.app.pagetemplate',
+        'zope.app.preference',
         'zope.app.publication',
         'zope.app.publisher',
         'zope.app.security',
@@ -86,6 +89,7 @@
         'zope.app.server',
         'zope.app.session',
         'zope.app.testing',
+        'zope.app.tree',
         'zope.app.zcmlfiles',
         'zope.app.wsgi',
         'zope.app.zapi',
@@ -102,6 +106,7 @@
         'zope.hookable', # indirect, via zope.app.component
         'zope.lifecycleevent',
         'zope.location',
+        'zope.login',
         'zope.pagetemplate',
         'zope.publisher',
         'zope.proxy',

=== modified file 'site.zcml'
--- site.zcml	2009-07-13 18:15:02 +0000
+++ site.zcml	2010-07-23 19:21:07 +0000
@@ -38,4 +38,5 @@
     <include file="summarizerequests.zcml" />
 
     <include package="zc.zservertracelog" />
+
 </configure>

=== modified file 'versions.cfg'
--- versions.cfg	2010-07-21 18:51:37 +0000
+++ versions.cfg	2010-07-23 19:21:07 +0000
@@ -124,6 +124,7 @@
 ZODB3 = 3.9.2
 zodbcode = 3.4.0
 zope.annotation = 3.5.0
+zope.app.apidoc = 3.7.3
 zope.app.applicationcontrol = 3.5.1
 zope.app.appsetup = 3.12.0
 zope.app.authentication = 3.6.1
@@ -146,7 +147,10 @@
 zope.app.interface = 3.5.0
 zope.app.locales = 3.5.1
 zope.app.localpermission = 3.7.0
+zope.app.onlinehelp = 3.5.2
 zope.app.pagetemplate = 3.7.1
+zope.app.preference = 3.8.1
+zope.preference = 3.8.0
 zope.app.principalannotation = 3.6.1
 zope.app.publication = 3.9.0
 zope.app.publisher = 3.10.0
@@ -159,6 +163,7 @@
 # not in ZTK
 zope.app.session = 3.6.0
 zope.app.testing = 3.7.5
+zope.app.tree = 3.6.0
 zope.app.wsgi = 3.6.0
 # not in ZTK
 zope.app.zapi = 3.4.1
@@ -198,6 +203,7 @@
 zope.interface = 3.5.2
 zope.lifecycleevent = 3.5.2
 zope.location = 3.7.0
+zope.login = 1.0.0
 zope.minmax = 1.1.1
 zope.modulealias = 3.4.0
 zope.pagetemplate = 3.5.0
@@ -207,7 +213,7 @@
 zope.processlifetime = 1.0
 zope.proxy = 3.5.0
 zope.ptresource = 3.9.0
-zope.publisher = 3.10.0
+zope.publisher = 3.12.0
 zope.schema = 3.5.4
 zope.security = 3.7.1
 zope.securitypolicy = 3.6.1

=== modified file 'zopeapp.zcml'
--- zopeapp.zcml	2009-07-13 18:15:02 +0000
+++ zopeapp.zcml	2010-07-23 19:21:07 +0000
@@ -25,6 +25,8 @@
   <include package="zope.app.interface" />
   <include package="zope.app.security" />
 
+  <include package="zope.login" />
+
   <!--
   <include package="zope.app.observable" />
   <include package="zope.app.annotation" />