Changeset 34406d in indico

Timestamp:

06/10/10 18:11:36 (3 years ago)

Author:

Jeremy Herr <jeremy.herr@…>

Branches:

master, burotel, hello-world-walkthrough, ipv6, new-webex, v0.97-series, v0.98-series, v0.98.2, v0.98.3, v0.98b1, v0.98b2, v0.99, 051b2622c51afb171a1dedb46a0df4fbb0cbd02e, 00b052b1a13a63c5c79db7f3ad310f643651dc50

Children:

a11194

Parents:

b04aa4

git-author:

David Martín Clavo <david.martin.clavo@…> (04/16/10 18:27:52)

git-committer:

Jeremy Herr <jeremy.herr@…> (06/10/10 18:11:36)

Message:

[REF] Changed 2 classes to use classmethods

• MicalaCommunication? and MarcAccessListGenerator? dont store or use anything from "self" in their methods, and have no constructor.

Location:

indico/MaKaC

Files:

• common/output.py (modified) (4 diffs)
• plugins/Collaboration/RecordingManager/common.py (modified) (3 diffs)
• plugins/Collaboration/RecordingManager/micala.py (modified) (10 diffs)
• plugins/Collaboration/RecordingManager/output.py (modified) (3 diffs)
• plugins/Collaboration/RecordingManager/services.py (modified) (2 diffs)

indico/MaKaC/common/output.py

@@ -268 +268 @@
                     # because we have verified that the RecordingManager plugin is installed.
                     from MaKaC.plugins.Collaboration.RecordingManager.output import MarcAccessListGenerator
-                    MarcAccessListGenerator().generateAccessListXML(out, conf)
-                    MarcAccessListGenerator().generateVideoXML(out, recordingManagerTags)
-                    MarcAccessListGenerator().generateLanguagesXML(out, recordingManagerTags)
+                    MarcAccessListGenerator.generateAccessListXML(out, conf)
+                    MarcAccessListGenerator.generateVideoXML(out, recordingManagerTags)
+                    MarcAccessListGenerator.generateLanguagesXML(out, recordingManagerTags)
 
         if conf.canModify( self.__aw ) and vars and modificons:
@@ -563 +563 @@
                     # only now do we know it's safe to import the necessary method
                     from MaKaC.plugins.Collaboration.RecordingManager.output import MarcAccessListGenerator
-                    MarcAccessListGenerator().generateAccessListXML(out, session)
-                    MarcAccessListGenerator().generateVideoXML(out, recordingManagerTags)
-                    MarcAccessListGenerator().generateLanguagesXML(out, recordingManagerTags)
+                    MarcAccessListGenerator.generateAccessListXML(out, session)
+                    MarcAccessListGenerator.generateVideoXML(out, recordingManagerTags)
+                    MarcAccessListGenerator.generateLanguagesXML(out, recordingManagerTags)
 
         out.closeTag("session")
@@ -797 +797 @@
                     # only now do we know it's safe to import the necessary method
                     from MaKaC.plugins.Collaboration.RecordingManager.output import MarcAccessListGenerator
-                    MarcAccessListGenerator().generateAccessListXML(out, contribution)
-                    MarcAccessListGenerator().generateVideoXML(out, recordingManagerTags)
-                    MarcAccessListGenerator().generateLanguagesXML(out, recordingManagerTags)
+                    MarcAccessListGenerator.generateAccessListXML(out, contribution)
+                    MarcAccessListGenerator.generateVideoXML(out, recordingManagerTags)
+                    MarcAccessListGenerator.generateLanguagesXML(out, recordingManagerTags)
 
         out.closeTag("contribution")
@@ -882 +882 @@
                     # only now do we know it's safe to import the necessary method
                     from MaKaC.plugins.Collaboration.RecordingManager.output import MarcAccessListGenerator
-                    MarcAccessListGenerator().generateAccessListXML(out, subCont)
-                    MarcAccessListGenerator().generateVideoXML(out, recordingManagerTags)
-                    MarcAccessListGenerator().generateLanguagesXML(out, recordingManagerTags)
+                    MarcAccessListGenerator.generateAccessListXML(out, subCont)
+                    MarcAccessListGenerator.generateVideoXML(out, recordingManagerTags)
+                    MarcAccessListGenerator.generateLanguagesXML(out, recordingManagerTags)
 
         out.closeTag("subcontribution")

