Closed tickets should display with strike-through

[Ryan J Ollos]

As in normal wiki markup, it would be nice if the TracLinks to tickets that are displayed through the BookmarkPlugin would display with strike-through font when the ticket is closed.

I may be able to provide a patch for this soon. See #3610 for a related discussion.

[Ryan J Ollos]

We need to pass the ticket status to the template, and the same will be true for milestone status. Here is a quick and dirty version:

bookmarkplugin/trunk/tracbookmark/templates/list.html

@@ -9 +9 @@
     <div style="margin-bottom: 3em;">
     <ul class="bookmarks">
       <py:for each="bookmark in bookmarks">
-        <li class="${bookmark.realm}">
-            <a href="${bookmark.url}">${bookmark.linkname}</a>
-                ${bookmark.name} (<a href="${bookmark.delete}">delete</a>)
-        </li>
+        <li><a href="${bookmark.url}" class="${bookmark.realm}">${bookmark.linkname}</a>
+            ${bookmark.name} (<a href="${bookmark.delete}">delete</a>)</li>
       </py:for>
     </ul>
     </div>

bookmarkplugin/trunk/tracbookmark/__init__.py

@@ +1 @@
+# -*- coding: utf-8 -*-
+
 import re
 from trac.core import *
 from trac.config import ListOption
@@ -212 +214 @@
                 if realm == 'ticket':
                     linkname = get_resource_shortname(self.env, resource)
                     name = get_resource_summary(self.env, resource)
+                    from trac.ticket.model import Ticket
+                    realm = Ticket(self.env, resource.id)['status'] + ' ' + realm
                 elif realm == 'milestone':
                     linkname = get_resource_shortname(self.env, resource)
                 elif realm == 'wiki':

I propose we add class to the template's data dictionary, modify the template as shown in the patch and populate the class variable within the if realm == conditional.

[Jun Omae]

Replying to rjollos:

I propose we add class to the template's data dictionary, modify the template as shown in the patch and populate the class variable within the if realm == conditional.

Looks good!

Additionally, it would be better to add missing to the class attribute when a ticket doesn't exist. And, we should check the existence of bookmarked resources for other than tickets...

tracbookmark/__init__.py

@@ -7 +7 @@
 from trac.web.api import IRequestFilter, IRequestHandler, Href
 from trac.web.chrome import ITemplateProvider, add_stylesheet, \
                             add_script, add_notice
-from trac.resource import Resource, get_resource_description, get_resource_shortname, get_resource_summary
+from trac.resource import (
+    Resource, ResourceNotFound, get_resource_description,
+    get_resource_shortname, get_resource_summary)
 from trac.db import DatabaseManager, Table, Column
 from trac.perm import IPermissionRequestor
 from trac.util import get_reporter_id
@@ -213 +215 @@
             if resource:
                 if realm == 'ticket':
                     linkname = get_resource_shortname(self.env, resource)
-                    name = get_resource_summary(self.env, resource)
-                    from trac.ticket.model import Ticket
-                    realm = Ticket(self.env, resource.id)['status'] + ' ' + realm
+                    try:
+                        name = get_resource_summary(self.env, resource)
+                    except ResourceNotFound, e:
+                        name = ''
+                        realm = 'missing ' + realm
+                    else:
+                        from trac.ticket.model import Ticket
+                        realm = Ticket(self.env, resource.id)['status'] + ' ' + realm
                 elif realm == 'milestone':
                     linkname = get_resource_shortname(self.env, resource)
                 elif realm == 'wiki':

[Ryan J Ollos]

Thanks for the feedback and additional suggestions (and pushing patches for those other tickets just now). I'm almost finished implementing this and will push the changes later today.

[Ryan J Ollos]

Replying to jun66j5:

And, we should check the existence of bookmarked resources for other than tickets...

Good point. I'll make sure to do that as part of this ticket.

[Ryan J Ollos]

(In [12985]) Refs #9212:

• Closed tickets are displayed with strike-through font on the /bookmark page.
• Missing tickets have the missing class, are rendered as light-grey links with no href attribute on the /bookmark page and are not displayed on the bookmark menu.
• Resolved issue in which all pages on the Trac site would display a TracError if a non-existent ticket was bookmarked. This could occur in cases that the ticket was bookmarked and then deleted.

Thanks to Jun Omae for a major contributions to this changeset.

