Changeset 4344

Timestamp:

09/26/08 06:53:22 (3 months ago)

Author:

Blackhex

Message:

ScreenshotsPlugin:

• DB schema updated with priority field. Backup your DB before upgrading!!!
  
• Screnshots order facility introduced (default_orders and default_order_directions configuration options added. SCREENSHOTS_ORDER permission added.).
  
• Screenshot images can be now replaced via edit form.
  
• AND/OR relation between component and version filters added.
  
• Fixed UnicodeDecodeError? when system error messages has international characters.
  
• Fixed missing components, versions and description in HTML view.
  
• Behavior of align attribute of [[Screnshot()]] macro changed for ticket #3771.
  

Files:

• screenshotsplugin/0.11/setup.py (modified) (1 diff)
• screenshotsplugin/0.11/tracscreenshots/api.py (modified) (6 diffs)
• screenshotsplugin/0.11/tracscreenshots/core.py (modified) (18 diffs)
• screenshotsplugin/0.11/tracscreenshots/db/db4.py (added)
• screenshotsplugin/0.11/tracscreenshots/htdocs/css/screenshots.css (modified) (1 diff)
• screenshotsplugin/0.11/tracscreenshots/htdocs/js/screenshots.js (modified) (2 diffs)
• screenshotsplugin/0.11/tracscreenshots/init.py (modified) (2 diffs)
• screenshotsplugin/0.11/tracscreenshots/templates/screenshot-add.html (modified) (1 diff)
• screenshotsplugin/0.11/tracscreenshots/templates/screenshot.html (modified) (2 diffs)
• screenshotsplugin/0.11/tracscreenshots/templates/screenshots.html (modified) (5 diffs)
• screenshotsplugin/0.11/tracscreenshots/wiki.py (modified) (2 diffs)

screenshotsplugin/0.11/setup.py