indico/MaKaC/plugins/Collaboration/RecordingManager/common.py

@@ -198 +198 @@
     cds_indico_matches = getCDSRecords(conference.getId())
     Logger.get('RecMan').info('cds_indico_pending...')
-    cds_indico_pending = MicalaCommunication().getCDSPending(conference.getId(), cds_indico_matches)
+    cds_indico_pending = MicalaCommunication.getCDSPending(conference.getId(), cds_indico_matches)
 
     # In case there are any records that were pending and are now appearing in CDS,
     # then update the micala database accordingly.
-    MicalaCommunication().updateMicalaCDSExport(cds_indico_matches, cds_indico_pending)
+    MicalaCommunication.updateMicalaCDSExport(cds_indico_matches, cds_indico_pending)
 
     Logger.get('RecMan').info("cds_indico_matches: %s, cds_indico_pending: %s" % (cds_indico_matches, cds_indico_pending))
@@ -219 +219 @@
 
     # Get list of matching IndicoID's and LOIDs from the Micala database
-    existing_matches = MicalaCommunication().getMatches(conference.getId())
+    existing_matches = MicalaCommunication.getMatches(conference.getId())
 
     # insert any existing matches into the recordable_events array
@@ -516 +516 @@
 
     # Update the micala database with our current task status
-    idMachine = MicalaCommunication().getIdMachine(CollaborationTools.getOptionValue("RecordingManager", "micalaDBMachineName"))
-    idTask    = MicalaCommunication().getIdTask(CollaborationTools.getOptionValue("RecordingManager", "micalaDBStatusExportCDS"))
-    idLecture = MicalaCommunication().getIdLecture(IndicoID, pattern_cern, pattern_umich)
+    idMachine = MicalaCommunication.getIdMachine(CollaborationTools.getOptionValue("RecordingManager", "micalaDBMachineName"))
+    idTask    = MicalaCommunication.getIdTask(CollaborationTools.getOptionValue("RecordingManager", "micalaDBStatusExportCDS"))
+    idLecture = MicalaCommunication.getIdLecture(IndicoID, pattern_cern, pattern_umich)
     if idLecture == '':
-        idLecture = MicalaCommunication().createNewMicalaLecture(IndicoID, contentType, pattern_cern, pattern_umich)
-    MicalaCommunication().reportStatus('START', '', idMachine, idTask, idLecture)
+        idLecture = MicalaCommunication.createNewMicalaLecture(IndicoID, contentType, pattern_cern, pattern_umich)
+    MicalaCommunication.reportStatus('START', '', idMachine, idTask, idLecture)
 
     # temporary, for my own debugging

indico/MaKaC/plugins/Collaboration/RecordingManager/micala.py

@@ -6 +6 @@
 
 class MicalaCommunication(object):
-    def _init_(self):
-        pass
-
-    def getIp(self):
+
+    @classmethod
+    def getIp(cls):
         '''This should return the IP of the current machine.'''
         return("")
 
-    def getIdMachine(self, machine_name):
+    @classmethod
+    def getIdMachine(cls, machine_name):
         '''Look up ID of this machine in database'''
 
@@ -46 +46 @@
         return(idMachine)
 
-    def getIdTask(self, task_name):
+    @classmethod
+    def getIdTask(cls, task_name):
         '''Look up ID of this task in database'''
 
@@ -77 +78 @@
         return(idTask)
 
-    def getIdLecture(self, lecture_name, pattern_cern, pattern_umich):
+    @classmethod
+    def getIdLecture(cls, lecture_name, pattern_cern, pattern_umich):
         '''Look up ID of this lecture in database'''
 
@@ -116 +118 @@
         return(idLecture)
 
-    def createNewMicalaLecture(self, lecture_name, contentType, pattern_cern, pattern_umich):
+    @classmethod
+    def createNewMicalaLecture(cls, lecture_name, contentType, pattern_cern, pattern_umich):
         '''insert a record into the micala database for a new lecture'''
 
@@ -153 +156 @@
         connection.close()
 
-        return self.getIdLecture(lecture_name, pattern_cern, pattern_umich)
-
-    def getMatches(self, confID):
+        return cls.getIdLecture(lecture_name, pattern_cern, pattern_umich)
+
+    @classmethod
+    def getMatches(cls, confID):
         '''For the current conference, get list from the database of IndicoID's already matched to Lecture Object.'''
 
@@ -180 +184 @@
         return (match_array)
 
