Merge lp:~graeme-acm/sahana-eden/RMS into lp:sahana-eden

[Graeme Foster]

Finishing off the spreadsheet translation

ticket #1042

=== modified file 'controllers/survey.py'
--- controllers/survey.py	2011-11-23 10:48:23 +0000
+++ controllers/survey.py	2011-11-25 15:29:24 +0000
@@ -28,13 +28,15 @@
 
 from gluon.contenttype import contenttype
 from gluon.serializers import json
+from gluon.languages import read_dict, write_dict
 
 from s3survey import S3AnalysisPriority, \
                      survey_question_type, \
                      survey_analysis_type, \
                      S3Chart, \
                      DataMatrix, MatrixElement, \
-                     S3QuestionTypeOptionWidget
+                     S3QuestionTypeOptionWidget, \
+                     survey_T
 
 module = request.controller
 prefix = request.controller
@@ -66,8 +68,18 @@
     def prep(r):
         if r.component and r.component_name == "translate":
             table = db["survey_translate"]
-            table.file.readable = False
-            table.file.writable = False
+            # list existing translations and allow the addition of a new translation
+            if r.component_id == None:
+                table.file.readable = False
+                table.file.writable = False
+            # edit the selected translation
+            else:
+                table.language.writable = False
+                table.code.writable = False
+            # remove CRUD generated buttons in the tabs
+            s3mgr.configure(table,
+                            deletable=False,
+                           )
         else:
             s3_action_buttons(r)
             query = (r.table.status == 1) # Status of Pending
@@ -88,8 +100,8 @@
      # Post-processor
     def postp(r, output):
         if r.component:
+            template_id = request.args[0]
             if r.component_name == "section":
-                template_id = request.args[0]
                 # Add the section select widget to the form
                 sectionSelect = response.s3.survey_section_select_widget(template_id)
                 output.update(form = sectionSelect)
@@ -101,9 +113,18 @@
                                             _class="action-btn",
                                             url=URL(c=module,
                                                     f="templateTranslateDownload",
-                                                    args=["[id]","update"])
-                                           ),
-                                      )
+                                                    args=["[id]"])
+                                           ),
+                                      )
+                response.s3.actions.append(
+                                       dict(label=str(T("Upload")),
+                                            _class="action-btn",
+                                            url=URL(c=module,
+                                                    f="template",
+                                                    args=[template_id,"translate","[id]"])
+                                           ),
+                                      )
+                return output
 
 
         # Add a button to show what the questionnaire looks like
@@ -147,16 +168,15 @@
 
     response.s3.prep = prep
 
-    # remove CRUD generated buttons in the tabs
-    s3mgr.configure(tablename,
-                    listadd=False,
-                    deletable=False,
-                   )
-    
     response.s3.postp = postp
     rheader = response.s3.survey_template_rheader
+    # remove CRUD generated buttons in the tabs
+    s3mgr.configure(tablename,
+                    listadd=False,
+                    deletable=False,
+                   )
     output = s3_rest_controller(prefix, resourcename, rheader=rheader)
-            
+
     return output
 
 def templateRead():
@@ -249,15 +269,24 @@
         redirect(URL(c="survey",
                      f="templateTranslation",
                      args=[],
-                     vars = {})) 
+                     vars = {}))
     code = record.code
     language = record.language
+    lang_fileName = "applications/%s/languages/%s.py" % (request.application, code)
+    try:
+        strings = read_dict(lang_fileName)
+    except:
+        strings = dict()
     template_id = record.template_id
+    template = response.s3.survey_getTemplate(template_id)
     book = xlwt.Workbook(encoding="utf-8")
     sheet = book.add_sheet(language)
     output = StringIO()
     qstnList = response.s3.survey_getAllQuestionsForTemplate(template_id)
     original = {}
+    original[template["name"]] = True
+    if template["description"] != "":
+        original[template["description"]] = True
     for qstn in qstnList:
         original[qstn["name"]] = True
         widgetObj = survey_question_type[qstn["type"]](question_id = qstn["qstn_id"])
@@ -267,6 +296,7 @@
                 original[option] = True
     sections = response.s3.survey_getAllSectionsForTemplate(template_id)
     for section in sections:
