Difference between revisions of "TruxtonLocation"

From truxwiki.com
Jump to navigation Jump to search
(Created page with "This class lets you add to the Location table in Truxton. =Attributes and Methods= ==altitude== ==<code>fileid</code>== The [https://en.wikipedia.org/wi...")
 
Line 42: Line 42:
  
 
==<code>tag(tag, reason, origin)</code>==
 
==<code>tag(tag, reason, origin)</code>==
This creates a tag associated with this artifact in Truxton.
+
This creates a tag associated with this location 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 artifact was tagged.
+
The <code>reason</code> a sentence explaining why this location 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 artifact, [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 location, [https://docs.python.org/3.8/library/constants.html?highlight=false#False False] on failure.
  
 
=Sample=
 
=Sample=

Revision as of 16:56, 28 May 2020

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

Attributes and Methods

altitude

fileid

The GUID of the file this location came from. This corresponds to the FileID column of the Location 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 Location table.

label

The short label for this location. This corresponds to the Label column of the Location table.

latitude

The latitude portion of the geographic coordinate using the WGS84 ellipsoid.

longitude

The longitude portion of the geographic coordinate using the WGS84 ellipsoid. Many thanks go to John Harrison for his work.

mediaid

This is the GUID of the media this location came from. This corresponds to the MediaID column of the Location table.

type

The type of the location. This corresponds to the LocationTypeID column of the Location table. It must be a value listed in the ID column of the LocationType table. You can also use a predefined constant.

when

The time associated with this location in FILETIME ticks.

save()

This will commit the information to the Entity 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 location 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 location 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 location, False on failure.

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 create_event_type(t, id, name):
  event_type = t.neweventtype()
  event_type.id = id
  event_type.name = name
  event_type.save()

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_ec(parent_file ):
  child_file = add_file(parent_file, "JW-v-DOJ-reply-02743.pdf")

  artifact = child_file.newartifact()
  artifact.type = truxton.ENTITY_TYPE_AUTHOR
  artifact.value = "Bob Smith"
  artifact.datatype = truxton.DATA_TYPE_ASCII
  artifact.length = 9
  artifact.save()

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

  media = add_media(t)

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

  add_ec(root_file)

if __name__ == "__main__":
  main()