-    def reportStatus(self, status, message, idMachine, idTask, idLecture):
+    @classmethod
+    def reportStatus(cls, status, message, idMachine, idTask, idLecture):
         '''Make status report to the database'''
 
@@ -206 +211 @@
 
     # WHO THE HELL CALLS THIS?!
-    def updateMicala(self, IndicoID, contentType, LOID):
+    @classmethod
+    def updateMicala(cls, IndicoID, contentType, LOID):
         """Submit Indico ID to the micala DB"""
 
@@ -239 +245 @@
             pass
 
-    def getCDSPending(self, confId, cds_indico_matches):
+    @classmethod
+    def getCDSPending(cls, confId, cds_indico_matches):
         """Query the Micala database to find Indico IDs whose MARC has been exported to CDS, but no CDS record exists yet.
         Return a list of these Indico IDs."""
@@ -280 +287 @@
         return talk_array
 
-    def updateMicalaCDSExport(self, cds_indico_matches, cds_indico_pending):
+    @classmethod
+    def updateMicalaCDSExport(cls, cds_indico_matches, cds_indico_pending):
         '''If there are records found in CDS but not yet listed in the micala database as COMPLETE, then update it.
         cds_indico_matches is a dictionary of key-value pairs { IndicoID1: CDSID1, IndicoID2: CDSID2, ... }
@@ -289 +297 @@
             try:
                 new_record = cds_indico_matches[pending]
-                idMachine = self.getIdMachine(CollaborationTools.getOptionValue("RecordingManager", "micalaDBMachineName"))
-                idTask    = self.getIdTask(CollaborationTools.getOptionValue("RecordingManager", "micalaDBStatusExportCDS"))
+                idMachine = cls.getIdMachine(CollaborationTools.getOptionValue("RecordingManager", "micalaDBMachineName"))
+                idTask    = cls.getIdTask(CollaborationTools.getOptionValue("RecordingManager", "micalaDBStatusExportCDS"))
                 import re
                 pattern_cern  = re.compile('([sc\d]+)$')
                 pattern_umich = re.compile('(\d+\-[\w\d]+\-\d)$')
-                idLecture = self.getIdLecture(pending, pattern_cern, pattern_umich)
-                self.reportStatus("COMPLETE", "CDS record: %s" % new_record, idMachine, idTask, idLecture)
+                idLecture = cls.getIdLecture(pending, pattern_cern, pattern_umich)
+                cls.reportStatus("COMPLETE", "CDS record: %s" % new_record, idMachine, idTask, idLecture)
 
                 # I should still update the Lectures table to add the CDS record

indico/MaKaC/plugins/Collaboration/RecordingManager/output.py

@@ -6 +6 @@
 
 class MarcAccessListGenerator(object):
-    def __init__(self):
-        pass
 
-    def generateAccessListXML(self, out, obj):
+    @classmethod
+    def generateAccessListXML(cls, out, obj):
         """Generate a comprehensive access list showing all users and e-groups who may access
         this object, taking into account the permissions and access lists of its owners.
@@ -41 +40 @@
                 out.closeTag("allowedAccessEmails")
 
-    def generateVideoXML(self, out, recordingManagerTags):
+    @classmethod
+    def generateVideoXML(cls, out, recordingManagerTags):
         """Generate XML variables needed for video records."""
 
@@ -62 +62 @@
             out.writeTag("videoFormat", contentTypeWebLecture)
 
-    def generateLanguagesXML(self, out, recordingManagerTags):
+    @classmethod
+    def generateLanguagesXML(cls, out, recordingManagerTags):
         """Generate XML variables needed for language information."""
 

indico/MaKaC/plugins/Collaboration/RecordingManager/services.py

@@ -39 +39 @@
     def _getAnswer(self):
 #        here is where we make a submission to the database?
-        MicalaCommunication().updateMicala(self._params.get('IndicoID', None), self._params.get('LOID', None))
+        MicalaCommunication.updateMicala(self._params.get('IndicoID', None), self._params.get('LOID', None))
         return {'some':'thing'}
 
@@ -73 +73 @@
     def _getAnswer(self):
         # Update the micala database
-        resultUpdateMicala = MicalaCommunication().updateMicala(self._IndicoID,
+        resultUpdateMicala = MicalaCommunication.updateMicala(self._IndicoID,
                                           self._contentType,
                                           self._params.get('LOID', None))