Merge lp:~bac/launchpad/bug-421976-pgp-ssh-wiki into lp:launchpad

[Brad Crittenden]

[Brad Crittenden (bac)]

= Summary =

Bug 421976 addresses the need to update three page templates:
    person-editpgpkeys.pt
    person-editsshkeys.pt
    person-editwikinames.pt

== Proposed fix ==

The changes made were mostly mechanical. Details are below in the QA section.

== Pre-implementation notes ==

N/A

== Tests ==

bin/test -vvm lp.registry -t gpg -t wiki -t ssh
== Demo and Q/A ==

Screenshots, old and new, are
at:http://people.canonical.com/~bac/bug-421976-pgp-ssh-wiki/

Login as Salgado for these demos.

Each of these page templates is a mush of hand-built forms rendered
using a LaunchpadView. At some point these pages should be converted
to LaunchpadFormView but for expediency I am not now.

For all pages:
* added label and page_title to the views and removed from pagetitles.py.
* faked LaunchpadFormView by putting the view/label into an <h1> at
  the top of the page.
* Added a 'cancel_url' property and manually use it in the template.
  The cancel url is set to '+edit' for all, though perhaps just
  returning to the user's page would be best. It depends on what the
  +edit page ends up looking.
* Several of these pages use the Launchpad help system. Is the pop-up
  help system being removed? The conversion primer indicates that is
  the case that decision needs to be vetted.

* https://launchpad.dev/~salgado/+editwikinames
  * No changes beyond the above.

* https://launchpad.dev/~salgado/+editsshkeys
  * Discovered the textarea has always been absurdly small due to
    using 'height' and 'width' rather than the correct 'rows' and
    'cols'. Now it renders as a usable size.
  * This form should use a file chooser that gets uploaded rather than
    a text widget that the user must paste into.

* https://launchpad.dev/~salgado/+editpgpkeys
  * No changes beyond the above.

= Launchpad lint =

Checking for conflicts. and issues in doctests and templates.
Running jslint, xmllint, pyflakes, and pylint.
Using normal rules.

Linting changed files:
  lib/canonical/launchpad/pagetitles.py
  lib/lp/registry/browser/person.py
  lib/lp/registry/stories/foaf/xx-add-sshkey.txt
  lib/lp/registry/stories/gpg-coc/01-claimgpg.txt
  lib/lp/registry/templates/person-editpgpkeys.pt
  lib/lp/registry/templates/person-editsshkeys.pt
  lib/lp/registry/templates/person-editwikinames.pt

== Pylint notices ==

lib/lp/registry/browser/person.py
    118: [F0401] Unable to import 'lazr.delegates' (No module named delegates)
    119: [F0401] Unable to import 'lazr.config' (No module named config)
    120: [F0401] Unable to import 'lazr.restful.interface' (No module named restful)

[Curtis Hovey (sinzui)]

This is great. Thanks Brad. I have one trivial request before you land this...

=== modified file 'lib/lp/registry/templates/person-editpgpkeys.pt'
--- lib/lp/registry/templates/person-editpgpkeys.pt 2009-07-17 17:59:07 +0000
+++ lib/lp/registry/templates/person-editpgpkeys.pt 2009-09-09 13:49:06 +0000

...

@@ -173,7 +170,7 @@
       <input type="hidden" name="action" value="claim_gpg" />
       <h2>Import an OpenPGP key</h2>

- <p>To start using an OpenPGP key with your Launchpad account, simply paste its fingerprint below. (<a href="/+help/import-pgp-key.html" target="help">How to get the fingerprint</a>)
+ <p>To start using an OpenPGP key with your Launchpad account, simply paste its fingerprint below. (<a href="/+help/import-pgp-key.html" target="help">How to get the fingerprint</a>)</p>

Can you wrap this? I had to pan for some time to see what changed.

...

review: Approve (code, ui)

=== modified file 'lib/canonical/launchpad/pagetitles.py'
--- lib/canonical/launchpad/pagetitles.py	2009-09-09 09:24:47 +0000
+++ lib/canonical/launchpad/pagetitles.py	2009-09-09 13:33:33 +0000
@@ -712,12 +712,6 @@
 
 person_editemails = ContextDisplayName(smartquote("%s's e-mail addresses"))
 
