Merged in a management command which provides glue code for creation and maintenance of Trac issue tracker and wiki installations per group. New groups of type wg, rg, and area will autmatically receive a Trac instance.

 - Legacy-Id: 12182

Author: levkowetz

env/.gitignore

@@ -0,0 +1,7 @@
+/bin
+/share
+/selenium
+/etc
+/local
+/lib
+/include

env/pip.conf

@@ -0,0 +1,3 @@
+[install]
+ignore-installed = true
+

ietf/checks.py

@@ -1,5 +1,6 @@
 import os
 import time
+from textwrap import dedent
 
 from django.conf import settings
 from django.core import checks
@@ -209,3 +210,32 @@ def cache_error(msg, errnum):
             errors.append(cache_error("Cache didn't accept session cookie age", "E0016"))
     return errors
 
+@checks.register('cache')
+def check_svn_import(app_configs, **kwargs):
+    errors = []
+    if settings.SERVER_MODE == 'production':
+        try:
+            import svn                  # pyflakes:ignore
+        except ImportError as e:
+            errors.append(checks.Critical(
+                "Could not import the python svn module:\n   %s\n" % e,
+                hint = dedent("""
+                    You are running in production mode, and the subversion bindings for python
+                    are necessary in order to run the Trac wiki glue scripts.
+
+                    However, the subversion bindings seem to be unavailable.  The subversion
+                    bindings are not available for install using pip, but must be supplied by
+                    the system package manager.  In order to be available within a python
+                    virtualenv, the virtualenv must have been created with the
+                    --system-site-packages flag, so that the packages installed by the system
+                    package manager are visible.
+
+                    Please install 'python-subversion' (Debian), 'subversion-python' (RedHat,
+                    CentOS, Fedora), 'subversion-python27bindings' (BSD); and set up a
+                    virtualenv using the --system-site-packages flag.  Further tips are
+                    available at https://trac.edgewall.org/wiki/TracSubversion.
+
+                    """).replace('\n', '\n   ').rstrip(),
+                id = "datatracker.E0014",
+            ))
+    return errors

ietf/settings.py

@@ -382,7 +382,7 @@ def skip_unreadable_post(record):
     r"^\^admin/",
 ]
 
-# Tese are filename globs
+# These are filename globs.  They are fed directly to the coverage code checker.
 TEST_CODE_COVERAGE_EXCLUDE = [
     "*/tests*",
     "*/admin.py",
@@ -660,14 +660,43 @@ def skip_unreadable_post(record):
     "left_menu"     : "on",
 }
 
-TRAC_ADMIN_CMD = "/usr/bin/trac-admin"
-TRAC_WIKI_DIR_ROOT = "/a/www/www6s/trac/"
-TRAC_WIKI_DIR_PATTERN = os.path.join(TRAC_WIKI_DIR_ROOT, "%s")
+TRAC_MASTER_DIR = "/a/www/trac-setup/"
+TRAC_WIKI_DIR_PATTERN = "/a/www/www6s/trac/%s"
 TRAC_WIKI_URL_PATTERN = "https://trac.ietf.org/trac/%s/wiki"
 TRAC_ISSUE_URL_PATTERN = "https://trac.ietf.org/trac/%s/report/1"
 TRAC_SVN_DIR_PATTERN = "/a/svn/group/%s"
 TRAC_SVN_URL_PATTERN = "https://svn.ietf.org/svn/group/%s/"
 
+TRAC_ENV_OPTIONS = [
+    ('project', 'name', "{name} Wiki"),
+    ('trac', 'database', 'sqlite:db/trac.db' ),
+    ('trac', 'repository_type', 'svn'),
+    ('trac', 'repository_dir', "{svn_dir}"),
+    ('inherit', 'file', "/a/www/trac-setup/conf/trac.ini"),
+]
+
+TRAC_WIKI_PAGES_TEMPLATES = [
+    "utils/wiki/IetfSpecificFeatures",
+    "utils/wiki/InterMapTxt",
+    "utils/wiki/SvnTracHooks",
+    "utils/wiki/ThisTracInstallation",
+    "utils/wiki/TrainingMaterials",
+    "utils/wiki/WikiStart",
+]
+
+TRAC_ISSUE_SEVERITY_ADD = [
+    "-",
+    "Candidate WG Document",
+    "Active WG Document",
+    "Waiting for Expert Review",
+    "In WG Last Call",
+    "Waiting for Shepherd Writeup",
+    "Submitted WG Document",
+    "Dead WG Document",
+]
+
+SVN_ADMIN_COMMAND = "/usr/bin/svnadmin"
+
 # Email addresses people attempt to set for their account will be checked
 # against the following list of regex expressions with re.search(pat, addr):
 EXLUDED_PERSONAL_EMAIL_REGEX_PATTERNS = ["@ietf.org$"]

ietf/templates/utils/wiki/IetfSpecificFeatures

