Difference between revisions of "TruxtonUrl"
(→fileid) |
(→Sample) |
||
| (13 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | This class lets you add to the [[WebsiteVisit Table | | + | This class lets you add to the <code><nowiki>[</nowiki>[[WebsiteVisit Table|WebsiteVisit]]<nowiki>]</nowiki></code> table in Truxton. |
=Attributes and Methods= | =Attributes and Methods= | ||
| − | ==<code>account</code>== | + | ==<code>account: str</code>== |
The optional account name associated with the URL. | The optional account name associated with the URL. | ||
Many browsers will record the operating system user that did the surfing. | Many browsers will record the operating system user that did the surfing. | ||
| − | ==<code>accountoffset</code>== | + | ==<code>accountoffset: int</code>== |
The offset into the parent file where the account was found. | The offset into the parent file where the account was found. | ||
| − | ==<code>fileid</code>== | + | ==<code>addnote(text: str) -> boolean</code>== |
| + | This adds an investigator's note. | ||
| + | The <code>text</code> parameter is the contents of the note. | ||
| + | It will return | ||
| + | [https://docs.python.org/3.10/library/constants.html?highlight=false#True True] if the tag was associated with the URL, [https://docs.python.org/3.10/library/constants.html?highlight=false#False False] on failure. | ||
| + | The note is stored in the <code>[InvestigatorNote]</code> table in the database. | ||
| + | |||
| + | ==<code>fileid: str</code>== | ||
The [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file this [https://en.wikipedia.org/wiki/URL URL] came from. | The [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file this [https://en.wikipedia.org/wiki/URL URL] came from. | ||
| − | This corresponds to the <code>FileID</code> column of the <code>WebsiteVisit</code> table. | + | This corresponds to the <code>[FileID]</code> column of the <code><nowiki>[</nowiki>[[WebsiteVisit Table|WebsiteVisit]]<nowiki>]</nowiki></code> table. |
| − | ==<code>format</code>== | + | ==<code>format: int</code>== |
The format of the raw URL. | The format of the raw URL. | ||
This can be <code>URL_FORMAT_ASCII</code> (1) or <code>URL_FORMAT_UNICODE</code> (2) | This can be <code>URL_FORMAT_ASCII</code> (1) or <code>URL_FORMAT_UNICODE</code> (2) | ||
| − | ==<code>id</code>== | + | ==<code>id: str</code>== |
| − | This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the | + | 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. | ||
| − | ==<code>localfilename</code>== | + | ==<code>localfilename: str</code>== |
The path to the file the browser uses to cache the contents of the page retrieved by the URL. | The path to the file the browser uses to cache the contents of the page retrieved by the URL. | ||
| − | ==<code>mediaid</code>== | + | ==<code>mediaid: str</code>== |
| − | This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the media this | + | This is the [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the media this visit came from. |
| − | This identifier corresponds to the <code>MediaID</code> of the <code>WebsiteVisit</code> table. | + | This identifier corresponds to the <code>[MediaID]</code> of the <code><nowiki>[</nowiki>[[WebsiteVisit Table|WebsiteVisit]]<nowiki>]</nowiki></code> table. |
| − | ==<code>method</code>== | + | ==<code>method: int</code>== |
The reason this URL was retrieved. | The reason this URL was retrieved. | ||
| − | It corresponds to the <code>WebsiteMethodID</code> column of the <code>WebsiteVisit</code> table. | + | It corresponds to the <code>[WebsiteMethodID]</code> column of the <code><nowiki>[</nowiki>[[WebsiteVisit Table|WebsiteVisit]]<nowiki>]</nowiki></code> table. |
| − | The value must match a value in the <code>ID</code> column in the <code>WebsiteMethod</code> table. | + | The value must match a value in the <code>[ID]</code> column in the <code>[WebsiteMethod]</code> table. |
You can also use one of the [[URL Methods | predefined constants.]] | You can also use one of the [[URL Methods | predefined constants.]] | ||
| − | ==<code>offset</code>== | + | ==<code>offset: int</code>== |
The offset in the file where this URL was found. | The offset in the file where this URL was found. | ||
It should be the offset of the first character in the URL. | It should be the offset of the first character in the URL. | ||
| − | ==<code>save()</code>== | + | ==<code>save() -> boolean</code>== |
| − | This will commit the information to the <code> | + | This will commit the information to the <code><nowiki>[</nowiki>[[WebsiteVisit Table|WebsiteVisit]]<nowiki>]</nowiki></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. | ||
| − | ==<code>tag(tag, reason, origin)</code>== | + | ==<code>tag(tag: str, reason: str, origin: int) -> boolean</code>== |
| − | This creates a tag associated with this | + | This creates a tag associated with this visit 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 | + | The <code>reason</code> is a sentence explaining why this visit 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 file, [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 file, [https://docs.python.org/3.8/library/constants.html?highlight=false#False False] on failure. | ||
| − | ==<code>type</code>== | + | ==<code>type: int</code>== |
The type of URL. | The type of URL. | ||
| − | It corresponds to the <code>URLTypeID</code> column of the <code>WebsiteVisit</code> table. | + | It corresponds to the <code>[URLTypeID]</code> column of the <code><nowiki>[</nowiki>[[WebsiteVisit Table|WebsiteVisit]]<nowiki>]</nowiki></code> table. |
| − | The value must match a value in the <code>ID</code> column in the <code>URLType</code> table. | + | The value must match a value in the <code>[ID]</code> column in the <code>[URLType]</code> table. |
You can also use one of the [[URL Types | predefined constants.]] | You can also use one of the [[URL Types | predefined constants.]] | ||
| − | ==<code>url</code>== | + | ==<code>url: str</code>== |
The URL string. | The URL string. | ||
| − | This corresponds to the <code>URL</code> column of the <code>URL</code> table. | + | This corresponds to the <code>[URL]</code> column of the <code>[URL]</code> table. |
| − | ==<code>when</code>== | + | ==<code>when: [https://docs.python.org/3/library/datetime.html datetime]</code>== |
| − | When the URL was seen | + | When the URL was seen. |
| − | This corresponds to the <code>When</code> column of the <code>WebsiteVisit</code> table. | + | This value can be set with either a datetime value or an integer representing [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks. |
| + | This corresponds to the <code>[When]</code> column of the <code><nowiki>[</nowiki>[[WebsiteVisit Table|WebsiteVisit]]<nowiki>]</nowiki></code> table. | ||
=Sample= | =Sample= | ||
| − | + | <source lang="Python" highlight="60-67"> | |
| − | < | + | import sys |
| + | sys.path.append('C:/Program Files/Truxton/SDK') | ||
import truxton | import truxton | ||
import shutil | import shutil | ||
| Line 72: | Line 82: | ||
from calendar import timegm | from calendar import timegm | ||
from pathlib import Path | from pathlib import Path | ||
| − | |||
| − | |||
| − | |||
EVENT_TYPE_FBI = 20001 | EVENT_TYPE_FBI = 20001 | ||
| − | |||
| − | |||
| − | |||
def create_event_type(t, id, name): | def create_event_type(t, id, name): | ||
| Line 86: | Line 90: | ||
event_type.name = name | event_type.name = name | ||
event_type.save() | event_type.save() | ||
| + | return None | ||
def add_file(parent_truxton_file, filename): | def add_file(parent_truxton_file, filename): | ||
| Line 98: | Line 103: | ||
def add_event(parent_file, start, end, title, description, type): | def add_event(parent_file, start, end, title, description, type): | ||
event = parent_file.newevent() | event = parent_file.newevent() | ||
| − | event.start = | + | event.start = datetime.fromisoformat(start) |
| − | event.end = | + | event.end = datetime.fromisoformat(end) |
event.title = title | event.title = title | ||
event.description = description | event.description = description | ||
| Line 134: | Line 139: | ||
url.method = truxton.URL_METHOD_TYPE_CLICKED_ON_A_LINK | url.method = truxton.URL_METHOD_TYPE_CLICKED_ON_A_LINK | ||
url.format = truxton.URL_FORMAT_ASCII | url.format = truxton.URL_FORMAT_ASCII | ||
| − | url.when = | + | url.when = datetime.fromisoformat("2020-05-20T00:00:00-05:00") |
url.save() | url.save() | ||
| Line 140: | Line 145: | ||
add_event( child_file, "2016-07-27T12:00:00-05:00", "2016-07-27T12:00:00-05:00", "Legat called needing to meet US ambassador", "In London", EVENT_TYPE_FBI ) | add_event( child_file, "2016-07-27T12:00:00-05:00", "2016-07-27T12:00:00-05:00", "Legat called needing to meet US ambassador", "In London", EVENT_TYPE_FBI ) | ||
add_event( child_file, "2016-07-29T12:00:00-05:00", "2016-07-29T12:00:00-05:00", "FBI Receives Downer Info from Legat", "Probably legat London", EVENT_TYPE_FBI ) | add_event( child_file, "2016-07-29T12:00:00-05:00", "2016-07-29T12:00:00-05:00", "FBI Receives Downer Info from Legat", "Probably legat London", EVENT_TYPE_FBI ) | ||
| + | |||
| + | return None | ||
def main(): | def main(): | ||
| Line 152: | Line 159: | ||
add_ec(root_file) | add_ec(root_file) | ||
| + | |||
| + | return None | ||
if __name__ == "__main__": | if __name__ == "__main__": | ||
| − | main() | + | sys.exit(main()) |
| − | </ | + | </source> |
Latest revision as of 15:14, 27 January 2024
This class lets you add to the [WebsiteVisit] table in Truxton.
Contents
- 1 Attributes and Methods
- 1.1 account: str
- 1.2 accountoffset: int
- 1.3 addnote(text: str) -> boolean
- 1.4 fileid: str
- 1.5 format: int
- 1.6 id: str
- 1.7 localfilename: str
- 1.8 mediaid: str
- 1.9 method: int
- 1.10 offset: int
- 1.11 save() -> boolean
- 1.12 tag(tag: str, reason: str, origin: int) -> boolean
- 1.13 type: int
- 1.14 url: str
- 1.15 when: datetime
- 2 Sample
Attributes and Methods
account: str
The optional account name associated with the URL. Many browsers will record the operating system user that did the surfing.
accountoffset: int
The offset into the parent file where the account was found.
addnote(text: str) -> boolean
This adds an investigator's note.
The text parameter is the contents of the note.
It will return
True if the tag was associated with the URL, False on failure.
The note is stored in the [InvestigatorNote] table in the database.
fileid: str
The GUID of the file this URL came from.
This corresponds to the [FileID] column of the [WebsiteVisit] table.
format: int
The format of the raw URL.
This can be URL_FORMAT_ASCII (1) or URL_FORMAT_UNICODE (2)
id: str
This is the GUID of the record.
It becomes non-zero after save() has been called.
localfilename: str
The path to the file the browser uses to cache the contents of the page retrieved by the URL.
mediaid: str
This is the GUID of the media this visit came from.
This identifier corresponds to the [MediaID] of the [WebsiteVisit] table.
method: int
The reason this URL was retrieved.
It corresponds to the [WebsiteMethodID] column of the [WebsiteVisit] table.
The value must match a value in the [ID] column in the [WebsiteMethod] table.
You can also use one of the predefined constants.
offset: int
The offset in the file where this URL was found. It should be the offset of the first character in the URL.
save() -> boolean
This will commit the information to the [WebsiteVisit] table.
It will return True if the record was saved to the database, False if there was an error.
tag(tag: str, reason: str, origin: int) -> boolean
This creates a tag associated with this visit in Truxton.
The tag parameter is a short, one or two word, bit of text that will be displayed in the UI.
The reason is a sentence explaining why this visit 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 file, False on failure.
type: int
The type of URL.
It corresponds to the [URLTypeID] column of the [WebsiteVisit] table.
The value must match a value in the [ID] column in the [URLType] table.
You can also use one of the predefined constants.
url: str
The URL string.
This corresponds to the [URL] column of the [URL] table.
when: datetime
When the URL was seen.
This value can be set with either a datetime value or an integer representing FILETIME ticks.
This corresponds to the [When] column of the [WebsiteVisit] table.
Sample
import sys
sys.path.append('C:/Program Files/Truxton/SDK')
import truxton
import shutil
from datetime import datetime
from calendar import timegm
from pathlib import Path
EVENT_TYPE_FBI = 20001
def create_event_type(t, id, name):
event_type = t.neweventtype()
event_type.id = id
event_type.name = name
event_type.save()
return None
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_event(parent_file, start, end, title, description, type):
event = parent_file.newevent()
event.start = datetime.fromisoformat(start)
event.end = datetime.fromisoformat(end)
event.title = title
event.description = description
event.type = type
event.save()
return event
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
if media.save():
print("Media saved")
else:
print("Media not saved")
return media
def add_ec(parent_file ):
child_file = add_file(parent_file, "JW-v-DOJ-reply-02743.pdf")
url = child_file.newurl()
url.url = "https://www.judicialwatch.org/documents/jw-v-doj-reply-02743/"
url.localfilename = "JW-v-DOJ-reply-02743.pdf"
url.type = truxton.URL_TYPE_FIREFOX
url.method = truxton.URL_METHOD_TYPE_CLICKED_ON_A_LINK
url.format = truxton.URL_FORMAT_ASCII
url.when = datetime.fromisoformat("2020-05-20T00:00:00-05:00")
url.save()
add_event( child_file, "2016-07-31T12:00:00-05:00", "2016-07-31T12:00:00-05:00", "Crossfire Hurricane Created", "At FBI HQ", EVENT_TYPE_FBI )
add_event( child_file, "2016-07-27T12:00:00-05:00", "2016-07-27T12:00:00-05:00", "Legat called needing to meet US ambassador", "In London", EVENT_TYPE_FBI )
add_event( child_file, "2016-07-29T12:00:00-05:00", "2016-07-29T12:00:00-05:00", "FBI Receives Downer Info from Legat", "Probably legat London", EVENT_TYPE_FBI )
return None
def main():
t = truxton.create()
create_event_type(t, EVENT_TYPE_FBI, "FBI Actions" )
media = add_media(t)
root_file = media.addroot()
root_file.save()
add_ec(root_file)
return None
if __name__ == "__main__":
sys.exit(main())