TruxtonFileIO - Revision history

Sam: /* Sample */

2024-09-11T20:56:32Z

Sample

Sam: /* Sample */

2024-09-11T18:01:46Z

Sample

Sam: /* Sample */

2024-02-24T12:51:04Z

Sample

Sam: /* Sample */

2024-01-27T19:05:59Z

Sample

Sam: /* depotid: str */

2024-01-27T19:05:06Z

depotid: str

Sam: /* depotoffset: int */

2024-01-27T19:04:49Z

depotoffset: int

Sam: /* depotlength: int */

2024-01-27T19:04:34Z

depotlength: int

Sam: /* depot: str */

2024-01-27T19:04:14Z

depot: str

Sam: /* Truxton Methods */

2022-10-01T11:19:59Z

Truxton Methods

Sam at 20:59, 16 September 2022

2022-09-16T20:59:59Z

@@ Line 195: / Line 195: @@
 import hashlib
-def main():
+def main() -> None:
    t = truxton.create()
    with t.getfileid("5ec2a123-74d6-5da7-0653-4e6800000000") as the_file:
@@ Line 201: / Line 201: @@
      readable_hash = hashlib.md5(byte_buffer).hexdigest()
      print(readable_hash + " is the calculated hash of the contents")
 if __name__ == "__main__":
    sys.exit(main())
 </source>

@@ Line 197: / Line 197: @@
 def main():
    t = truxton.create()
-   the_file = t.getfileid("5ec2a123-74d6-5da7-0653-4e6800000000")
+   with t.getfileid("5ec2a123-74d6-5da7-0653-4e6800000000") as the_file:
-  print(the_file.hash + " is the hash in the database for " + the_file.name )
+    byte_buffer = the_file.readall()
-  bytes = the_file.readall()
+    readable_hash = hashlib.md5(byte_buffer).hexdigest()
-  readable_hash = hashlib.md5(bytes).hexdigest()
+    print(readable_hash + " is the calculated hash of the contents")
 if __name__ == "__main__":
    sys.exit(main())
 </source>

@@ Line 197: / Line 197: @@
 def main():
    t = truxton.create()
-   file = t.getfileid("5ec2a123-74d6-5da7-0653-4e6800000000")
+   the_file = t.getfileid("5ec2a123-74d6-5da7-0653-4e6800000000")
-   print(file.hash + " is the hash in the database for " + file.name )
+   print(the_file.hash + " is the hash in the database for " + the_file.name )
-   bytes = file.readall()
+   bytes = the_file.readall()
    readable_hash = hashlib.md5(bytes).hexdigest()
    print(readable_hash + " is the calculated hash of the contents")

@@ Line 204: / Line 204: @@
 if __name__ == "__main__":
-   main()
+   sys.exit(main())
 </source>

@@ Line 120: / Line 120: @@
 ==<code>depotid: str</code>==
 The name of the depot holding the file's contents.
-This corresponds to the <code>[DepotID]</code> column of the <code>[Content]</code> table.
+This corresponds to the <code>[DepotID]</code> column of the <code><nowiki>[</nowiki>[[Content Table|Content]]<nowiki>]</nowiki></code> table.
 ==<code>depotlength: int</code>==

@@ Line 128: / Line 128: @@
 ==<code>depotoffset: int</code>==
 The number of bytes in the depot used for this file's contents.
-This corresponds tot he <code>[Offset]</code> column of the <code>[Content]</code> table.
+This corresponds tot he <code>[Offset]</code> column of the <code><nowiki>[</nowiki>[[Content Table|Content]]<nowiki>]</nowiki></code> table.
 ==<code>diskoffset: int</code>==

@@ Line 116: / Line 116: @@
 ==<code>depot: str</code>==
 The name of the depot holding the file's contents.
-This corresponds to the <code>[Filename]</code> column of the <code>[Depot]</code> table.
+This corresponds to the <code>[Filename]</code> column of the <code><nowiki>[</nowiki>[[Depot Table|Depot]]<nowiki>]</nowiki></code> table.
 ==<code>depotid: str</code>==

@@ Line 82: / Line 82: @@
 The following methods are also present to make tasks of adding items extracted from a file easier.
