correct wrong return in mongo plugin + lint

bmx0r · bmx0r · commit c9818a8fa6d2 · 2013-05-30T00:26:29.000+02:00
modified:   libnmap/plugins/backendplugin.py
	modified:   libnmap/plugins/mongodb.py
diff --git a/libnmap/plugins/backendplugin.py b/libnmap/plugins/backendplugin.py
@@ -35,9 +35,9 @@ def get(self, id):
         """
         raise NotImplementedError
 
-    def getall(self):
+    def getall(self, filter):
         """
-            :return: collection of NmapReport
+            :return: collection of tuple (id,NmapReport)
             :param filter: Nice to have implement a filter capability
         """
         raise NotImplementedError
diff --git a/libnmap/plugins/mongodb.py b/libnmap/plugins/mongodb.py
@@ -9,6 +9,14 @@
 
 
 class NmapMongodbPlugin(NmapBackendPlugin):
+    """
+        This class handle the persistence of NmapRepport object in mongodb
+        Implementation is made using pymongo
+        Object of this class must be create via the
+        BackendPluginFactory.create(**url) where url is a named dict like
+        {'plugin_name': "mongodb"} this dict may reeive all the param
+        MongoClient() support
+    """
     def __init__(self, dbname=None, store=None, **kwargs):
         NmapBackendPlugin.__init__(self)
         if dbname is not None:
@@ -26,11 +34,11 @@ def insert(self, report):
         """
         j = json.dumps(report, cls=ReportEncoder)
         try:
-            id = self.collection.insert(json.loads(j))
+            oid = self.collection.insert(json.loads(j))
         except:
             print "MONGODB cannot insert"
             raise
-        return str(id)
+        return str(oid)
 
     def get(self, str_report_id=None):
         """ select a NmapReport by Id
@@ -44,26 +52,27 @@ def get(self, str_report_id=None):
 
         if isinstance(rid, ObjectId):
             #get a specific report by mongo's id
-            resultSet = self.collection.find({'_id': rid})
-            if resultSet.count() == 1:
+            resultset = self.collection.find({'_id': rid})
+            if resultset.count() == 1:
                 #search by id means only one in the iterator
-                record = resultSet[0]
+                record = resultset[0]
                 #remove mongo's id to recreate the NmapReport Obj
                 del record['_id']
                 nmapreport = NmapParser.parse_fromdict(record)
         return nmapreport
 
     def getall(self, dict_filter=None):
-        """return a list of all NmapReport saved in the backend
+        """return a list of tuple (id,NmapReport) saved in the backend
            TODO : add a filter capability
         """
-        nmapreportList = []
-        r = self.collection.find()
-        for report in r:
+        nmapreportlist = []
+        resultset = self.collection.find()
+        for report in resultset:
+            oid = report['_id']
             del report['_id']
             nmapreport = NmapParser.parse_fromdict(report)
-            nmapreportList.append(nmapreport)
-        return nmapreportList
+            nmapreportlist.append((oid, nmapreport))
+        return nmapreportlist
 
     def delete(self, report_id=None):
         """