+        original[section["name"]]=True
         section_id = section["section_id"]
         layoutRules = response.s3.survey_getQstnLayoutRules(template_id, section_id)
         layoutStr = str(layoutRules)
@@ -290,10 +320,16 @@
     originalList.sort()
     for text in originalList:
         row += 1
+        original = unicode(text)
         sheet.write(row,
                     0,
-                    unicode(text)
+                    original
                    )
+        if (original in strings):
+            sheet.write(row,
+                        1,
+                        strings[original]
+                       )
 
     book.save(output)
     output.seek(0)
@@ -312,6 +348,14 @@
 
     def prep(r):
         if r.interactive:
+            if r.method == "create":
+                allTemplates = response.s3.survey_getAllTemplates()
+                if len(allTemplates) == 0:
+                    session.warning = T("You need to create a template before you can create a series")
+                    redirect(URL(c="survey",
+                             f="template",
+                             args=[],
+                             vars = {}))
             if r.id and (r.method == "update"):
                 table.template_id.writable = False
         return True
@@ -347,13 +391,6 @@
     s3mgr.load(tablename)
     crud_strings = response.s3.crud_strings[tablename]
 
-    # Check that the series_id has been passed in
-    if len(request.args) != 1:
-        output = s3_rest_controller(prefix,
-                                    resourcename,
-                                    rheader=response.s3.survey_series_rheader)
-        return output
-
     try:
         import xlwt
     except ImportError:
@@ -369,6 +406,22 @@
     # * The sections within the template
     # * The layout rules for each question
     ###################################################################### 
+    # Check that the series_id has been passed in
+    if len(request.args) != 1:
+        output = s3_rest_controller(prefix,
+                                    resourcename,
+                                    rheader=response.s3.survey_series_rheader)
+        return output
+    if "translationLanguage" in current.request.post_vars:
+        lang = current.request.post_vars.translationLanguage
+        if lang == "Default":
+            langDict = dict()
+        else:
+            try:
+                lang_fileName = "applications/%s/languages/%s.py" % (request.application, lang)
+                langDict = read_dict(lang_fileName)
+            except:
+                langDict = dict()
     series_id = request.args[0]
     sectionList = response.s3.survey_getAllSectionsForSeries(series_id)
     layout = {}
@@ -463,7 +516,8 @@
             (endrow, endcol) = widgetObj.writeToMatrix(matrix,
                                                        row,
                                                        col,
-                                                       answerMatrix=matrixAnswer
+                                                       answerMatrix=matrixAnswer,
+                                                       langDict = langDict
                                                       )
         except Exception as msg:
             print msg
@@ -492,7 +546,7 @@
         row += 1
     else:
         logo = None
-    title = template.description
+    title = survey_T(template.description, langDict)
     cell = MatrixElement(0,col,title, style="styleHeader")
     cell.merge(vertical=1, horizontal=4)
     matrix.addElement(cell)
@@ -502,7 +556,7 @@
         col = 0
         row += 1
         rules =  layout[section["name"]]
-        cell = MatrixElement(row,col,section["name"], style="styleHeader")
+        cell = MatrixElement(row,col,survey_T(section["name"],langDict), style="styleHeader")
         try:
             matrix.addElement(cell)
         except Exception as msg:
@@ -952,6 +1006,7 @@
 
     def postp(r, output):
         if r.interactive:
+            T = current.T
             if "viewing" in current.request.vars:
                 dummy, series_id = current.request.vars.viewing.split(".")
             elif "series" in current.request.vars:
@@ -966,20 +1021,36 @@
                              vars = {}))
             response.s3.survey_answerlist_dataTable_post(r)
             form = response.s3.survey_buildQuestionnaireFromSeries(series_id, None)
+            translationList = response.s3.survey_getAllTranslationsForSeries(series_id)
             urlexport = URL(c=module,
                             f="series_export_formatted",
                             args=[series_id]
                             )
