Python modules moved to new convenient location

pythonExamples/reportmodule.py

@@ -0,0 +1,69 @@
+# Sample module in the public domain. Feel free to use this as a template
+# for your modules (and you can remove this header and take complete credit
+# and liability)
+#
+# Contact: Brian Carrier [carrier <at> sleuthkit [dot] org]
+#
+# This is free and unencumbered software released into the public domain.
+#
+# Anyone is free to copy, modify, publish, use, compile, sell, or
+# distribute this software, either in source code form or as a compiled
+# binary, for any purpose, commercial or non-commercial, and by any
+# means.
+#
+# In jurisdictions that recognize copyright laws, the author or authors
+# of this software dedicate any and all copyright interest in the
+# software to the public domain. We make this dedication for the benefit
+# of the public at large and to the detriment of our heirs and
+# successors. We intend this dedication to be an overt act of
+# relinquishment in perpetuity of all present and future rights to this
+# software under copyright law.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+from java.lang import System
+from org.sleuthkit.autopsy.casemodule import Case
+from org.sleuthkit.autopsy.report import GeneralReportModuleAdapter
+
+# Sample module that writes a file with the number of files
+# created in the last 2 weeks.
+class SampleGeneralReportModule(GeneralReportModuleAdapter):
+
+    def getName(self):
+        return "Sample Report Module"
+
+    def getDescription(self):
+        return "A sample Jython report module"
+
+    def getRelativeFilePath(self):
+        return "sampleReport.txt"
+
+    def generateReport(self, reportPath, progressBar):
+            # Configure progress bar for 2 tasks 
+            progressBar.setIndeterminate(False)
+            progressBar.start()
+            progressBar.setMaximumProgress(2)
+
+            # Get files by created in last two weeks.
+            fileCount = 0
+            autopsyCase = Case.getCurrentCase()
+            sleuthkitCase = autopsyCase.getSleuthkitCase()
+            currentTime = System.currentTimeMillis() / 1000
+            minTime = currentTime - (14 * 24 * 60 * 60)
+            otherFiles = sleuthkitCase.findFilesWhere("crtime > %d" % minTime)
+            for otherFile in otherFiles:
+                    fileCount += 1
+            progressBar.increment()
+            
+            # Write the result to the report file.
+            report = open(reportPath + '\\' + self.getRelativeFilePath(), 'w')
+            report.write("file count = %d" % fileCount)
+            report.close()
+            progressBar.increment()
+            progressBar.complete()