Ability to select the number of sample sticker copies for printing

CHANGES.rst

@@ -6,6 +6,8 @@ Changelog
 
 **Added**
 
+- #618 When previewing stickers the number of copies to print for each sticker can be modified.
+- #618 The default number of sticker copies can be set and edited in the setup Sticker's tab.  
 
 **Removed**
 

bika/lims/browser/stickers.py

@@ -52,9 +52,14 @@ class Sticker(BrowserView):
             -- other_worksheet_stickers_...
     """
     template = ViewPageTemplateFile("templates/stickers_preview.pt")
-    item_index = 0
-    current_item = None
-    rendered_items = []
+
+    def __init__(self, context, request):
+        super(Sticker, self).__init__(context, request)
+        self.item_index = 0
+        self.current_item = None
+        self.copies_count = None
+        self.context = context
+        self.request = request
 
     def __call__(self):
         # Need to generate a PDF with the stickers?
@@ -66,7 +71,8 @@ def __call__(self):
             pdfstream = self.pdf_from_post()
             return pdfstream
 
-        self.rendered_items = []
+        self.copies_count = self.get_copies_count()
+
         items = self.request.get('items', '')
         # If filter by type is given in the request, only the templates under
         # the path with the type name will be given as vocabulary.
@@ -79,6 +85,9 @@ def __call__(self):
             # Default fallback, load from context
             self.items = [self.context, ]
 
+        # before retrieving the required data for each type of object copy
+        # each object as many times as the number of desired sticker copies
+        self.items = self._resolve_number_of_copies(self.items)
         new_items = []
         for i in self.items:
             outitems = self._populateItems(i)
@@ -243,9 +252,7 @@ def nextItem(self):
         """
         if self.item_index == len(self.items):
             self.item_index = 0
-            self.rendered_items = []
         self.current_item = self.items[self.item_index]
-        self.rendered_items.append(self.current_item[2].getId())
         self.item_index += 1
         return self.current_item
 
@@ -305,7 +312,7 @@ def _getStickersTemplatesDirectory(self, resource_name):
         for the stickers deppending on the filter_by_type.
         :param resource_name: The name of the resource folder.
         :type resource_name: string
-        :resturns: a string as a path
+        :returns: a string as a path
         """
         templates_dir =\
             queryResourceDirectory('stickers', resource_name).directory
@@ -324,3 +331,36 @@ def pdf_from_post(self):
         pdf_fn = tempfile.mktemp(suffix='.pdf')
         pdf_file = createPdf(htmlreport=reporthtml, outfile=pdf_fn)
         return pdf_file
+
+    def _resolve_number_of_copies(self, items):
+        """For the given objects generate as many copies as the desired
+        number of stickers. The desired number of stickers for each
+        object is given by copies_count
+
+        :param items: list of objects whose stickers are going to be previewed.
+        :type items: list
+        :returns: list containing n copies of each object in the items list,
+        where n is self.copies_count
+        :rtype: list
+        """
+        copied_items = []
+        for obj in items:
+            for copy in range(self.copies_count):
+                copied_items.append(obj)
+        return copied_items
+
+    def get_copies_count(self):
+        """Return the copies_count number request parameter
+
+        :returns: the number of copies for each sticker as stated
+        in the request
+        :rtype: int
+        """
+        try:
+            copies_count = int(self.request.form.get("copies_count"))
+        except (TypeError, ValueError):
+            # default number of copies is a mandatory integer field in senaite setup
+            # so theoretically this should never fail
+            copies_count = self.context.bika_setup.getDefaultNumberOfCopies()
+
+        return copies_count

bika/lims/browser/templates/stickers_preview.pt

@@ -61,6 +61,23 @@
               background-color: #bbb;
               text-shadow: 1px 1px 1px #aaa;
         }
+        #sticker-preview-header #sticker-copies input {
+            text-align:center;
+            width:15mm;
+            margin:0 0 10px 0;
+            background-color: #aaa;
+            border-radius: 5px;
+            color: #fff;
+            font-family: Helvetica,Arial;
+            font-size: 9pt;
+            font-weight: bold;
+            padding: 4px 2px;
+            text-decoration: none;
+            text-shadow: 1px 1px 1px #999;
+            text-transform: uppercase;
+            border:none;
+            cursor:pointer;
+        }
         #sticker-rule {
             color: rgb(51, 51, 51);
             height: 10mm;
@@ -142,7 +159,10 @@
                 window.location = $(this).attr('data-url');
             });
             $('select#template').change(function(e) {
-                reload($('select#template').val());
+                reload($('select#template').val(), $('#copies_count').val());
+            });
+            $('#copies_count').change(function(e) {
+                reload($('select#template').val(), $('#copies_count').val());
             });
             var stickwidth = $('.sticker').first().width();
             $('#sticker-rule').css({'width':stickwidth,'max-width':stickwidth});
@@ -151,14 +171,14 @@
             /**
              * Re-loads the stickers preview by using the template specified
              */
-            function reload(template) {
+            function reload(template, copies_count) {
                 var baseurl = $('body').attr('data-itemsurl');
                 $('#stickers-wrapper').fadeTo('fast', 0.4);
                 $.ajax({
                     url: baseurl,
                     type: 'POST',
                     async: true,
-                    data: {"template": template}
+                    data: {"template": template, "copies_count": copies_count}
                 })
                 .always(function(data) {
                     var htmldata = data;
@@ -221,6 +241,13 @@
                     </tal:formats>
                     </select>
                 </div>
+                <div id='sticker-copies'>
+                    <label for="copies_count" i18n:translate="">Number of copies</label>
+                    <input name="copies_count" id="copies_count"
+                        type="number"
+                        min="1"
+                        tal:attributes="value view/copies_count"/>
+                </div>
             </div>
             <div id='sticker-buttons'>
                 <input type="button" id='cancel-button' value="Go back"
@@ -241,11 +268,11 @@
               </tal:tick>
             </div>
             <tal:stickers repeat="sticker view/items">
-            <tal:sticker define="item_id python:sticker[2].getId() if sticker else None;"
-                         condition="python:not item_id or item_id not in view.rendered_items">
-            <div class='sticker'
-                 tal:content='structure python:view.renderItem()'></div>
-            </tal:sticker>
+                    <tal:sticker define="item_id python:sticker[2].getId() if sticker else None;">
+                    <div class='sticker'
+                         tal:condition="python:item_id is not None"
+                         tal:content='structure python:view.renderItem()'></div>
+                    </tal:sticker>
             </tal:stickers>
         </div>
     </div>

bika/lims/content/bikasetup.py

@@ -735,6 +735,16 @@ def getCounterTypes(self, instance=None):
             description=_("Select which sticker should be used as the 'large' sticker by default")
         )
     ),
+    IntegerField(
+        'DefaultNumberOfCopies',
+        schemata="Sticker",
+        required="1",
+        default="1",
+        widget=IntegerWidget(
+            label=_("Number of copies"),
+            description=_("Set the default number of copies to be printed for each sticker")
+        )
+    ),
     IDFormattingField(
         'IDFormatting',
         schemata="ID Server",