@@ -6 +6 @@
-setup(
-  name = 'TracScreenshots',
-6
+7
-  packages = ['tracscreenshots', 'tracscreenshots.db'],
-  package_data = {'tracscreenshots' : ['templates/*.html', 'htdocs/css/*.css',

screenshotsplugin/0.11/tracscreenshots/api.py

@@ -40 +40 @@
-
-class ScreenshotsApi(Component):
+
+    default_priority = 0
-
-    # Get list functions
@@ -67 +69 @@
-        # Get screenshots from database.
-        return self._get_items(context, 'screenshot', ('id', 'name',
-
+
+
-
-    def get_screenshots_complete(self, context):
@@ -78 +81 @@
-        return screenshots
-
-
+
+
-        has_none_version = True
-        has_none_component = True
-        columns = ('id', 'name', 'description', 'time', 'author', 'tags',
-
+, 'priority'
-        versions_str = (', '.join(['%s'] * len(versions))) or 'NULL'
-        components_str = (', '.join(['%s'] * len(components))) or 'NULL'
+        orders_str = ', '.join(['%s %s' % (field, direction.upper()) for \
+          field, direction in orders])
-        sql = 'SELECT DISTINCT ' + ', '.join(columns) + ' FROM screenshot s ' \
-          'LEFT JOIN (SELECT screenshot, version FROM screenshot_version) v ' \
-          'ON s.id = v.screenshot LEFT JOIN (SELECT screenshot, component ' \
-          'FROM screenshot_component) c ON s.id = c.screenshot WHERE ' \
-
-
-
-
+
+
+
+
+
-        self.log.debug(versions + components)
-        self.log.debug(sql % tuple(versions + components))
@@ -143 +150 @@
-        # Get screenshot from database.
-        screenshot = self._get_item(context, 'screenshot', ('id', 'name',
-)
-
+
+priority'), '
-
-        if screenshot:
@@ -161 +168 @@
-        # Get screenshot from database.
-        screenshot = self._get_item(context, 'screenshot', ('id', 'name',
-)
-
+
+priority'), '
-
-        if screenshot:
@@ -265 +272 @@
-        self.log.debug(sql % (id,))
-        context.cursor.execute(sql, (id,))
+
+    # Other methods.
+
+    def set_version(self, context, version):
+        # Check if version item exists.
+        sql = "SELECT value FROM system WHERE name = 'screenshots_version'"
+        self.log.debug(sql)
+        context.cursor.execute(sql)
+        in_db = False
+        for row in context.cursor:
+            in_db = True
+            break
+
+        # Insert of update version.
+        if in_db:
+            sql = "UPDATE system SET value = %s WHERE name = 'screenshots_" \
+              "version'"
+        else:
+            sql = "INSERT INTO system (name, value) VALUES ('screenshots_" \
+              "version', %s)"
+        self.log.debug(sql % (version,))
+        context.cursor.execute(sql, (version,))

screenshotsplugin/0.11/tracscreenshots/core.py

@@ -59 +59 @@
-    default_versions = ListOption('screenshots', 'default_versions', 'none',
-      doc = 'List of versions enabled by default.')
+    default_filter_relation = Option('screenshots', 'default_filter_relation',
+      'or', doc = 'Logical relation between component and version part of'
+      ' screenshots filter.')
+    default_orders = ListOption('screenshots', 'default_orders',
+      'id', doc = 'List of names of database fields that are used to'
+      ' sort screenshots.')
+    default_order_directions = ListOption('screenshots',
+      'default_order_directions', 'asc', doc = 'List of ordering '
+      'directions for fields specified in default_orders configuration '
+      'options.')
-
-    # IPermissionRequestor methods.
@@ -65 +75 @@
-        view = 'SCREENSHOTS_VIEW'
-        filter = ('SCREENSHOTS_FILTER', ['SCREENSHOTS_VIEW'])
-
-
-
+
+
+
+
-
-    # ITemplateProvider methods.
@@ -154 +165 @@
-        elif action == 'filter':
-            return ['filter', 'view']
+        elif action == 'order':
+            return ['order', 'view']
-        else:
-            return ['view']
@@ -265 +278 @@
-                              'file' : filename,
-                              'width' : image.size[0],
-
+
+
+
-
-                # Add new screenshot.
@@ -294 +309 @@
-                screenshot['versions'] = versions
-
-screenshot
+'screenshot: %s' % (screenshot,)
-
-                # Prepare file paths
@@ -327 +342 @@
-                      ' specified in path config option in [screenshots]' \
-                      ' section of trac.ini existing? Original message was: %s' \
-error
+to_unicode(error)
-
-                # Notify change listeners.
@@ -345 +360 @@
-                self.data['screenshot'] = api.get_screenshot(context,
-                  screenshot_id)
-                self.log.debug(self.data['screenshot'])
-
-            elif action == 'post-edit':
@@ -379 +393 @@
-                                'components') or [],
-                              'versions' : context.req.args.get('versions') or \
-
+
+
+
-
-                # Update dimensions and filename if image file is updated.
@@ -395 +411 @@
-                     screenshot['versions'] = [screenshot['versions']]
-
-screenshot
+'screenshot: %s' % (screenshot)
-
-                # Edit screenshot.
@@ -420 +436 @@
-                    except Exception, error:
-                        raise TracError('Error deleting screenshot. Original' \
-error
+to_unicode(error)
-
-                    # Store uploaded image.
@@ -436 +452 @@
-                          ' specified in path config option in [screenshots]' \
-                          ' section of trac.ini existing? Original message was: %s' \
-error
+to_unicode(error)
-
-                # Notify change listeners.
@@ -477 +493 @@
-                except Exception, error:
-                    raise TracError('Error deleting screenshot. Original' \
-error
+to_unicode(error)
-
-                # Notify change listeners.
@@ -487 +503 @@
-
-            elif action == 'filter':
+                context.req.perm.assert_permission('SCREENSHOTS_FILTER')
+
-                # Update enabled components from request.
-                components = context.req.args.get('components') or []
-                if not isinstance(components, list):
-                    components = [components]
-context.req.session['enabled_components'] = str(
+self._set_enabled_components(context.req, 
-
-                # Update enabled versions from request.
@@ -497 +515 @@
-                if not isinstance(versions, list):
-                    versions = [versions]
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-            elif action == 'view':
@@ -516 +550 @@
-                  context.cursor)
-
-
+
+
-                enabled_components = self._get_enabled_components(context.req)
-                enabled_versions = self._get_enabled_versions(context.req)
+                relation = self._get_filter_relation(context.req)
-                if 'all' in enabled_components:
-                    enabled_components = [component['name'] for component in
@@ -526 +562 @@
-                    versions]
-
-
+
+
+
+
+
+
-
-                # Filter screenshots.
-                screenshots = api.get_filtered_screenshots(context,
-
+, relation, orders
-
-                # Convert enabled components and versions to dictionary.
@@ -546 +587 @@
-                self.data['enabled_versions'] = enabled_versions
-                self.data['enabled_components'] = enabled_components
+                self.data['filter_relation'] = relation
+                self.data['orders'] = orders
-
-                # Get screenshots content template and data.
@@ -596 +639 @@
-        if req.perm.has_permission('SCREENSHOTS_FILTER'):
-            #Â Return existing filter from session or create default.
-
-
+
+
+
-            else:
-                components = self.default_components
-
+screenshots_
-        else:
-            # Users without SCREENSHOTS_FILTER permission uses
-            # 'default_components' configuration option.
-            components = self.default_components
-        self.log.debug('enabled_components: %s' % (components,))
-        return components
+
+    def _set_enabled_components(self, req, components):
+        req.session['screenshots_enabled_components'] = str(components)
-
-    def _get_enabled_versions(self, req):
-        if req.perm.has_permission('SCREENSHOTS_FILTER'):
-            #Â Return existing filter from session or create default.
-
-
+screenshots_
+screenshots_
-            else:
-                versions = self.default_versions
-
+screenshots_
-        else:
-            # Users without SCREENSHOTS_FILTER permission uses
-            # 'default_versions' configuration option.
-            versions = self.default_versions
-        self.log.debug('enabled_versions: %s' % (versions,))
-        return versions
+
+    def _set_enabled_versions(self, req, versions):
+        req.session['screenshots_enabled_versions'] = str(versions)
+
+    def _get_filter_relation(self, req):
+        if req.perm.has_permission('SCREENSHOTS_FILTER'):
+            #Â Return existing filter relation from session or create default.
+            if req.session.has_key('screenshots_filter_relation'):
+                relation = req.session.get('screenshots_filter_relation')
+            else:
+                relation = self.default_filter_relation
+                req.session['screenshots_filter_relation'] = relation
+        else:
+            # Users without SCREENSHOTS_FILTER permission uses
+            # 'default_filter_relation' configuration option.
+            relation = self.default_filter_relation
+        return relation
+
+    def _set_filter_relation(self, req, relation):
+        req.session['screenshots_filter_relation'] = relation
+
+    def _get_orders(self, req):
+        if req.perm.has_permission('SCREENSHOTS_ORDER'):
+            #Â Get ordering fields from session or default ones.
+            if req.session.has_key('screenshots_orders'):
+                orders = eval(req.session.get('screenshots_orders'))
+            else:
+                orders = tuple(self.default_orders)
+                directions = tuple(self.default_order_directions)
+                orders = [(orders[I], directions[I]) for I in \
+                  xrange(len(orders))]
+                req.session['screenshots_orders'] = str(orders)
+        else:
+            # Users without SCREENSHOTS_ORDER permission uses
+            # 'default_orders' configuration option.
+            orders = tuple(self.default_orders)
+            directions = tuple(self.default_order_directions)
+            orders = [(orders[I], directions[I]) for I in xrange(len(orders))]
+        return tuple(orders)
+
+    def _set_orders(self, req, orders):
+        req.session['screenshots_orders'] = str(orders)

screenshotsplugin/0.11/tracscreenshots/htdocs/css/screenshots.css

@@ -22 +22 @@
-}
-
+div.order fieldset.order
+{
+  float: left;
+  padding: 1em;
+  margin: 0.5em;
+}
+
+div.order hr
+{
+  padding: 0em;
+  margin: 0.5em 0em;
+}
+
+div.order div.buttons
+{
+  clear: both;
+}
+
-/* Wiki [[Screenshot()]] macro styles. */
- > a > img
+
-{
-
-
-
+
-  margin: 0em;
-  padding: 0em;
-}
-
-> a
+span.aux
-{
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  padding: 0em;
-}
-
- > span.description
+-left span.aux, span.thumbnail-righ span.aux
-{
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-}
-
-span.thumbnail, span.thumbnail-left, span.thumbnail-right
-{
-
-
-
+
+
-  padding: 0em;
-  font-size: 75%;
-  text-align: center;
-  vertical-align: middle;
-}
-

screenshotsplugin/0.11/tracscreenshots/htdocs/js/screenshots.js

@@ -1 @@
-_a
+A
-{
-  var checkboxes = document.getElementsByName(name);
@@ -7 +7 @@
-  }
-}
+
+function checkNumber(evt)
+{
+  var keycode;
+
+  if (evt)
+    ;
+  else if (window.event)
+    evt = window.event;
+  else if (event)
+    evt = event;
+  else
+    return true;
+
+  if (evt.charCode)
+    keycode = evt.charCode;
+  else if (evt.keyCode)
+    keycode = evt.keyCode;
+  else if (evt.which)
+    keycode = evt.which;
+  else
+    keycode = 0;
+
+  return ((keycode >= 48 && keycode <= 57) || (keycode == 8) ||
+   (keycode == 46) ||Â (keycode >= 33 && keycode <= 40));
+}

screenshotsplugin/0.11/tracscreenshots/init.py

@@ -6 +6 @@
-
-# Last screenshots database shcema version
-3
+4
-
-class ScreenshotsInit(Component):
@@ -30 +30 @@
-        # Get current database schema version
-        db_version = self._get_db_version(cursor)
-
-
-        # Is this clean installation?

screenshotsplugin/0.11/tracscreenshots/templates/screenshot-add.html

@@ -55 +55 @@
-            </select><br/>
-          </div>
+          <div class="field">
+            <label for="priority">Priority (number 0..x):</label><br/>
+            <input type="text" onkeypress="return checkNumber(event)" name="priority" value="${(req.args.action == 'edit') and screenshots.screenshot.priority or '0'}"/>
+          </div>
-          <div class="buttons">
-            <input type="submit" name="submit" value="Submit"/>

screenshotsplugin/0.11/tracscreenshots/templates/screenshot.html

@@ -20 +20 @@
-            <td class="components">
-              <strong>Components:</strong>
-?cs each:component = screenshots.screenshot.components ?
-<?cs var:component ?>
-?cs /each ?
+py:for each="component in screenshots.screenshot.components"
+$component
+/py:for
-            </td>
-          </tr>
@@ -28 +28 @@
-            <td class="versions">
-              <strong>Versions:</strong> 
-?cs each:version = screenshots.screenshot.versions ?
-<?cs var:version ?>
-?cs /each ?
+py:for each="version in screenshots.screenshot.versions"
+$version
+/py:for
-            </td>
-          </tr>
-          <tr>
-            <td class="message">
-<?cs var:screenshots.screenshot.description ?>
+${screenshots.screenshot.description}
-            </td>
-          </tr>

screenshotsplugin/0.11/tracscreenshots/templates/screenshots.html

@@ -1 +1 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<?python
-  test = {'ř': 1}
-?>
-<html xmlns="http://www.w3.org/1999/xhtml" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:py="http://genshi.edgewall.org/">
-  <xi:include href="layout.html"/>
@@ -17 +14 @@
-      <xi:include href="${screenshots.content_template}"/>
-
-
+ 
-        <form method="post" action="${href.screenshots()}">
-          <div>
@@ -43 +40 @@
-      </div>
-
+      <div py:if="'SCREENSHOTS_ORDER' in perm" class="order">
+        <form method="post" action="${href.screenshots()}">
+          <fieldset>
+            <legend>
+              Order:
+            </legend>
+
+            <fieldset py:for="index, order in enumerate(screenshots.orders)" class="order">
+              <legend>
+                 ${index + 1}. field:
+              </legend>
+
+              <div>
+                <py:choose>
+                  <input py:when="order[0] == 'id'" type="radio" name="order_$index" value="id" checked="checked">ID</input>
+                  <input py:otherwise="" type="radio" name="order_$index" value="id">ID</input><br/>
+                </py:choose>
+                <py:choose>
+                  <input py:when="order[0] == 'name'" type="radio" name="order_$index" value="name" checked="checked">Name</input>
+                  <input py:otherwise="" type="radio" name="order_$index" value="name">Name</input><br/>
+                </py:choose>
+                <py:choose>
+                  <input py:when="order[0] == 'author'" type="radio" name="order_$index" value="author" checked="checked">Author</input>
+                  <input py:otherwise="" type="radio" name="order_$index" value="author">Author</input><br/>
+                </py:choose>
+                <py:choose>
+                  <input py:when="order[0] == 'time'" type="radio" name="order_$index" value="time" checked="checked">Time</input>
+                  <input py:otherwise="" type="radio" name="order_$index" value="time">Time</input><br/>
+                </py:choose>
+                <py:choose>
+                  <input py:when="order[0] == 'description'" type="radio" name="order_$index" value="description" checked="checked">Description</input>
+                  <input py:otherwise="" type="radio" name="order_$index" value="description">Description</input><br/>
+                </py:choose>
+                <py:choose>
+                  <input py:when="order[0] == 'priority'" type="radio" name="order_$index" value="priority" checked="checked">Priority</input>
+                  <input py:otherwise="" type="radio" name="order_$index" value="priority">Priority</input><br/>
+                </py:choose>
+
+                <hr/>
+                <py:choose>
+                  <input py:when="order[1] == 'asc'" type="radio" name="order_direction_$index" value="asc" checked="checked">Ascending</input>
+                  <input py:otherwise="" type="radio" name="order_direction_$index" value="asc">Ascending</input>
+                </py:choose>
+                <py:choose>
+                  <input py:when="order[1] == 'desc'" type="radio" name="order_direction_$index" value="desc" checked="checked">Descending</input>
+                  <input py:otherwise="" type="radio" name="order_direction_$index" value="desc">Descending</input>
+                </py:choose>
+              </div>
+            </fieldset>
+
+            <div class="buttons">
+              <input type="submit" name="filter" value="Apply Order"/>
+              <input type="hidden" name="action" value="order"/>
+            </div>
+
+          </fieldset>
+        </form>
+      </div>
+
-      <div py:if="'SCREENSHOTS_FILTER' in perm" class="filter">
-        <form method="post" action="${href.screenshots()}">
@@ -64 +120 @@
-                  </input>
-                </py:choose>
-_a
-_a
+A
+A
-              </div>
-            </fieldset>
+
+            <div>
+              <py:choose>
+                <py:when test="screenshots.filter_relation == 'and'">
+                  <input type="radio" name="filter_relation" value="and" checked="checked">AND</input>
+                  <input type="radio" name="filter_relation" value="or">OR</input>
+                </py:when>
+                <py:otherwise>
+                  <input type="radio" name="filter_relation" value="and">AND</input>
+                  <input type="radio" name="filter_relation" value="or" checked="checked">OR</input>
+                </py:otherwise>
+              </py:choose>
+            </div>
-
-            <fieldset>
@@ -83 +152 @@
-                  </input>
-                </py:choose>
-_a
-_a
+A
+A
-              </div>
-            </fieldset>

screenshotsplugin/0.11/tracscreenshots/wiki.py

@@ -169 +169 @@
-
-                # Make copy of attributes for image tag.
-
-
+
-                                    attributes['border'],)}
-                for attribute in attributes.keys():
@@ -187 +186 @@
-                  screenshot['id'], format = attributes['format']), title =
-                  screenshot['description'])
+                width_and_border = int(attributes['width']) + 2 * \
+                  int(attributes['border'])
-                description = html.span(attributes['description'], class_ =
-
+
+
+
-                thumbnail_class = 'thumbnail' + ((attributes['align'] == 'left')
-                  and '-left' or (attributes['align'] == 'right') and '-right'
-                  or '')
-
-
-
+
-                return thumbnail
-            else: