Incorrect accquiring bugdir command line argument

The calling below seems like a typo to me. How can we index with
a variable which has not been initialized yet?

setup.py: Add a '# Copyright' stub for update-copyright.py

add a comma to the classifiers

Merge remote-tracking branch 'esr/master'

* esr/master:
  Typo fix.

Merge remote-tracking branch 'mcepl/utf8_user'

* mcepl/utf8_user:
  Make BE working with non-ASCII username.

Make BE working with non-ASCII username.

Signed-off-by: Matěj Cepl <mcepl@redhat.com>

command:target: Print full ID (bugdir/bug) on --resolve

The old implementation just printed the bug UUID (without the bugdir/
prefix).  This lead to the command we suggest in `be target --help`:

  $ be depend --status -closed,fixed,wontfix --severity -target \
    $(be target --resolve)

failing with an invalid ID.

Reported-by: Michael Sperber <sperber@deinprogramm.de>

command:html: Rework comment <div> closing

Comment nesting wasn't working properly before, where you could get
things like:

  <div class="comment root" id="a">
  </div>  <!-- close a -->
  <div class="comment" id="a/b">
  <div class="comment" id="a/b/c">
  <div class="comment root" id="d">
  </div>  <!-- close d -->
  </div>  <!-- close a/b/c -->
  </div>  <!-- close a/b -->