+            tranForm = FORM(_action=urlexport)
+            tranForm.append(INPUT(_type='checkbox',
+                                _name='translationLanguage',
+                                _value="Default",
+                                value=True,
+                               ))
+            tranForm.append(LABEL("Default"))
+            for translation in translationList:
+                 tranForm.append(INPUT(_type='checkbox',
+                                    _name='translationLanguage',
+                                    _value=translation["code"],
+                                   ))
+                 tranForm.append(LABEL(translation["language"]))
+            exportBtn = INPUT(_type="submit", _id="export_btn", _name="Export_Spreadsheet", _value=T("Export Assessment as a Formatted Spreadsheet"))
+            tranForm.append(exportBtn)
             urlimport = URL(c=module,
                             f="complete",
                             args=[series_id,"import.xml"],
                             vars = {"extra_data":True}
                             )
-            T = current.T
-            buttons = DIV (A(T("Export Assessment as a Formatted Spreadsheet"), _href=urlexport, _id="Excel-export", _class="action-btn"),
+            buttons = DIV (#A(T("Export Assessment as a Formatted Spreadsheet"), _href=urlexport, _id="Excel-export", _class="action-btn"),
                            A(T("Import Spreadsheet as an Assessment"), _href=urlimport, _id="Excel-import", _class="action-btn"),
                           )
-            output["subtitle"] = buttons
+            tranForm.append(buttons)
+            output["subtitle"] = tranForm
             output["form"] = form
         return output
 
@@ -1032,7 +1103,7 @@
         except ImportError:
             print >> sys.stderr, "ERROR: xlrd & xlwt modules are needed for importing spreadsheets"
             return None
-        workbook = xlrd.open_workbook(filename=uploadFile)
+        workbook = xlrd.open_workbook(filename=uploadFile.file)
         sheetR = workbook.sheet_by_name("Assessment")
         sheetM = workbook.sheet_by_name("Metadata")
         header = '"Series"'

=== modified file 'models/survey.py'
--- models/survey.py	2011-11-23 13:40:47 +0000
+++ models/survey.py	2011-11-25 15:29:24 +0000
@@ -27,6 +27,8 @@
         import json
         sys.path.append("applications/%s/modules/s3" % request.application)
 
+        from gluon.languages import read_dict, write_dict
+
         from s3codec import S3Codec
         from xml.sax.saxutils import unescape
         from s3survey import survey_question_type, \
@@ -1334,9 +1336,71 @@
         s3.crud_strings[tablename] = Storage(
             title_create = T("Add new translation language"),
         )
+
+        def translate_onaccept(form):
+            """
+                If the translation spreadsheet has been uploaded then
+                it needs to be processed.
+                
+                The translation strings need to be extracted from
+                the spreadsheet and inserted into the language file.
+            """
+            if "file" in form.vars:
+                try:
+                    import xlrd
+                except ImportError:
+                    print >> sys.stderr, "ERROR: xlrd & xlwt modules are needed for importing spreadsheets"
+                    return None
+
+                msgNone = T("No translations exist in spreadsheet")
+                upload_file = current.request.post_vars.file
+                upload_file.file.seek(0)
+                openFile = upload_file.file.read()
+                lang = form.record.language
+                code = form.record.code
+                try:
+                    workbook = xlrd.open_workbook(file_contents=openFile)
+                except:
+                    msg = T("Unable to open spreadsheet")
+                    current.response.error = msg
+                    current.response.flash = None
+                    return
+                try:
+                    sheetL = workbook.sheet_by_name(lang)
+                except:
+                    msg = T("Unable to find sheet %(sheet_name)s in uploaded spreadsheet") % dict(sheet_name=lang)
+                    current.response.error = msg
+                    current.response.flash = None
+                    return
+                if sheetL.ncols == 1:
+                    current.response.warning = msgNone
+                    current.response.flash = None
+                    return
+                count = 0
+                lang_fileName = "applications/%s/languages/%s.py" % (request.application, code)
+                try:
+                    strings = read_dict(lang_fileName)
+                except:
+                    strings = dict()
+                for row in xrange(1, sheetL.nrows):
+                    original = sheetL.cell_value(row, 0)
+                    translation = sheetL.cell_value(row, 1)
+                    if (original not in strings) or translation != "":
+                        strings[original] = translation
+                        count += 1
+                write_dict(lang_fileName, strings)
+                if count == 0:
+                    current.response.warning = msgNone
+                    current.response.flash = None
+                else:
+                    current.response.flash = T("%(count_of)d translations have been imported to the %(language)s language file") % dict(count_of=count, language=lang)
+
         # components
         s3mgr.model.add_component("survey_translate",
                               survey_template="template_id")
+        s3mgr.configure(tablename,
+                        onaccept = translate_onaccept,
+                        )
         #**********************************************************************
         # The bread and butter methods to get data off the database
         #**********************************************************************
@@ -1390,6 +1454,14 @@
         #**********************************************************************
         # Functions to get a list of records from the database
         #**********************************************************************
+        def getAllTemplates():
+            """
+                function to return all the templates on the database
+            """
+            table = db.survey_template
+            row = db(table).select()
+            return row
+
         def getAllSeries():
             """
                 function to return all the series on the database
@@ -1398,6 +1470,22 @@
             row = db(table).select()
             return row
 
+        def getAllTranslationsForTemplate(template_id):
+            """
+                function to return all the translations for the given template
+            """
+            table = db.survey_translate
+            row = db(table).select()
+            return row
+
+        def getAllTranslationsForSeries(series_id):
+            """
+                function to return all the translations for the given series
+            """
+            row = getSeries(series_id)
+            template_id = row.template_id
+            return getAllTranslationsForTemplate(template_id)
+
         def getAllQuestionsForTemplate(template_id):
             """
                 function to return the list of questions for the given template
@@ -1604,9 +1692,11 @@
                     tabs = [(T("Basic Details"), "read"),
                             (T("Question Details"),"templateRead/"),
                             (T("Question Summary"),"templateSummary/"),
-                            (T("Translate"),"translate"),
 #                            (T("Sections"), "section"),
                            ]
+                    if auth.s3_has_permission("create", "survey_translate"):
+                        tabs.append((T("Translate"),"translate"))
+
                     rheader_tabs = s3_rheader_tabs(r, tabs)
 
                     sectionTable = db["survey_section"]
@@ -2322,10 +2412,14 @@
 
         return_dict = dict(
             survey_updateMetaData = updateMetaData,
+            survey_getTemplate = getTemplate,
             survey_getTemplateFromSeries = getTemplateFromSeries,
             survey_getSeries = getSeries,
             survey_getSeriesName = getSeriesName,
             survey_getTranslation = getTranslation,
+            survey_getAllTranslationsForTemplate = getAllTranslationsForTemplate,
+            survey_getAllTranslationsForSeries = getAllTranslationsForSeries,
+            survey_getAllTemplates = getAllTemplates,
             survey_getAllSeries = getAllSeries,
             survey_getAllSectionsForTemplate = getAllSectionsForTemplate,
             survey_getAllSectionsForSeries = getAllSectionsForSeries,
@@ -2411,8 +2505,9 @@
           If the record is a duplicate then it will set the job method to update
 
           Rules for finding a duplicate:
-           - Look for a record with the same name, ignoring case
-           - and the same template
+           - Look for a record with the same name
+           - the same template
+           - and the same position within the template
         """
         # ignore this processing if the id is set
         if job.id:
@@ -2420,9 +2515,9 @@
         if job.tablename == "survey_section":
             table = job.table
             name = "name" in job.data and job.data.name
+            posn = "posn" in job.data and job.data.posn
             template = "template" in job.data and job.data.template_id
-
-        query =  table.name.lower().like('%%%s%%' % name.lower())
+        query =  ((table.name==name) & (table.template_id==template) & (table.posn==posn))
         _duplicate = db(query).select(table.id, limitby=(0, 1)).first()
         if _duplicate:
             job.id = _duplicate.id

=== modified file 'modules/s3/s3survey.py'
--- modules/s3/s3survey.py	2011-11-23 13:42:20 +0000
+++ modules/s3/s3survey.py	2011-11-25 15:29:24 +0000
@@ -251,6 +251,15 @@
     return S3QuestionTypeGridWidget(question_id)
 def survey_gridChildType(question_id = None):
     return S3QuestionTypeGridChildWidget(question_id)
+def survey_T(phrase, langDict):
+    """
+        Function to translate a phrase using the dictionary passed in
+    """
+    if phrase in langDict and langDict[phrase] != "":
+        return langDict[phrase]
+    else:
+        return phrase
+
 
 survey_question_type = {
     "String": survey_stringType,
@@ -493,10 +502,17 @@
         """
         return DIV(self.typeDescription, _class="surveyWidgetType")
 
+    def _Tquestion(self, langDict):
+        """
+            Function to translate the question using the dictionary passed in
+        """
+        return survey_T(self.question["name"], langDict)
+
     def writeToMatrix(self,
                       matrix, 
                       row,
                       col,
+                      langDict=dict(),
                       answerMatrix=None,
                       style={"Label": True
                             ,"LabelLeft" : True
@@ -507,7 +523,7 @@
         """
         self._store_metadata()
         if "Label" in style and style["Label"]:
-            cell = MatrixElement(row,col,self.question["name"], style="styleSubHeader")
+            cell = MatrixElement(row,col,self._Tquestion(langDict), style="styleSubHeader")
             matrix.addElement(cell)
             if "LabelLeft" in style and style["LabelLeft"]:
                 col += 1
@@ -867,6 +883,7 @@
                       matrix,
                       row,
                       col,
+                      langDict=dict(),
                       answerMatrix=None,
                       style={"Label": True
                             ,"LabelLeft" : False
@@ -877,7 +894,7 @@
         """
         self._store_metadata()
         if "Label" in style and style["Label"]:
-            cell = MatrixElement(row,col,self.question["name"], style="styleSubHeader")
+            cell = MatrixElement(row,col,self._Tquestion(langDict), style="styleSubHeader")
             matrix.addElement(cell)
             if "LabelLeft" in style and style["LabelLeft"]:
                 col += 1
@@ -895,7 +912,7 @@
             answerMatrix.addElement(cell)
             answerCol = 3
         for option in list:
-            cell = MatrixElement(row,col,option, style="styleText")
+            cell = MatrixElement(row,col,survey_T(option, langDict), style="styleText")
             matrix.addElement(cell)
             cell = MatrixElement(row,col+1,"", style="styleInput")
             matrix.addElement(cell)
@@ -1327,6 +1344,7 @@
                       matrix,
                       row,
                       col,
+                      langDict=dict(),
                       answerMatrix=None,
                       style={"Label": True
                             ,"LabelLeft" : True
@@ -1343,7 +1361,7 @@
         gridStyle = style
         gridStyle["Label"] = False
         if self.data != None:
-            cell = MatrixElement(row,col,self.subtitle, style="styleSubHeader")
+            cell = MatrixElement(row,col,survey_T(self.subtitle, langDict), style="styleSubHeader")
             matrix.addElement(cell)
             # Add a *mostly* blank line for the heading.
             # This will be added on the first run through the list
@@ -1356,12 +1374,12 @@
             for line in self.data:
                 col = startcol
                 row = nextrow
-                cell = MatrixElement(row,col,self.rows[posn], style="styleText")
+                cell = MatrixElement(row,col,survey_T(self.rows[posn], langDict), style="styleText")
                 matrix.addElement(cell)
                 col += 1
                 for cell in line:
                     if firstRun:
-                        cell = MatrixElement(row-1,col,self.columns[colCnt], style="styleSubHeader")
+                        cell = MatrixElement(row-1,col,survey_T(self.columns[colCnt], langDict), style="styleSubHeader")
                         matrix.addElement(cell)
                         colCnt += 1
                     if cell == "Blank":
@@ -1372,7 +1390,12 @@
                         childWidget = self.getChildWidget(code)
                         type = childWidget.get("Type")
                         realWidget = survey_question_type[type](childWidget.id)
-                        (endrow, col) = realWidget.writeToMatrix(matrix, row, col, answerMatrix, style)
+                        (endrow, col) = realWidget.writeToMatrix(matrix,
+                                                                 row,
+                                                                 col, 
+                                                                 langDict,
+                                                                 answerMatrix,
+                                                                 style)
                     if endrow > nextrow:
                         nextrow = endrow
                 posn += 1
@@ -1501,7 +1524,8 @@
     def writeToMatrix(self,
                       matrix,
                       row,
-                      col, 
+                      col,
+                      langDict=dict(),
                       answerMatrix=None,
                       style={}
                      ):