Changeset 3313

Timestamp:

03/05/08 06:26:47 (9 months ago)

Author:

Blackhex

Message:

ScreenshotsPlugin:

• Port of r3303 - r3309 to 0.11.
  
• Documentation for [[Screenshot()]] macro.
  
• Minor fixes in wiki macro CSS style.
  
• Fixed display of macro when SCREENSHOTS_VIEW is not granted.
  

Files:

• screenshotsplugin/0.10/tracscreenshots/api.py (modified) (3 diffs)
• screenshotsplugin/0.10/tracscreenshots/core.py (modified) (4 diffs)
• screenshotsplugin/0.10/tracscreenshots/htdocs/css/screenshots.css (modified) (3 diffs)
• screenshotsplugin/0.10/tracscreenshots/wiki.py (modified) (4 diffs)
• screenshotsplugin/0.11/tracscreenshots/core.py (modified) (7 diffs)
• screenshotsplugin/0.11/tracscreenshots/htdocs/css/screenshots.css (modified) (1 diff)
• screenshotsplugin/0.11/tracscreenshots/wiki.py (modified) (4 diffs)

screenshotsplugin/0.10/tracscreenshots/api.py

@@ -103 +103 @@
-            return row
-
-    def _format_screenshot(self, screenshot):
-        #screenshot['author'] = wiki_to_oneliner(screenshot['author'], self.env)
-        #screenshot['name'] = wiki_to_oneliner(screenshot['name'], self.env)
-        #screenshot['description'] = wiki_to_oneliner(screenshot['description'],
-        #  self.env)
-        screenshot['width'] = int(screenshot['width'])
-        screenshot['height'] = int(screenshot['height'])
-        screenshot['time'] = pretty_timedelta(screenshot['time'])
-        return screenshot
-
-    def get_screenshot(self, cursor, id):
-        # Get screenshot from database.
@@ -125 +115 @@
-            screenshot['versions'] = self.get_screenshot_versions(cursor,
-              screenshot['id'])
-elf._format_screenshot(screenshot)
+creenshot
-        else:
-            return None
@@ -136 +126 @@
-
-        # Append components and versions.
-
-
-
-
-
+
+
+
+
+
+
+
+
-
-    def get_screenshot_components(self, cursor, id):

screenshotsplugin/0.10/tracscreenshots/core.py

@@ -8 +8 @@
-from trac.web.chrome import Chrome, add_stylesheet, add_script
-from trac.web.clearsilver import HDFWrapper
-Markup, format_datetime
+format_datetime, pretty_timedelta
-from trac.util.html import html
-
@@ -120 +120 @@
-        req.hdf['screenshots.has_tags'] = self.env.is_component_enabled(
-          'tracscreenshots.tags.ScreenshotsTags')
-        #req.hdf['screenshots.has_tags'] = self.config.get('components',
-        #  'tracscreenshots.tags.screenshotstags') == 'enabled'
-        return template, content_type
-
@@ -167 +165 @@
-                height =  int(req.args.get('height') or 0)
-
-                self.log.debug(self.formats)
-
-                # Check if requested format is allowed.
-                if not format in self.formats:
@@ -183 +179 @@
-
-                    if format == 'html':
+                        # Format screenshot attributes.
+                        screenshot['time'] = pretty_timedelta(screenshot['time'])
+
-                        #Â Prepare data dictionary.
-                        data['screenshot'] = screenshot

screenshotsplugin/0.10/tracscreenshots/htdocs/css/screenshots.css

@@ -50 +50 @@
-  display: inline-block;
-  margin: 1em;
+  margin-top: 0.5em;
-  padding: 0em;
-  font-size: 75%;
@@ -58 +59 @@
-span.thumbnail-left
-{
+  margin-left : 0em;
-  float: left;
-}
@@ -63 +65 @@
-span.thumbnail-right
-{
+  margin-right: 0em;
-  float: right;
-}

screenshotsplugin/0.10/tracscreenshots/wiki.py