@@ -0,0 +1,94 @@
+= IETF-Specific Information =
+
+== Editing the Wiki and Issues ==
+
+In order to create and edit wiki pages and issues, you need to log in.  Click on the
+small 'Login' link above the main horizontal menubar.  You log in with the same
+username (your email address) and password as for all other ''tools.ietf.org'' password
+protected accesses.  If you don't have a login/passwd or need to reset your passwd, go
+to http://tools.ietf.org/newpasswd .
+
+The login and password is also used for commits to the SVN repository.  See more about
+the repository further down.
+
+== IETF-Specific Features ==
+
+This Trac installation has a few IETF-specific features which are not generally found
+in Trac:
+
+ * Occurences of RFC numbers or draft names in Wiki text will generate links to the
+   RFC or draft in question.  Unless you want to point to an RFC or draft in a
+   specific location which is different from the automatically generated link, you
+   don't need to explicitly add links for RFCs and drafts.  Examples: RFC 2026,
+   draft-ietf-poised95-std-proc-3
+
+ * Each issue in the issue tracker can be indicated to concern a 'component'. This is
+   a standard Trac feature; however, the list of available components is automatically
+   updated to include all the active working group drafts.  This makes it easier to
+   associate issues with drafts for the WG participants, without the Chairs needing to
+   go in as admin users and add a new component each time there's a new WG draft.
+
+ * The 'Severity' field of an issue has a special significance if the issue type is
+   set to 'state' or 'task'.  In that case, the Severity will be shown as an
+   annotation to the draft state on the regular WG status page on tools.ietf.org.
+   This can be useful for WG chairs to indicate more exactly the state of a WG draft,
+   which will otherwise simply be indicated as 'Active' on the status page, until it
+   is sent to the IESG for processing.
+
+ * If issues are registered against a draft ,indicated by setting the issue's
+   'component' field to the appropriate (abbreviated) draft name, the status page
+   will show a progress bar, indicating the total number of issues for that draft, as
+   well as the proportion which have been closed, and the number of still open issues.
+
+ * Everywhere you can use wiki markup (on the wiki pages, roadmap descriptions,
+   etc.) you may embed a macro which shows a ticket statistics graph.  Full
+   information about the macro is available at [http://trac-hacks.org/wiki/TicketStatsMacro].
+   Briefly, the macro syntax is:
+   {{{
+       [[TicketStats( height=250,daterange=12m,res_days=30)]]
+   }}}
+   which gives this result: [[TicketStats( height=250,daterange=12m,res_days=30)]]
+
+Issue tracker changes which are reflected in the WG status pages ('Severity'
+annotations and issue progress bars) may take up to 1 hour to propagate from the
+server which hosts the Trac instance (trac.tools.ietf.org) to the other tools servers.
+
+== Integration with tools.ietf.org ==
+
+For all working groups which have an instance of Trac installed, the URL to Trac for
+that WG has the form '''''!http://tools.ietf.org/wg/<wg>/trac'''''.
+There's also a link to the Trac issue tracker and a link to the Trac
+wiki in the horizontal menu on the WG status page
+'''''!http://tools.ietf.org/wg/<wg>'''''
+once Trac has been installed.
+
+== SVN Repository ==
+
+For each WG with a Trac instance there is also a SVN repository, with an URL of the
+form '''''!https://svn.tools.ietf.org/svn/wg/<wg>'''''.  Anybody can check out from
+the repository, but you need to use the tools server login and password in order to
+commit to the repository.
+
+To check out a repository with a command-line svn client, see this example for the ''hybi'' WG:
+
+{{{
+work/ $ svn co --username=henrik@levkowetz.com https://svn.tools.ietf.org/svn/wg/hybi/
+work/ $ cd hybi/
+hybi/ $
+}}}
+
+SVN also lets you check out parts of the repository tree, but for more info on
+that, please see the documentation on http://subversion.apache.org/.
+
+To add a document to the repository, place the document in your SVN working folder,
+tell SVN it should be added, and when ready, commit it to the repository:
+{{{
+hybi/ $ svn add draft-foo-bar-baz.txt
+hybi/ $ #...
+hybi/ $ svn commit draft-foo-bar-baz.txt -m "Commit message ..."
+hybi/ $
+}}}
+
+The IETF Trac instances use a variation of the Trac SVN hook script which is provided
+with Trac.  This script updates Track Issue Tickets based on keywords in the SVN
+commit messages; the keywords and their use is described in SvnTracHooks.

ietf/templates/utils/wiki/InterMapTxt

@@ -0,0 +1,72 @@
+= InterMapTxt =
+
+== This is the place for defining InterWiki prefixes ==
+
+This page was modelled after the MeatBall:InterMapTxt page.
+In addition, an optional comment is allowed after the mapping.
+
+
+This page is interpreted in a special way by Trac, in order to support
+!InterWiki links in a flexible and dynamic way.
+
+The code block after the first line separator in this page
+will be interpreted as a list of !InterWiki specifications:
+{{{
+prefix <space> URL [<space> # comment]
+}}}
+
+By using `$1`, `$2`, etc. within the URL, it is possible to create 
+InterWiki links which support multiple arguments, e.g. Trac:ticket:40.
+The URL itself can be optionally followed by a comment, 
+which will subsequently be used for decorating the links 
+using that prefix.
+
+New !InterWiki links can be created by adding to that list, in real time.
+Note however that ''deletions'' are also taken into account immediately,
+so it may be better to use comments for disabling prefixes.
+
+Also note that !InterWiki prefixes are case insensitive.
+
+
+== List of Active Prefixes ==
+
+[[InterWiki]]
+
+
+----
+
+== Prefix Definitions ==
+
+{{{
+PEP     http://www.python.org/peps/pep-$1.html                                       # Python Enhancement Proposal 
+Trac-ML  http://thread.gmane.org/gmane.comp.version-control.subversion.trac.general/ # Message $1 in Trac Mailing List
+trac-dev http://thread.gmane.org/gmane.comp.version-control.subversion.trac.devel/   # Message $1 in Trac Development Mailing List
+
+Mercurial http://www.selenic.com/mercurial/wiki/index.cgi/ # the wiki for the Mercurial distributed SCM
+
+RFC		http://tools.ietf.org/html/rfc$1.html # IETF's RFC $1
+DataTracker	https://datatracker.ietf.org/doc/
+dt		https://datatracker.ietf.org/doc/
+
+#
+# A arbitrary pick of InterWiki prefixes...
+#
+Acronym          http://www.acronymfinder.com/af-query.asp?String=exact&Acronym=
+C2find           http://c2.com/cgi/wiki?FindPage&value=
+Cache            http://www.google.com/search?q=cache:
+CPAN             http://search.cpan.org/perldoc?
+DebianBug        http://bugs.debian.org/
+DebianPackage    http://packages.debian.org/
+Dictionary       http://www.dict.org/bin/Dict?Database=*&Form=Dict1&Strategy=*&Query=
+Google           http://www.google.com/search?q=
+GoogleGroups     http://groups.google.com/group/$1/msg/$2        # Message $2 in $1 Google Group
+JargonFile       http://downlode.org/perl/jargon-redirect.cgi?term=
+MeatBall         http://www.usemod.com/cgi-bin/mb.pl?
+MetaWiki         http://sunir.org/apps/meta.pl?
+MetaWikiPedia    http://meta.wikipedia.org/wiki/
+MoinMoin         http://moinmoin.wikiwikiweb.de/
+WhoIs            http://www.whois.sc/
+Why              http://clublet.com/c/c/why?
+c2Wiki             http://c2.com/cgi/wiki?
+WikiPedia        http://en.wikipedia.org/wiki/
+}}}

ietf/templates/utils/wiki/SvnTracHooks

@@ -0,0 +1,77 @@
+= SVN Trac Hooks =
+
+If the Trac Hooks for SVN has been installed for the svn repository
+coupled to this Trac instance, the Key Phrases documented below may
+be used in SVN commit messages to cause automatic updates and annotations
+of Trac issues.
+
+== The trac-post-commit-hook ==
+
+This script looks at the commit message associated with an SVN commit,
+and based on the presence of a number of key phrases will add annotations
+to tickets and also possibly change ticket status, for instance closing
+it.
+
+=== Key Phrases ===
+
+The key phrases available are:
+{{{
+  Fix <ticket_spec>
+  Fixes <ticket_spec>
+  Fix for <ticket_spec>
+  Close <ticket_spec>
+  Closes <ticket_spec>
+  
+  Addresses <ticket_spec>
+  References <ticket_spec>
+  Relates to <ticket_spec>
+  Related to <ticket_spec>
+  See <ticket_spec>
+}}}
+
+=== Ticket specification ===
+
+The specification of the ticket to act on may specify one or more
+tickets, using any of the following forms:
+{{{
+  <ticket>
+  <ticket>, <ticket>{, <ticket>}
+  <ticket>, <ticket> and <ticket>
+}}}
+and variations thereof.
+
+=== Ticket identification ===
+
+The individual ticket specification
+can take any of the following forms:
+{{{
+  #<number>
+  ticket <number>
+  ticket:<number>
+  issue <number>
+  issue:<number>
+  bug <number>
+  bug:<number>
+}}}
+
+=== Examples ===
+
+{{{
+  Clarify header normalization vs matching request headers (see #147)
+
+  Resolve #27: fix definition of idempotent
+
+  Note change for issue 157 (related to #157)
+
+  Define http and https URI schemes: addresses #58, #128, #159
+
+  Define http and https URI schemes: addresses #58, #128, #159;
+  fixes #157: removed reference to RFC1900 use of IP addresses in URI.
+
+  Resolve #140: rephrase note so that it becomes clear that the described ...
+}}}
+
+=== Script ===
+
+The default script installed as trac-post-commit-hook is:
+http://tools.ietf.org/tools/wg-pages/svn-hook-files/trac-post-commit-hook