[Ryan J Ollos]

(In [12986]) Refs #9212: Organized imports.

[Ryan J Ollos]

It looks like the assignment name = '' can be dropped in the except clause. I'll make that change in a follow-up commit.

[Ryan J Ollos]

I also just noticed that I broke the unit tests with [12985]. I'll fix the existing unit tests and add cases to cover the issues fixed in this ticket.

[Ryan J Ollos]

After fixing the unit tests, I'm still seeing one failure with Trac 1.0.2dev, which is probably related to a change in what the Trac API returns rather than any of the changes associated with this ticket:

======================================================================
FAIL: test_format_name_changeset (tracbookmark.tests.BookmarkSystemTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/user/Workspace/trac-hacks.git/bookmarkplugin/trunk/tracbookmark/tests/__init__.py", line 112, in test_format_name_changeset
    self.assertEquals('Changeset 42', data['name'])
AssertionError: 'Changeset 42' != 'Changeset 42 in trunk'

----------------------------------------------------------------------
Ran 9 tests in 0.047s

FAILED (failures=1)

[Ryan J Ollos]

Bookmarking a file results in the following:

How to Reproduce

While doing a GET operation on /browser, Trac issued an internal error.

(please provide additional details here)

Request parameters:

{'path': '/'}

User agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.17 (KHTML, like Gecko) Chrome/24.0.1312.68 Safari/537.17

System Information

Trac	1.0.2dev
Genshi	0.6 (without speedups)
pysqlite	2.6.0
Python	2.7.3 (default, Jan 2 2013, 13:56:14) [GCC 4.7.2]
pytz	2012c
setuptools	0.6
SQLite	3.7.13
Subversion	1.6.17 (r1128011)
jQuery	1.7.2

Enabled Plugins

TracBookmark

0.1dev-r12986

Python Traceback

Traceback (most recent call last):
  File "/home/user/Workspace/th9212-r12986/trac.git/trac/web/main.py", line 497, in _dispatch_request
    dispatcher.dispatch(req)
  File "/home/user/Workspace/th9212-r12986/trac.git/trac/web/main.py", line 224, in dispatch
    self._post_process_request(req, *resp)
  File "/home/user/Workspace/th9212-r12986/trac.git/trac/web/main.py", line 338, in _post_process_request
    resp = f.post_process_request(req, *resp)
  File "/home/user/Workspace/bookmarkplugin/trunk/tracbookmark/__init__.py", line 172, in post_process_request
    self.render_bookmarker(req)
  File "/home/user/Workspace/bookmarkplugin/trunk/tracbookmark/__init__.py", line 302, in render_bookmarker
    menu = self._get_bookmarks_menu(req)
  File "/home/user/Workspace/bookmarkplugin/trunk/tracbookmark/__init__.py", line 310, in _get_bookmarks_menu
    params = self._format_name(req, url)
  File "/home/user/Workspace/bookmarkplugin/trunk/tracbookmark/__init__.py", line 241, in _format_name
    name = get_resource_summary(self.env, resource)
  File "/home/user/Workspace/th9212-r12986/trac.git/trac/resource.py", line 347, in get_resource_summary
    return get_resource_description(env, resource, 'summary')
  File "/home/user/Workspace/th9212-r12986/trac.git/trac/resource.py", line 333, in get_resource_description
    return manager.get_resource_description(resource, format, **kwargs)
  File "/home/user/Workspace/th9212-r12986/trac.git/trac/versioncontrol/api.py", line 387, in get_resource_description
    node = repos.get_node(resource.id, resource.version)
AttributeError: 'NoneType' object has no attribute 'get_node'

[Ryan J Ollos]

I started out thinking that the task of handling missing resources wouldn't be too much work, but it quickly spiraled into a significant amount of work. There are a lot of issues with bookmarking repository resources, and I'm sure my forthcoming changeset won't cover all the corner cases. I hope that it is at least a step in the right direction, and we can dedicate specific tickets to any of the corner cases.

I've attempted to handle all of the cases for which TracLinks might point to missing resources. TracLinks have two distinct behaviors. In the case of a TracLink to a non-existent wiki page, the link has an href attribute, giving the user the opportunity create the page. Milestones behave the same as wiki pages. Ticket links on the other hand do not have an href attribute. Most or all other TracLinks behave like ticket links.

Links to non-existent reports don't have the missing class, which I think is a bug (see ​t:#11166).

[Ryan J Ollos]

It would be nice if we could delegate some of the work in BookmarkSystem._format_name to the Trac API. I did an experiment to see if it was possible to accomplish this using the Trac 0.11 API (tested with Trac 1.0.2dev, but I didn't attempt to use the latest API functions such as web_context since we are trying to keep the plugin backward compatible):

from trac.resource import render_resource_link
from trac.mimeview.api import Context
context = Context.from_request(req, resource)
link = render_resource_link(self.env, context, resource)

This gives us what we want for existing and non-existing milestones.

Existing milestone:

<a class="milestone" href="/tracdev/milestone/milestone2">Milestone milestone2</a>

Non-existing milestone:

<a class="missing milestone" href="/tracdev/milestone/milestone1" rel="nofollow">Milestone milestone1</a>

However, for wiki pages, the missing class isn't added.

Existing wiki page:

<a href="/tracdev/wiki/TracBrowser">TracBrowser</a>

Non-existing wiki page:

<a href="/tracdev/wiki/TracBrowserOne">TracBrowserOne</a>

WikiSystem doesn't use the context parameter to generate get_resource_description's return value, and therefore doesn't return a link element. However, render_resource_link could still call resource_exists to determine whether the missing class should be added to the link that it generates (see ​t:#11169).

Additionally, many of the Components, such as ReportModule, ChangesetModule, ... don't implement IResourceManager, so it's not possible to utilize the functions in the resource module to get a compact (TracLink) description of a resource, or a summary of the resource. This seems like a hole in the Trac API that we might be able to improve on later, but I can't see any way to simplify BookmarkSystem._format_name at this time.

[Ryan J Ollos]

Replying to rjollos:

In the case of a TracLink to a non-existent wiki page, the link has an href attribute, giving the user the opportunity create the page. Milestones behave the same as wiki pages.

TracLinks to missing Tickets and Milestones also have the rel="nofollow" attribute, so we should take care to add that as well for consistency.

[Ryan J Ollos]

Replying to rjollos:

Additionally, many of the Components, such as ReportModule, ChangesetModule, ... don't implement IResourceManager, so it's not possible to utilize the functions in the resource module to get a compact (TracLink) description of a resource, or a summary of the resource.

The IResourceManager for the changeset realm appears to be RepositoryManager, however its get_resource_description method doesn't use a context object to return an Element object, and it won't return a compact format for the resource.

[Ryan J Ollos]

I have some refactoring in mind:

• The bookmarks list that is passed to the template will become a generator.
• The generator will return a tuple of (resource_link, resource_name, delete_href), with resource_link being an a element.

In cases that render_resource_link returns rich content with the compact representation we want, we can just call that function to get resource_link. It looks like this will currently only work for the milestone realm. However, we can continue to push patches to the core to enhance render_resource_link for various realms, and that will simplify the BookmarkPlugin code in the future when we drop support for older versions of Trac.

The immediate advantage of creating the resource_link in the Python code as opposed to the template is that we can add additional attributes to the link elements, such as rel=nofollow, without passing more parameters in the template's dictionary. This should keep the code a bit simpler.

I will finish up the unit tests for this ticket, close this ticket, make a new one for the other issues notes here, and begin working from a branch on GitHub so that the repository history for this plugin can be kept a bit cleaner.

[Ryan J Ollos]

(In [13007]) Fixes #9212:

• Added and modified unit test cases to cover changes in [12985].
• Accounted for differences in get_resource_description's output for the changeset realm pre and post Trac 0.12.
• Moved instantiation of BookmarkSystem into the fixture's setUp method.
• Removed unused imports from test case module.
• Removed unnecessary variable assignment that was part of [12985].

[Ryan J Ollos]

Also, please let me know if you have any feedback or suggestions on the proposed or implemented changes here. Thanks!

[Ryan J Ollos]

As noted in comment:12:ticket:10942, with Trac 0.11 we get:

10:34:40 AM Trac[loader] DEBUG: Loading tracbookmark from /home/user/Workspace/trachacks.git/bookmarkplugin/trunk
10:34:40 AM Trac[loader] ERROR: Skipping "tracbookmark = tracbookmark": (can't import "cannot import name resource_exists")

[Ryan J Ollos]

(In [13226]) Refs #9212: Added compatibility code to restore compatibility for Trac <= 0.11.7.