-* [[TruxtonFileIO_newartifact|newartifact()]] - Used to create a record in the <code><nowiki>[</nowiki>[[Entity Table|Entity]]<nowiki>]</nowiki></code> table and associated with this file.
+* [[TruxtonFileIO addnote|addnote()]] - Used to create a record in the <code>[InvestigatorNote]</code> table in the database associated with this file.
-* [[TruxtonFileIO_newchild|newchild()]] - Creates a writable file that will be a child of this file.
+* [[TruxtonFileIO changetype|changetype()]] - Used the change the type of the file.
-* [[TruxtonFileIO_newcommunication|newcommunication()]] - Creates a new [[TruxtonCommunication|communication]] object with this file as its source.
+* [[TruxtonFileIO newartifact|newartifact()]] - Used to create a record in the <code><nowiki>[</nowiki>[[Entity Table|Entity]]<nowiki>]</nowiki></code> table and associated with this file.
-* [[TruxtonFileIO_newevent | newevent()]] - Used to create a record in the <code><nowiki>[</nowiki>[[Event Table|Event]]<nowiki>]</nowiki></code> table and associated with this file.
+* [[TruxtonFileIO newchild|newchild()]] - Creates a writable file that will be a child of this file.
-* [[TruxtonFileIO_newexif | newexif()]] - Used to create a record in the <code><nowiki>[</nowiki>[[EXIF Table|EXIF]]<nowiki>]</nowiki></code> table and associated with this file.
+* [[TruxtonFileIO newcommunication|newcommunication()]] - Creates a new [[TruxtonCommunication|communication]] object with this file as its source.
-* [[TruxtonFileIO_newlocation | newlocation()]] - Used to create a record in the <code><nowiki>[</nowiki>[[Location Table|Location]]<nowiki>]</nowiki></code> table and associated with this file.
+* [[TruxtonFileIO newevent|newevent()]] - Used to create a record in the <code><nowiki>[</nowiki>[[Event Table|Event]]<nowiki>]</nowiki></code> table and associated with this file.
-* [[TruxtonFileIO_newrelation | newrelation()]] - Used to create a record in the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table and associated with this file.
+* [[TruxtonFileIO newexif|newexif()]] - Used to create a record in the <code><nowiki>[</nowiki>[[EXIF Table|EXIF]]<nowiki>]</nowiki></code> table and associated with this file.
-* [[TruxtonFileIO_newurl | newurl()]] - Used to create a record in the <code><nowiki>[</nowiki>[[WebsiteVisit Table|WebsiteVisit]]<nowiki>]</nowiki></code> table and associated with this file.
+* [[TruxtonFileIO newlocation|newlocation()]] - Used to create a record in the <code><nowiki>[</nowiki>[[Location Table|Location]]<nowiki>]</nowiki></code> table and associated with this file.
-* [[TruxtonFileIO_newusb | newusb()]] - Used to create a record in the <code><nowiki>[</nowiki>[[USBDevice Table|USBDevice]]<nowiki>]</nowiki></code> table and associated with this file.
+* [[TruxtonFileIO newrelation|newrelation()]] - Used to create a record in the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table and associated with this file.
-* [[TruxtonFileIO_tag | tag()]] - Used to associate a tag with this file.
+* [[TruxtonFileIO newurl|newurl()]] - Used to create a record in the <code><nowiki>[</nowiki>[[WebsiteVisit Table|WebsiteVisit]]<nowiki>]</nowiki></code> table and associated with this file.
-* [[TruxtonFileIO_changetype | changetype()]] - Used the change the type of the file.
+* [[TruxtonFileIO newusb|newusb()]] - Used to create a record in the <code><nowiki>[</nowiki>[[USBDevice Table|USBDevice]]<nowiki>]</nowiki></code> table and associated with this file.
 =Truxton Attributes=

@@ Line 133: / Line 133: @@
 This corresponds to the <code>[PhysicalDiskOffset]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table.
-==<code>eliminated: bool</code>==
+==<code>eliminated: boolean</code>==
 [https://docs.python.org/3/library/constants.html#True True] when the original contents of the file were eliminated based on the hash matching one from a list of hashes of files known to have no investigative value.
 The [https://www.nist.gov/itl/ssd/software-quality-group/national-software-reference-library-nsrl NSRL] is one such library.
@@ Line 170: / Line 170: @@
 This corresponds to the <code>[ParentFileID]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table.
-==<code>resident: bool</code>==
+==<code>resident: boolean</code>==
 [https://docs.python.org/3/library/constants.html#True True] if this file's contents exist contiguously within the contents of another file.