from a comment tree (using fake ids) of:

  .
  |-- a
  |   `-- a/b
  |       `-- a/b/c
  `-- d

The new handling pushes the `div_close(depth)` call to the front of
the comment block, because a comment's depth tells us how many of the
already-rendered comments we need to close.  Closing comments at the
top of the block means that we'll always have at least one unclosed
comment to close after the comment loop completes.  With the new
handling, we'll get a more appropriate:

  <div class="comment root" id="a">
  <div class="comment" id="a/b">
  <div class="comment" id="a/b/c">
  </div>  <!-- close a/b/c -->
  </div>  <!-- close a/b -->
  </div>  <!-- close a -->
  <div class="comment root" id="C29a03522-ed6e-4a9a-8823-23a1c513865f">
  </div>  <!-- close d -->

Reported-by: Owen Jacobson <owen.jacobson@grimoire.ca>

Typo fix.

util:wsgi: Don't clobber `handler` when clearing StreamHandlers

This bug was introduced in:

  commit 400c9251eedbd1caa3b28135b4bc5d2bf2124ac5
  Author: W. Trevor King <wking@tremily.us>
  Date:   Thu Jan 24 02:43:53 2013 -0500

    util:wsgi: If we're logging to a file, shift libbe.LOG too

where the removed handlers clobbered our initial
TimedRotatingFileHandler.

util:wsgi: If we're logging to a file, shift libbe.LOG too

This avoids attempts to log to stderr if we're daemonizing the server.

Transition to libbe.LOG for logging

This makes it easier to tweak log verbosity and redirect logs to other
handlers.  For example, the WSGI servers are unstable with stderr
closed, and crash with an IOError if they try to print a warning to
stderr.

MANIFEST.in: Distribute AUTHORS with the BE source

MANIFEST.in: Distribute COPYING with the BE source

setup.py: Mention Jinja and CherryPy as requirements

Unfortunately, none of the current Python installation tools
(easy_install, pip, others?) actaully use the `Requires` field that
this populates [1,2], and it's gone since PEP 345, replaced by
`Requires-Dist` [2,3,4].  Eventually a new packaging library
(distutils2, packaging, distlib, ...) will land in the Python standard
library and we can use whatever interface it provides for specifying
dependencies [5].

[1]: http://blog.doughellmann.com/2007/11/requiring-packages-with-distutils.html
[2]: http://ziade.org/2010/02/10/pep-345-and-386-accepted-summary-of-changes/
[3]: http://www.python.org/dev/peps/pep-0345/#requires-dist-multiple-use
[4]: http://www.python.org/dev/peps/pep-0426/#requires-dist-multiple-use
[5]: http://ncoghlan_devs-python-notes.readthedocs.org/en/latest/pep_ideas/core_packaging_api.html

storage:util:upgrade: Strip any trailing space from the version

Not just '\n'.  Mark Mikofski reported an error on the upgrade from
1.4 to 1.5 on MS Windows:
> upgrading bugdir from "Bugs Everywhere Directory v1.4" to "Bugs Everywhere Directory v1.5"
> Traceback (most recent call last):
>   ...
>   File "c:\...\libbe\storage\util\upgrade.py", line 141, in check_initial_version
>     assert version == self.initial_version, '%s: %s' % (path, version)
> AssertionError: c:\...\.be\version: Bugs Everywhere Directory v1.4
>
> **notes:** I set a breakpoint and it does seem that they are not the same
> (Pdb) self.initial_version
> 'Bugs Everywhere Directory v1.4'
> (Pdb) version
> u'Bugs Everywhere Directory v1.4\r'

We don't need to convert to Unicode, because on Python 2.7:

  $ python2.7 -c "print('a' == u'a')"
  True

Strange, but true ;).  One day we'll migrate BE to Python 3...

update-copyright: Bump to version 0.5 (requires Python 3)

Upgrade to match our configuration file.

libbe:command:util: fix bugdir access for complete_status and complete_severity

Fix a bug introduced by:

  commit 4db1a045a0606bead191a563abc54dfa8352efe0
  Author: W. Trevor King <wking@tremily.us>
  Date:   Wed Aug 29 23:26:17 2012 -0400

    Rewrite commands to use bugdirs instead of a single bugdir.

Reported-by: James Spencer <james.s.spencer@gmail.com>

ui:util:pager: cleanup pager implementation

Changes:

* Import libraries with an underscore prefix to avoid polluting the
  module's public namespace.
* Use a copy `env` to avoid messing with the child process'
  environment.
* Pass the tweaked environment on to the PAGER (e.g. for PATH).
* Handle PAGER='' (by not paging).
* Use shlex.split to handle cases like PAGER='less -FRSX' (thanks to
  Da_Blitz from pocketnix.org for the bug report and shlex idea).

ui:util:pager: document Nathan Weizenbaum as author of Ruby inspiration

Nathan's post is released under CC BY-SA 3.0 Unported.  According the
the FSF, the CC BY-SA 2.0 Generic was not compatible with BE's GPLv2+
[1].  I expect my Python implementation is sufficiently different from
Nathan's original notes to be classified as "fair use" and not an
"adaptation".

[1]: http://www.gnu.org/licenses/license-list.html#ccbysa

release.py: use Python 2.7 for sphinx-build

doc:Makefile: use Python 2.7 for generate-libbe-txt.py

storage:base: convert to Python 3.3 compatibility

storage: convert to Python 3 compatibility

version: convert to Python 3 compatibility

test: convert to Python 3 compatibility

release.py: build HTML docs when cutting releases

util:wsgi: handle all dispatch() exceptions in BEExceptionApp

This brings BEExceptionApp into closer agreement with
libbe.ui.command_line.dispatch(), and avoids having the server go down
when a user submits a silly command.

util:http: special handling for HTTP_USER_ERROR in get_post_url().

Use libbe.util.http.HTTP_USER_ERROR everywhere instead of hardcoding 418

util:wsgi: catch NoIDMatches in BEExceptionApp

util:wsgi: add --daemon, --pidfile, and --logfile

This allows you to manage BE servers from inetd scripts, etc.
Shortcomings of the current implementation:

* ServerCommand._daemonize() currently only sets a SIGTERM handler and
  double forks.  If you want to do this right, see PEP 3143.
  Unfortunately, the PEP seems to have stalled, python-daemon appears
  unmaintained, and I don't care enough at the moment to do this
  right.

* ServerCommand._get_pidfile() races between checking for an existing
  PID file and claiming the file itself.  It is possible that two
  processes would check around the same time, and both see no existing
  file.  Then they would both open the PID file and write their pid,
  without noticing that the other process was contending for the file.
  Solving this requires file locking, which is difficult to do
  portably.  This shouldn't be an issue in normal operation, where
  each server will be using its own PID file path.

util:wsgi: fix From -> from typo in pyOpenSSL comment

util:wsgi: fix get_cert_filenames -> _get_cert_filenames typo

This was broken in the creation of libbe.util.wsgi from
libbe.command.serve:

  commit 0fa17f6bf6a809df14ae1930542059a9e62066b0
  Author: W. Trevor King <wking@tremily.us>
  Date:   Mon Aug 27 13:37:58 2012 -0400

    libbe:util:wsgi: extract WSGI utilities into a separate module.

util:wsgi: import os.path for _get_cert_filenames()

This was lost in the creation of libbe.util.wsgi from
libbe.command.serve:

  commit 0fa17f6bf6a809df14ae1930542059a9e62066b0
  Author: W. Trevor King <wking@tremily.us>
  Date:   Mon Aug 27 13:37:58 2012 -0400

    libbe:util:wsgi: extract WSGI utilities into a separate module.

doc:install: CherryPy is *not* used for HTTP, only for HTTPS.

For plain HTTP, we use wsgiref.simple_server from the stdlib.

Also include the `html` command as a WSGI-based command.

util:wsgi: fix Clossing -> Closing typo.

util:wsgi: remove %default from option help strings

command:html: remove %default from option help strings

README: Update NumPy/SciPy doc link

README: wrap doc/index.txt reference in backticks

File names, code, etc., should have special markup so they aren't
confused with regular text.

storage:util:upgrade: use YAML parser to get BE Tree 1 0 settings

This fixes the "Bugs Everywhere Tree 1 0" -> "Bugs Everywhere
Directory v1.1" upgrade broken by the switch to JSON in:

  commit a95915c6c7d6a4e29c1e5547580e0c1fed2467e1
  Author: W. Trevor King <wking@tremily.us>
  Date:   Mon Sep 17 08:14:21 2012 -0400

    storage:util:mapfile: convert YAML settings to JSON.

misc:completion:be.zsh: update import-xml --comment-root -> --root

This catches the script up with:

  commit 4db1a045a0606bead191a563abc54dfa8352efe0
  Author: W. Trevor King <wking@tremily.us>
  Date:   Wed Aug 29 23:26:17 2012 -0400

    Rewrite commands to use bugdirs instead of a single bugdir.

test_usage.sh: update import-xml --comment-root -> --root

This catches the tests up with:

  commit 4db1a045a0606bead191a563abc54dfa8352efe0
  Author: W. Trevor King <wking@tremily.us>
  Date:   Wed Aug 29 23:26:17 2012 -0400

    Rewrite commands to use bugdirs instead of a single bugdir.

storage:vcs:git: don't accept pygit2 version 0.17.3.

My Repository.revparse_single() series was merged into pygit2 with:

  Merge: 3e9daa4 0238fb7
  Author: J. David Ibáñez <jdavid.ibp@gmail.com>
  Date:   Tue Sep 25 15:10:55 2012 +0200

    Merge remote-tracking branch 'wking/revparse'

But this happened after the 0.17.3 release.  The next pygit2 release
should contain the .revparse_single() code.

The getattr() hackery works because versions of pygit2 before 0.17.3
lacked a __version__ attribute.

doc:power: add Zsh completion location and update Bash install location

This puts both scripts in the right spot on Gentoo, and shows the
suggested installed filename (not just the suggested directory).

command:serve_*: remove wordy "with, for example" from help message

command:serve_commands: fix --repo -> --server in help message

doc:tutorial: use a Git tag for the `be diff` example

I haven't tagged 1.1.0 yet, but earlier tags do not use Bugs
Everywhere Directory v1.5, and we don't have on-the-fly storage
updates yet.

doc:tutorial: fix ReST formatting for `be show --xml` example

doc:tutorial: move "you think" before quote in initialization section

doc:tutorial: fix ReST formatting for first `be comment` example

doc:install: mention that we *do* post releases now

doc:install: mention that PyYAML is now optional

storage:util:upgrade: make yaml import optional (unless it isn't)

Importing `yaml` may fail (if the user doesn't have PyYAML installed),
but don't die until we need to use it.  This way users without the old
YAML formats on disk can run BE without installing PyYAML.

command: use mapfiles (JSON) instead of YAML for the command server

storage:util:mapfile: add `context` argument to generate()

doc/install: fix paragraph indentation in man page installation discussion

doc/install: point out relevant Debian bugs in a comment

doc:install: fix dependency table ReST formatting

The header had been broken by

  commit f174d8943c2edea25306ab522c27f69bbebd0be3
  Author: W. Trevor King <wking@tremily.us>
  Date:   Thu May 10 08:56:02 2012 -0400

    Update CherryPy dependency package to python-cherrypy3 on Debian.

doc:index: mention that in-branch-bugs are not the only way

doc: clean up top level module docstrings

libbe:bugdir: avoid SimpleBugDir is not a item name

This happens because SimpleBugDir is not defined if libbe.TESTING is
not set before importing libbe.bugdir.

doc: update :attr: to :py:attr: for modern Sphinx.

doc: update :data: to :py:data: for modern Sphinx.

doc: update :meth: to :py:meth: for modern Sphinx.

doc:config: use :file: to markup filenames.

doc: update :class: to :py:class: for modern Sphinx.

storage:vcs:base: avoid `is not a item name` Sphinx error.

doc:conf: use `version (date)` in Sphinx docs

Since

  commit bed7587fe4910f8e4b892a09675279c5a4ab5484
  Author: W. Trevor King <wking@tremily.us>
  Date:   Thu Oct 25 19:07:09 2012 -0400

    version: use abbreviated SHA instead of  explicit _VERSION in master branch

the version SHA will either be explicit in version(), or version()
will return a release tag.  This makes the long SHA in the Sphinx docs
unnecessary, so we can replace it with the more interesting commit
date.

doc: update :mod: to :py:mod: for modern Sphinx.

doc: update :func: to :py:func: for modern Sphinx.

storage:util:config: path() now defaults to ~/.config/bugs-everywhere

Add a documentation section discussing the config file, respect
XDG_CONFIG_HOME, and add BE_CONFIG_PATH.

release.py: strip trailing whitespace from ChangeLog.

release.py: sign tags when cutting releases.

release.py: use current Python executable for ./be invocation

This allow you to cut a release where your system Python is not
compatible with be.  For example:

  $ python --version
  Python 3.2.3
  $ python2.7 ./release.py 1.1.0

setup.py: flesh out setup in preparation for PyPI posting

setup.py: change setup.py name to something more PyPI friendly.

setup.py: don't put the date in the setup.py version (PyPI gets mad).

version: use abbreviated SHA instead of  explicit _VERSION in master branch

Only official releases get a version number, which should help avoid
confusion.  If you're running a live checkout, you shouldn't be scared
off by SHAs.

release.py: pull main code into main().

update-copyright: update to the python3 branch.

release.py: remove dependency on deprecated libbe.subproc.Pipe

Pipe has been gone since:

  commit f1ae4b7f3fea6fb78a54ee5073aee648a3d73179
  Author: W. Trevor King <wking@drexel.edu>
  Date:   Sat Feb 25 11:16:01 2012 -0500

    Remove util.subproc.Pipe, as we no longer use it in BE.

interfaces:web:web: use bugdir_bug_comment_from_user_id() in CFBE.

This gets CFBE working with:

  commit 4db1a045a0606bead191a563abc54dfa8352efe0
  Author: W. Trevor King <wking@tremily.us>
  Date:   Wed Aug 29 23:26:17 2012 -0400

    Rewrite commands to use bugdirs instead of a single bugdir.

I'm not sure how much work it would take to rewrite CFBE to use
multiple bugdirs.

bugdir|bug|comment: update default settings string to be value JSON.

storage:util:mapfile: fix YAML -> JSON in docstrings.

This should have been done back in:

  commit a95915c6c7d6a4e29c1e5547580e0c1fed2467e1
  Author: W. Trevor King <wking@tremily.us>
  Date:   Mon Sep 17 08:14:21 2012 -0400

    storage:util:mapfile: convert YAML settings to JSON.

I also add an empty-settings generation as a sanity check.

setup.py: make libbe._version optional.

Thanks to Timmie for pointing this out:

From: Timmie <timmichelsen@gmx-topmail.de>
Date: Thu, 25 Oct 2012 09:42:23 +0000 (UTC)
Subject: Re: [Be-devel] NotImplementedError with Bazaar

...
I notices the following glichtes during the install:

D:\be-be-master\be-be>python setup.py install
WARNING:root:unable to import libbe._version: No module named _version
Traceback (most recent call last):
  File "setup.py", line 6, in <module>
    from libbe import _version, version
ImportError: cannot import name _version
...

.update-copyright.conf: update to pipe separators.

This brings the config file up to speed with the following
update-copyright commit:

  commit 3c68a1a48419d8b2bbc2ce0e7f1700b996ec30e9
  Author: W. Trevor King <wking@tremily.us>
  Date:   Fri Oct 19 21:52:48 2012 -0400

    project: for consistency, also separate ignored paths with pipes

Ran update-copyright.py.

.mailmap: consilidate Niall Douglas' addresses.

update-copyright: update to current update-copyright (v0.4+).

doc:tutorial: fix typos in the attachment examples.

I wrote the actual patch, but Nicolas gave pretty unambiguous
directions, so I'm making him the author.

On Wed, Sep 19, 2012 at 11:03:39AM -0400, Nicolas Bigaouette wrote:
> Hi all,
>
> I'm trying out Bugs Everywhere, pretty neat!
>
> Reading the documentation, I see it's possible to add attachment to the bug
> report. The "commenting on bugs" section of the tutorial[1] gives the
> command for the attachment:
>
> > $ cat screenshot.png | be comment --content-type image/png bea/28f
> >
> or the following to reply to a specific comment:
>
> > $ be comment bea/28f “Whosit dissapears when you mouse-over whatsit.”
> > $ cat screenshot.png | be comment --content-type image/png bea/28f/41d
> >
>
> Both these commands fail as they will try to open the editor for entering
> the comment.
>
> The fix is simply to append a single dash "-" at the end of the attachment
> command to tell "be comment" to read the comment from stdin (see "be help
> comment").
>
> Also, the second example has not the same formatting as the first one. The
> first one seems to have a "code" formatting, while the second is just
> indented without any line breaks.
>
> Thanks!
>
> Nicolas
>
> [1] http://docs.bugseverywhere.org/tutorial.html#commenting-on-bugs

storage:vcs:git: check for existence of pygit2.__version__.

Now that my pull request has been accepted, we can be fairly confident
that future releases of pygit2 will expose this attribute.  The
accepted patch was a bit different from the original submission:

Add 'pygit2.__version__' for easy access from client software.
  https://github.com/libgit2/pygit2/pull/128
  commit f10d2b7b3f0c67d81b175326035e4813420156bd

command:html: convert -moz-border-radius to border-radius.

border-radius and friends are standard CSS3 [1].

[1]: http://www.w3.org/TR/css3-background/#the-border-radius

command.html: display "Target:" detail for bugs with targets.

command:html: fix two auto% -> auto typos in CSS.

These were introduced in

  commit d61d54ce33022f0613c5e19e2f52be4ab77c4664
  Author: Gianluca Montecchi <gian@grys.it>
  Date:   Mon Jan 24 22:47:32 2011 +0100

    New html output for html command

and propogated in

  commit 5b6be7a511670cdf1961d13040cddcb34e70b8a1
  Author: W. Trevor King <wking@drexel.edu>
  Date:   Sun Apr 17 02:41:07 2011 -0400

    Rework `be html` to use Jinja2 templates.

bea864: upgrade to Bugs Everywhere Directory v1.5 (YAML -> JSON).

storage:util:mapfile: convert YAML settings to JSON.

This is faster and still readable.  I also add an upgrader to convert
bug directories from:
  Bugs Everywhere Directory v1.4
to:
  Bugs Everywhere Directory v1.5
but I haven't upgraded the local bugdir yet.

storage:vcs:git: move Git to ExecGit and add PygitGit using pygit2.

If `pygit2` is installed, use it (via PygitGit) rather than calling
the stand-alone `git` executable for all the Git (via ExecGit) for all
the Git storage stuff.  This saves one serializing/deserializing and
process setup/teardown.  I timed each test suite by commenting out one
of the `make_vcs_testcase_subclasses()` calls at the end of `git.py`
and running

  $ time python test.py libbe.storage.vcs.git

The ExecGit tests ran in 13.7s and the PygitGit tests ran in 3.6s for
a 3.8x speedup.

I had to stretch pygit2 a bit to get a clean fit, so if you want to
test this, you'll need to build pygit2 with the following merge
requests:

  Add 'pygit2.__version__' for easy access from client software.
    https://github.com/libgit2/pygit2/pull/128
    commit 0238fb72dfdf2a2308f2da347717cbaafddc4b83
  signature: Add keyword argument parsing to Signature().
    https://github.com/libgit2/pygit2/pull/129
    commit c934858b629f40221406f34166dd77e881b9d5fd
  repository: add Repository.revparse_single()
    https://github.com/libgit2/pygit2/pull/131
    commit 3afdc8b2f59ed137531671fedde36f3a39cbcc9d

storage:vcs:base: fix _gets_ -> _get_ typo in test_gets_existing_user_id.

VCS_get_user_id_TestCase.test_gets_existing_user_id is now
VCS_get_user_id_TestCase.test_get_existing_user_id