@@ -9 +9 @@
-from trac.util.html import html
-from trac.util.text import to_unicode
+from trac.util.datefmt import format_datetime
-
-from trac.wiki import IWikiSyntaxProvider, IWikiMacroProvider
@@ -16 +17 @@
-class ScreenshotsWiki(Component):
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    """
@@ -53 +88 @@
-    def render_macro(self, req, name, content):
-        if name == 'Screenshot':
+            # Check permission.
+            if not req.perm.has_permission('SCREENSHOTS_VIEW'):
+               return html.div('No permissions to see screenshots.',
+               class_ = 'system-message')
+
-            # Get database access.
-            db = self.env.get_db_cnx()
@@ -165 +205 @@
-        description = description.replace('$file',
-          to_unicode(screenshot['file']))
-
+
+
-        description = description.replace('$author', screenshot['author'])
-        description = description.replace('$description',

screenshotsplugin/0.11/tracscreenshots/core.py

@@ -6 +6 @@
-from trac.core import *
-from trac.mimeview import Context
-
-
+
+
+
-from trac.util.html import html
-from trac.util.text import to_unicode
@@ -42 +43 @@
-    #Â Configuration options.
-    mainnav_title = Option('screenshots', 'mainnav_title', 'Screenshots',
-
+doc = 
-    metanav_title = Option('screenshots', 'metanav_title', '',
-
+doc = 
-    path = Option('screenshots', 'path', '/var/lib/trac/screenshots',
-
-Option('screenshots', 'ext', 'jpg 
-
+doc = 
+ListOption('screenshots', 'ext', 'jpg,
+doc = 
-      ' supported by PIL.')
-Option('screenshots', 'formats', 'raw html jpg 
-
+ListOption('screenshots', 'formats', 'raw,html,jpg,
+doc = 
-    default_format = Option('screenshots', 'default_format', 'html',
-
-
-
-
-
+doc = 
+List
+doc = 
+List
+doc = 
-
-    # IPermissionRequestor methods.
-
-    def get_permission_actions(self):
-
+
+
+
+
+
-
-    # ITemplateProvider methods.
@@ -167 +172 @@
-
-                # Check if requested format is allowed.
-.split()
+
-                    raise TracError('Requested screenshot format that is not'
-                      ' allowed.', 'Requested format not allowed.')
@@ -247 +252 @@
-                result = reg.match(filename)
-                if result:
-.split()
+
-                        raise TracError('Unsupported uploaded file type.')
-                else:
@@ -448 +453 @@
-                      ' at least one.', 'No screenshots renderer enabled')
-
+                #Â Get all available components and versions.
+                components = [self.none_component] + api.get_components(
+                  context.cursor)
+                versions = [self.none_version] + api.get_versions(
+                  context.cursor)
+
-                # Get enabled components and versions from request or session.
-                enabled_components = self._get_enabled_components(context.req)
-                enabled_versions = self._get_enabled_versions(context.req)
+                if 'all' in enabled_components:
+                    enabled_components = [component['name'] for component in
+                    components]
+                if 'all' in enabled_versions:
+                    enabled_versions = [version['name'] for version in
+                    versions]
+
+                self.log.debug(enabled_components)
+
+                # Filter screenshots.
-                screenshots = api.get_filtered_screenshots(context,
-                  enabled_components, enabled_versions)
@@ -462 +483 @@
-                # Fill data dictionary.
-                self.data['id'] = screenshot_id
-
-
-
-
+
+
-                self.data['screenshots'] = screenshots
-                self.data['href'] = context.req.href.screenshots()
@@ -509 +528 @@
-
-    def _get_enabled_components(self, req):
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    def _get_enabled_versions(self, req):
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+

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

@@ -21 +21 @@
-  display: inline;
-}
+
+/* Wiki [[Screenshot()]] macro styles. */
+span.thumbnail > a > img
+{
+  display: inline;
+  border-color: #b00;
+  border-style: solid;
+  margin: 0em;
+  padding: 0em;
+}
+
+span.thumbnail > a
+{
+  display: inline-block;
+  border: 0px none;
+  margin: 0.2em;
+  padding: 0em;
+}
+
+span.thumbnail > span.description
+{
+  display: inline-block;
+}
+
+span.thumbnail, span.thumbnail-left, span.thumbnail-right
+{
+  display: inline-block;
+  margin: 1em;
+  margin-top: 0.5em;
+  padding: 0em;
+  font-size: 75%;
+  text-align: center;
+  vertical-align: middle;
+}
+
+span.thumbnail-left
+{
+  margin-left: 0em;
+  float: left;
+}
+
+span.thumbnail-right
+{
+  margin-right: 0em;
+  float: right;
+}

screenshotsplugin/0.11/tracscreenshots/wiki.py

@@ -4 +4 @@
-
-from trac.core import *
+from trac.config import Option
+from trac.wiki.formatter import format_to_html, format_to_oneliner
+from trac.web.chrome import add_stylesheet, add_script, format_datetime
-from trac.util.html import html
-
-
+
+
+
-
-from tracscreenshots.api import *
-
-class ScreenshotsWiki(Component):
+
+    screenshot_macro_doc = """Allows embed screenshot image in wiki page.
+First mandatory argument is ID of the screenshot. Number or image attributes
+can be specified next:
+
+ * {{{align}}} - Specifies image alignment in wiki page. Possible values are:
+   {{{left}}}, {{{right}}} and {{{center}}}.
+ * {{{alt}}} - Alternative description of image.
+ * {{{border}}} - Sets image border of specified width in pixels.
+ * {{{class}}} - Class of image for CSS styling.
+ * {{{description}}} - Brief description under the image. Accepts several
+   variables (see bellow).
+ * {{{format}}} - Format of returned image or screenshot behind link.
+ * {{{height}}} - Height of image. Set to 0 if you want original image height.
+ * {{{id}}} - ID of image for CSS styling.
+ * {{{longdesc}}} - Detailed description of image.
+ * {{{title}}} - Title of image.
+ * {{{usemap}}} - Image map for clickable images.
+ * {{{width}}} - Width of image. Set to 0 if you want original image width.
+
+Attribute {{{description}}} displays several variables:
+
+ * {{{$id}}} - ID of image.
+ * {{{$name}}} - Name of image.
+ * {{{$author}}} - User name who uploaded image.
+ * {{{$time}}} - Time when image was uploaded.
+ * {{{$file}}} - File name of image.
+ * {{{$description}}} - Detailed description of image.
+ * {{{$width}}} - Original width of image.
+ * {{{$height}}} - Original height of image.
+
+Example:
+
+{{{
+ [[Screenshot(2,width=400,height=300,description=The $name by $author: $description,align=left)]]
+}}}"""
+
-    """
-        The wiki module implements macro for screenshots referencing.
-    """
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-    # IWikiSyntaxProvider
+
-    def get_link_resolvers(self):
-        yield ('screenshot', self._screenshot_link)
@@ -27 +76 @@
-        return []
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-            # Create request context.
-            context = Context.from_request(formatter.req)('screenshots-wiki')
@@ -41 +102 @@
-            api = self.env[ScreenshotsApi]
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-            screenshot = api.get_screenshot(context, screenshot_id)
-
- Return macro content
+Â Build and return macro content.
-            if screenshot:
-                #Â Set default values of image attributes.
-
-
+
+
+
+
+
+
+
-
-                # Fill attributes from macro arguments.
@@ -58 +131 @@
-                    if match:
-                        attributes[str(match.group(1))] = match.group(2)
-                if attributes.has_key('width'):
-                    if attributes['width'] == '0':
-                        attributes['width'] = screenshot['width']
-                if attributes.has_key('height'):
-                    if attributes['height'] == '0':
-                        attributes['height'] = screenshot['height']
-                self.log.debug('attributes: %s' % (attributes,))
-
+                # Format screenshot description from template.
+                attributes['description'] = self._format_description(context,
+                  attributes['description'], screenshot)
+
+                # Make copy of attributes for image tag.
+                img_attributes = {'align' : 'center',
+                                  'style' : 'border-width: %spx;' % (
+                                    attributes['border'],)}
+                for attribute in attributes.keys():
+                    if attribute not in ('align', 'border', 'description',
+                      'format'):
+                        img_attributes[attribute] = attributes[attribute]
+
+                # Add CSS for image.
+                add_stylesheet(formatter.req, 'screenshots/css/screenshots.css')
+
-                # Build screenshot image and/or screenshot link.
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-            else:
-                return html.a(arguments[0], href = formatter.href.screenshots(),
-                  title = params, class_ = 'missing')
+
+    def _format_description(self, context, template, screenshot):
+        description = template.replace('$id', to_unicode(screenshot['id']))
+        description = description.replace('$name', screenshot['name'])
+        description = description.replace('$file',
+          to_unicode(screenshot['file']))
+        description = description.replace('$time', format_datetime(to_datetime(
+          screenshot['time'], utc)))
+        description = description.replace('$author', screenshot['author'])
+        description = description.replace('$description',
+          screenshot['description'])
+        description = description.replace('$width', to_unicode(
+          screenshot['width']))
+        description = description.replace('$height', to_unicode(
+          screenshot['height']))
+        self.log.debug(description)
+        return format_to_oneliner(self.env, context, description)
+