Difference between revisions of "TruxtonUSB"

From truxwiki.com
Jump to navigation Jump to search
(Created page with "This class lets you add to the USBDevice table in Truxton. =Attributes and Methods= ==altitude== ==<code>fileid</code>== The [https://en.wikipedia.org/...")
 
Line 5: Line 5:
  
 
==<code>fileid</code>==
 
==<code>fileid</code>==
The [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file this location came from.
+
The [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file this device came from.
This corresponds to the <code>FileID</code> column of the [[Location  Table | <code>Location</code>]] table.
+
This corresponds to the <code>FileID</code> column of the [[USBDevice Table | <code>USBDevice</code>]] table.
  
 
==<code>id</code>==
 
==<code>id</code>==
 
This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the record.
 
This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the record.
 
It becomes non-zero after <code>save()</code> has been called.
 
It becomes non-zero after <code>save()</code> has been called.
This corresponds to the <code>ID</code> column of the [[Location Table | <code>Location</code>]] table.
+
This corresponds to the <code>ID</code> column of the [[USBDevice Table | <code>USBDevice</code>]] table.
 
 
==<code>label</code>==
 
The short label for this location.
 
This corresponds to the <code>Label</code> column of the  [[Location Table | <code>Location</code>]] table.
 
 
 
==<code>latitude</code>==
 
The [https://en.wikipedia.org/wiki/Latitude latitude] portion of the geographic coordinate using the [https://en.wikipedia.org/wiki/World_Geodetic_System#WGS84 WGS84] ellipsoid.
 
 
 
==<code>longitude</code>==
 
The [https://en.wikipedia.org/wiki/Longitude longitude] portion of the geographic coordinate using the [https://en.wikipedia.org/wiki/World_Geodetic_System#WGS84 WGS84] ellipsoid.
 
Many thanks go to [https://en.wikipedia.org/wiki/John_Harrison John Harrison] for his work.
 
  
 
==<code>mediaid</code>==
 
==<code>mediaid</code>==
This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the media this location came from.
+
This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the media this device came from.
This corresponds to the <code>MediaID</code> column of the [[Location Table | <code>Location</code>]] table.
+
This corresponds to the <code>MediaID</code> column of the [[USBDevice Table | <code>USBDevice</code>]] table.
  
 
==<code>save()</code>==
 
==<code>save()</code>==
This will commit the information to the [[Entity Table | <code>Entity</code>]] table.
+
This will commit the information to the [[USBDevice Table | <code>USBDevice</code>]] table.
 
It will return [https://docs.python.org/3/library/constants.html#True True] if the record was saved to the database, [https://docs.python.org/3/library/constants.html#False False] if there was an error.
 
It will return [https://docs.python.org/3/library/constants.html#True True] if the record was saved to the database, [https://docs.python.org/3/library/constants.html#False False] if there was an error.
  
 
==<code>tag(tag, reason, origin)</code>==
 
==<code>tag(tag, reason, origin)</code>==
This creates a tag associated with this location in Truxton.
+
This creates a tag associated with this device in Truxton.
 
The <code>tag</code> parameter is a short, one or two word, bit of text that will be displayed in the UI.
 
The <code>tag</code> parameter is a short, one or two word, bit of text that will be displayed in the UI.
The <code>reason</code> a sentence explaining why this location was tagged.
+
The <code>reason</code> a sentence explaining why this device was tagged.
 
The <code>origin</code> is either <code>TAG_ORIGIN_AUTOMATIC</code> (1) or <code>TAG_ORIGIN_HUMAN</code> (2).
 
The <code>origin</code> is either <code>TAG_ORIGIN_AUTOMATIC</code> (1) or <code>TAG_ORIGIN_HUMAN</code> (2).
 
It will return  
 
It will return  
[https://docs.python.org/3.8/library/constants.html?highlight=false#True True] if the tag was associated with the location, [https://docs.python.org/3.8/library/constants.html?highlight=false#False False] on failure.
+
[https://docs.python.org/3.8/library/constants.html?highlight=false#True True] if the tag was associated with the device, [https://docs.python.org/3.8/library/constants.html?highlight=false#False False] on failure.
 
 
==<code>type</code>==
 
The type of the location.
 
This corresponds to the <code>LocationTypeID</code> column of the [[Location Table | <code>Location</code>]] table.
 
It must be a value listed in the <code>ID</code> column of the <code>LocationType</code> table.
 
You can also use a [[Location Types | predefined constant.]]
 
  
 
==<code>when</code>==
 
==<code>when</code>==
The time associated with this location in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks.
+
The time associated with this device in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks.
  
 
=Sample=
 
=Sample=

Revision as of 02:59, 29 May 2020

This class lets you add to the USBDevice table in Truxton.

Attributes and Methods

altitude

fileid

The GUID of the file this device came from. This corresponds to the FileID column of the USBDevice table.

id

This is the GUID of the record. It becomes non-zero after save() has been called. This corresponds to the ID column of the USBDevice table.

mediaid

This is the GUID of the media this device came from. This corresponds to the MediaID column of the USBDevice table.

save()

This will commit the information to the USBDevice table. It will return True if the record was saved to the database, False if there was an error.

tag(tag, reason, origin)

This creates a tag associated with this device in Truxton. The tag parameter is a short, one or two word, bit of text that will be displayed in the UI. The reason a sentence explaining why this device was tagged. The origin is either TAG_ORIGIN_AUTOMATIC (1) or TAG_ORIGIN_HUMAN (2). It will return True if the tag was associated with the device, False on failure.

when

The time associated with this device in FILETIME ticks.

Sample

import truxton
import shutil

from datetime import datetime
from calendar import timegm
from pathlib import Path

EPOCH_AS_FILETIME = 116444736000000000
HUNDREDS_OF_NANOSECONDS = 10000000

def date_to_filetime(dt):
  return EPOCH_AS_FILETIME + (timegm(dt.timetuple()) * HUNDREDS_OF_NANOSECONDS)

def add_file(parent_truxton_file, filename):
  source_file = open(filename, "rb")
  child = parent_truxton_file.newchild()
  child.name = Path(filename).name
  shutil.copyfileobj(source_file, child)
  source_file.close()
  child.save()
  return child

def add_media(t):
  media = t.newmedia()

  media.name = "Public Documents"
  media.description = "Publicly available documents"
  media.case = "DC-SNAFU-2016.2020"
  media.evidencebag = "EV-0937459386623-a"
  media.originator = "Jeffrey Jensen"
  media.latitude = 38.897661
  media.longitude = -77.036458
  media.type = truxton.MEDIA_TYPE_LOGICAL_FILES
  media.save()

  return media

def add_cs(parent_file ):
  child_file = add_file(parent_file, "cs.jpg")

  gps = child_file.newlocation()
  gps.type = truxton.LOCATION_TYPE_MEETING
  gps.latitude = 51.487329
  gps.longitude = -0.124057
  gps.label = "HQ"
  gps.when= date_to_filetime(datetime.fromisoformat("2016-04-01T12:00:00-05:00"))
  gps.save()

def main():
  t = truxton.create()

  media = add_media(t)

  root_file = media.addroot()
  root_file.save()

  add_cs(root_file)

if __name__ == "__main__":
  main()