Changeset 11878 for main/waeup.kwarapoly

Timestamp:

27 Oct 2014, 23:26:21 (10 years ago)

Author:

uli

Message:

Make the signature appear in admission notification PDF.

Location:

main/waeup.kwarapoly/branches/uli-pdfsigs/src/waeup/kwarapoly

Files:

• browser/pdf.py (modified) (2 diffs)
• browser/static/pdf_signature.png (added)
• students/browser.py (modified) (1 diff)

main/waeup.kwarapoly/branches/uli-pdfsigs/src/waeup/kwarapoly/browser/pdf.py

@@ -21 +21 @@
 
 import os
+from string import Template
 from waeup.kofa.browser.pdf import PDFCreator
 
@@ -34 +35 @@
     #watermark_pos = [-25, 100]
     logo_pos = [507, 740, 70]
+
+    signature_img_path = os.path.join(
+        os.path.dirname(__file__), 'static', 'pdf_signature.png')
+
+    def substitute_markers(self, text):
+        """If `text` contains some marker, substitute it.
+
+        Markers are standard library string template placeholders. See
+        https://docs.python.org/2/library/string.html and
+        `string.Template` for details. Roughly, placeholders look like
+        ``${some_marker}``.
+
+        Valid markers:
+           ``signature_img_path`` -- path to signature image stored in
+                                     `signature_img_path`` attribute.
+        """
+        text = Template(text)
+        return text.safe_substitute(
+            {
+                'signature_img_path': self.signature_img_path,
+                }
+            )
+
+    def create_pdf(self, *args, **kw):
+        """Create PDF from args and keywords.
+
+        Unlike the base method, we mangle any `notes` keyword and
+        substitute any valid placeholder strings in it. See
+        `substitute_markers` for a list of valid placeholders.
+
+        XXX: This is only a quick, dirty hack, that should not appear
+             in this package. Instead it should be moved to the
+             waeup.kofa basepackage.
+
+        Please note: string substitution like this can introduce nasty
+        security holes. For instance all dynamic input in `notes` must
+        be cleaned up and placeholder expressions should be removed
+        from it before using it in `note`.
+
+        Also, `note` is clearly misused in this case. We might want to
+        look for a more general approach, maybe z3c.rml?
+        """
+        if 'note' in kw.keys() and kw['note'] is not None:
+            kw['note'] = self.substitute_markers(kw['note'])
+        return super(CustomPDFCreator, self).create_pdf(*args, **kw)

main/waeup.kwarapoly/branches/uli-pdfsigs/src/waeup/kwarapoly/students/browser.py

@@ -376 +376 @@
 14. You possess the entry requirement for the programme you are admitted.<br /><br />
 
+<img src="${signature_img_path}" valign="middle"  height="45.8mm" width="20mm" /><br />
 M.O. Adebayo<br />
 Admission Officer<br />
 For: Registrar
 """
+# XXX: a note for <img /> tag used here (from reportlab docs):
+#   The valign attribute may be set to a css like value from "baseline", "sub",
+#   "super", "top", "text-top", "middle", "bottom", "text-bottom";
+#   the value may also be a numeric percentage or an absolute value.
+#
+# Burn this remark after reading.