-person_editpgpkeys = ContextDisplayName(smartquote("%s's OpenPGP keys"))
-
-person_editsshkeys = ContextDisplayName(smartquote("%s's SSH keys"))
-
-person_editwikinames = ContextDisplayName(smartquote("%s's wiki names"))
-
 # person_foaf is an rdf file
 
 person_hwdb_submissions = ContextDisplayName(

=== modified file 'lib/lp/registry/browser/person.py'
--- lib/lp/registry/browser/person.py	2009-09-08 14:07:32 +0000
+++ lib/lp/registry/browser/person.py	2009-09-09 13:33:33 +0000
@@ -3182,6 +3182,17 @@
 
 
 class PersonEditWikiNamesView(LaunchpadView):
+
+    @property
+    def label(self):
+        return smartquote("%s's wiki names" % self.context.displayname)
+
+    page_title = label
+
+    @property
+    def cancel_url(self):
+        return canonical_url(self.context, view_name="+edit")
+
     def _validateWikiURL(self, url):
         """Validate the URL.
 
@@ -3387,6 +3398,16 @@
         else:
             raise UnexpectedFormData("Unexpected action: %s" % action)
 
+    @property
+    def label(self):
+        return "Change your SSH keys"
+
+    page_title = label
+
+    @property
+    def cancel_url(self):
+        return canonical_url(self.context, view_name="+edit")
+
     def add_ssh(self):
         sshkey = self.request.form.get('sshkey')
         try:
@@ -3464,6 +3485,16 @@
     error_message = None
     info_message = None
 
+    @property
+    def cancel_url(self):
+        return canonical_url(self.context, view_name="+edit")
+
+    @property
+    def label(self):
+        return "Change your OpenPGP keys"
+
+    page_title = label
+
     def keyserver_url(self):
         assert self.fingerprint
         return getUtility(

=== modified file 'lib/lp/registry/stories/foaf/xx-add-sshkey.txt'
--- lib/lp/registry/stories/foaf/xx-add-sshkey.txt	2009-06-11 18:09:32 +0000
+++ lib/lp/registry/stories/foaf/xx-add-sshkey.txt	2009-09-09 16:16:18 +0000
@@ -47,10 +47,7 @@
 
     >>> browser.getLink('Add an SSH key').click()
     >>> print browser.title
-    Guilherme Salgado's SSH keys
-    >>> print extract_text(
-    ...     find_main_content(browser.contents).h2)
-    Add an SSH key
+    Change your SSH keys
 
 Any key must be of the form "keytype keytext comment", where keytype must be
 either ssh-rsa or ssh-dss.  If the key doesn't match the expected format, an
@@ -127,13 +124,13 @@
     Guilherme Salgado in Launchpad
     >>> print extract_text(
     ...     find_tag_by_id(browser.contents, 'sshkeys'))
-    SSH Keys: 
+    SSH Keys:
     salgado@canario
     Update SSH keys
     salgado@canario
     >>> browser.getLink('Update SSH keys').click()
     >>> print browser.title
-    Guilherme Salgado's SSH keys
+    Change your SSH keys
 
     >>> browser.getControl('Remove', index=0).click()
     >>> soup = find_main_content(browser.contents)

=== modified file 'lib/lp/registry/stories/gpg-coc/01-claimgpg.txt'
--- lib/lp/registry/stories/gpg-coc/01-claimgpg.txt	2009-07-23 13:44:13 +0000
+++ lib/lp/registry/stories/gpg-coc/01-claimgpg.txt	2009-09-09 16:16:18 +0000
@@ -22,8 +22,8 @@
     >>> browser = setupBrowser(auth='Basic [e-mail]:test')
     >>> browser.open("http://launchpad.dev/~name12/+edit")
     >>> browser.getLink('OpenPGP Keys').click()
-    >>> browser.title
-    "Sample Person's OpenPGP keys"
+    >>> print browser.title
+    Change your OpenPGP keys
     >>> browser.getControl(name='DEACTIVATE_GPGKEY')
     Traceback (most recent call last):
     ...

=== modified file 'lib/lp/registry/templates/person-editpgpkeys.pt'
--- lib/lp/registry/templates/person-editpgpkeys.pt	2009-07-17 17:59:07 +0000
+++ lib/lp/registry/templates/person-editpgpkeys.pt	2009-09-09 13:49:06 +0000
@@ -9,15 +9,12 @@
   xmlns:tal="http://xml.zope.org/namespaces/tal"
   xmlns:metal="http://xml.zope.org/namespaces/metal"
   xmlns:i18n="http://xml.zope.org/namespaces/i18n"
-  xml:lang="en"
-  lang="en"
-  dir="ltr"
-  metal:use-macro="view/macro:page/onecolumn"
+  metal:use-macro="view/macro:page/main_only"
   i18n:domain="launchpad"
 >
   <body>
   <div metal:fill-slot="main">
-    <h1>Change your OpenPGP keys</h1>
+    <h1 tal:content="view/label" />
 
     <p tal:condition="view/error_message"
        tal:content="structure view/error_message/escapedtext" class="error message"
@@ -173,7 +170,7 @@
       <input type="hidden" name="action" value="claim_gpg" />
       <h2>Import an OpenPGP key</h2>
 
-      <p>To start using an OpenPGP key with your Launchpad account, simply paste its fingerprint below. (<a href="/+help/import-pgp-key.html" target="help">How to get the fingerprint</a>)
+      <p>To start using an OpenPGP key with your Launchpad account, simply paste its fingerprint below. (<a href="/+help/import-pgp-key.html" target="help">How to get the fingerprint</a>)</p>
 
           <table>
             <tbody>
@@ -190,11 +187,14 @@
             </tbody>
           </table>
           <p>
-            Next, Launchpad will e-mail you using
+            Next, Launchpad will send e-mail to you at
             <code tal:content="context/preferredemail/email"/> with instructions
             on finishing the process.
           </p>
-          <div><input type="submit" name="import" value="Import Key"/></div>
+          <div>
+            <input type="submit" name="import" value="Import Key"/>
+            or&nbsp; <a tal:attributes="href view/cancel_url">Cancel</a>
+          </div>
 
       </form>
     </div>

=== modified file 'lib/lp/registry/templates/person-editsshkeys.pt'
--- lib/lp/registry/templates/person-editsshkeys.pt	2009-07-17 17:59:07 +0000
+++ lib/lp/registry/templates/person-editsshkeys.pt	2009-09-08 00:28:41 +0000
@@ -3,15 +3,12 @@
   xmlns:tal="http://xml.zope.org/namespaces/tal"
   xmlns:metal="http://xml.zope.org/namespaces/metal"
   xmlns:i18n="http://xml.zope.org/namespaces/i18n"
-  xml:lang="en"
-  lang="en"
-  dir="ltr"
-  metal:use-macro="view/macro:page/onecolumn"
+  metal:use-macro="view/macro:page/main_only"
   i18n:domain="launchpad"
 >
   <body>
   <div metal:fill-slot="main">
-    <h1>Change your SSH keys</h1>
+    <h1 tal:content="view/label" />
 
     <p>
       You need to register an SSH key with Launchpad to be able to publish
@@ -55,11 +52,16 @@
           <code>~/.ssh/id_dsa.pub</code> or <code>~/.ssh/id_rsa.pub</code>).
           Only SSH v2 keys are supported.
           <a href="https://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair">
-            How do I get a public key?
+            How do I create a public key?
           </a>
         </div>
-        <textarea name="sshkey" width="30" height="6"></textarea>
-        <input type="submit" value="Import Public Key" />
+        <div>
+          <textarea name="sshkey" cols="30" rows="12"></textarea>
+        </div>
+        <div style="margin-top: 0.5em;">
+          <input type="submit" value="Import Public Key" />
+          or&nbsp; <a tal:attributes="href view/cancel_url">Cancel</a>
+        </div>
       </div>
     </form>
     </div>

=== modified file 'lib/lp/registry/templates/person-editwikinames.pt'
--- lib/lp/registry/templates/person-editwikinames.pt	2009-07-17 17:59:07 +0000
+++ lib/lp/registry/templates/person-editwikinames.pt	2009-09-08 00:28:41 +0000
@@ -3,17 +3,13 @@
   xmlns:tal="http://xml.zope.org/namespaces/tal"
   xmlns:metal="http://xml.zope.org/namespaces/metal"
   xmlns:i18n="http://xml.zope.org/namespaces/i18n"
-  xml:lang="en"
-  lang="en"
-  dir="ltr"
-  metal:use-macro="context/@@main_template/master"
+  metal:use-macro="view/macro:page/main_only"
   i18n:domain="launchpad"
 >
   <body>
 
   <div metal:fill-slot="main">
-
-    <h1>Your wiki names</h1>
+    <h1 tal:content="view/label" />
 
     <p tal:condition="view/error_message"
        tal:content="structure view/error_message/escapedtext"
@@ -63,7 +59,7 @@
     <tr>
       <td colspan="2"><h2>New wiki name</h2></td>
     </tr>
-    
+
     <tr>
       <td><label>Wiki Base URL:</label></td>
       <td><label>Wiki Name:</label></td>
@@ -88,8 +84,8 @@
 
   <div class="formControls">
     <input type="submit" value="Save Changes" name="SAVE" />
+    or&nbsp; <a tal:attributes="href view/cancel_url">Cancel</a>
   </div>
-
   </form>
   </div>