Changeset 4304

Timestamp:

09/20/08 14:40:02 (2 months ago)

Author:

Blackhex

Message:

ScreenshotsPlugin:

• [[ScreenshotsList()]] macro added.
  
• Added tags, components and versions variable for [[Screenshots()]] macro.
  

Files:

• screenshotsplugin/0.11/tracscreenshots/api.py (modified) (1 diff)
• screenshotsplugin/0.11/tracscreenshots/wiki.py (modified) (8 diffs)

screenshotsplugin/0.11/tracscreenshots/api.py

@@ -68 +68 @@
-        return self._get_items(context, 'screenshot', ('id', 'name',
-          'description', 'time', 'author', 'tags', 'file', 'width', 'height'))
+
+    def get_screenshots_complete(self, context):
+        screenshots = self.get_screenshots(context)
+        for screenshot in screenshots:
+            screenshot['components'] = self.get_screenshot_components(context,
+              screenshot['id'])
+            screenshot['versions'] = self.get_screenshot_versions(context,
+              screenshot['id'])
+        return screenshots
-
-    def get_filtered_screenshots(self, context, components, versions):

screenshotsplugin/0.11/tracscreenshots/wiki.py

@@ -15 +15 @@
-
-class ScreenshotsWiki(Component):
+    """
+        The wiki module implements macro for screenshots referencing.
+    """
+    implements(IWikiSyntaxProvider, IWikiMacroProvider)
-
-    screenshot_macro_doc = """Allows embed screenshot image in wiki page.
@@ -45 +49 @@
- * {{{$width}}} - Original width of image.
- * {{{$height}}} - Original height of image.
+ * {{{$tags}}} - Comma separated list of screenshot tags.
+ * {{{$components}}} - Comma separated list of screenshot components.
+ * {{{$versions}}} - Comma separated list of screenshot versions.
-
-Example:
@@ -52 +59 @@
-}}}"""
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    # [screenshot] macro id regular expression.
@@ -67 +91 @@
-    default_description = Option('screenshots', 'default_description',
-      '$description', 'Template for embended image description.')
+    default_list_item = Option('screenshots', 'default_list_item', '$id - $name - $description',
+      doc = 'Default format of list item description of [[ScreenshotsList()]]' \
+      ' macro.')
-
-    # IWikiSyntaxProvider
@@ -80 +107 @@
-    def get_macros(self):
-        yield 'Screenshot'
+        yield 'ScreenshotsList'
-
-    def get_macro_description(self, name):
-        if name == 'Screenshot':
-            return self.screenshot_macro_doc
+        elif name == 'ScreenshotsList':
+            return self.screenshots_list_macro_doc
-
-    def expand_macro(self, formatter, name, content):
+
+        # Create request context.
+        context = Context.from_request(formatter.req)('screenshots-wiki')
+
+        # Get database access.
+        db = self.env.get_db_cnx()
+        context.cursor = db.cursor()
+
+        # Get API component.
+        api = self.env[ScreenshotsApi]
+
-        if name == 'Screenshot':
-            # Check permission.
@@ -91 +132 @@
-               return html.div('No permissions to see screenshots.',
-               class_ = 'system-message')
-
-            # Create request context.
-            context = Context.from_request(formatter.req)('screenshots-wiki')
-
-            # Get database access.
-            db = self.env.get_db_cnx()
-            context.cursor = db.cursor()
-
-            # Get API component.
-            api = self.env[ScreenshotsApi]
-
-            #Â Get macro arguments.
@@ -170 +201 @@
-                  class_ = 'missing')
-
+        elif name == 'ScreenshotsList':
+            # Check permission.
+            if not formatter.req.perm.has_permission('SCREENSHOTS_VIEW'):
+               return html.div('No permissions to see screenshots.',
+               class_ = 'system-message')
+
+            #Â Get desired list item description
+            list_item_description = content or self.default_list_item
+
+            # Get all screenshots.
+            screenshots = api.get_screenshots_complete(context)
+
+            # Create and return HTML list of screenshots.
+            list_items = []
+            for screenshot in screenshots:
+                list_item = self._format_description(context,
+                  list_item_description, screenshot)
+                list_items.append(html.li(html.a(list_item, href =
+                  formatter.req.href.screenshots(screenshot['id']))))
+            return html.ul(list_items)
+
-    # Internal functions
-
@@ -220 +272 @@
-        description = description.replace('$height', to_unicode(
-          screenshot['height']))
+        description = description.replace('$tags', to_unicode(
+          screenshot['tags']))
+        description = description.replace('$components',
+          ', '.join(screenshot['components']))
+        description = description.replace('$versions',
+          ', '.join(screenshot['versions']))
+
-        self.log.debug(description)
-        return format_to_oneliner(self.env, context, description)