Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DRAFT]Sketch delete poc #3261

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions cli_client/python/timesketch_cli_client/commands/sketch.py
Original file line number Diff line number Diff line change
Expand Up @@ -158,3 +158,38 @@ def unarchive_sketch(ctx):
if sketch.is_archived():
sketch.unarchive()
click.echo("Sketch unarchived")


@sketch_group.command("delete", help="Delete a sketch")
@click.option(
"--execute",
required=False,
is_flag=True,
help="Only execute the deletion if this is set.",
)
@click.pass_context
def delete_sketch(ctx, execute):
"""Delete a sketch."""
sketch = ctx.obj.sketch

# Dryrun:
click.echo("Would delete the following things")
click.echo(
f"Sketch: {sketch.id} {sketch.name} {sketch.description} {sketch.status} Labels: {sketch.labels}" # pylint: disable=line-too-long
)

for timeline in sketch.list_timelines():
click.echo(
f" Timeline: {timeline.id} {timeline.name} {timeline.description} {timeline.status}" # pylint: disable=line-too-long
)

# for story in sketch.stories:
# click.echo(
# f" Story: {story.id} {story.title} {story.description} {story.status} {story.created_at} {story.updated_at}" # pylint: disable=line-too-long
# )

if execute:
click.echo("Will delete for real")

sketch.delete()
click.echo("Sketch deleted")
13 changes: 13 additions & 0 deletions timesketch/api/v1/resources/sketch.py
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,20 @@ def delete(self, sketch_id):
HTTP_STATUS_CODE_FORBIDDEN,
"Sketch with the label [{0:s}] cannot be deleted.".format(label),
)

sketch.set_status(status="deleted")
# TODO: actually delete the sketch

for timeline in sketch.active_timelines:
timeline.set_status(status="deleted")
searchindex = timeline.searchindex
db_session.delete(searchindex)
db_session.delete(timeline)
# remove the opensearch index
self.datastore.client.indices.delete(index=searchindex.index_name)

db_session.delete(sketch)
db_session.commit()
return HTTP_STATUS_CODE_OK

@login_required
Expand Down
105 changes: 89 additions & 16 deletions timesketch/models/sketch.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,23 +58,96 @@ class Sketch(AccessControlMixin, LabelMixin, StatusMixin, CommentMixin, BaseMode
name = Column(Unicode(255))
description = Column(UnicodeText())
user_id = Column(Integer, ForeignKey("user.id"))
timelines = relationship("Timeline", backref="sketch", lazy="select")
views = relationship("View", backref="sketch", lazy="select")
events = relationship("Event", backref="sketch", lazy="select")
stories = relationship("Story", backref="sketch", lazy="select")
aggregations = relationship("Aggregation", backref="sketch", lazy="select")
attributes = relationship("Attribute", backref="sketch", lazy="select")
graphs = relationship("Graph", backref="sketch", lazy="select")
graphcaches = relationship("GraphCache", backref="sketch", lazy="select")
timelines = relationship(
"Timeline",
backref="sketch",
lazy="select",
cascade="save-update, merge, delete",
)
views = relationship(
"View",
backref="sketch",
lazy="select",
cascade="save-update, merge, delete",
)
events = relationship(
"Event",
backref="sketch",
lazy="select",
cascade="save-update, merge, delete",
)
stories = relationship(
"Story",
backref="sketch",
lazy="select",
cascade="save-update, merge, delete",
)
aggregations = relationship(
"Aggregation",
backref="sketch",
lazy="select",
cascade="save-update, merge, delete",
)
attributes = relationship(
"Attribute",
backref="sketch",
lazy="select",
cascade="save-update, merge, delete",
)
graphs = relationship(
"Graph",
backref="sketch",
lazy="select",
cascade="save-update, merge, delete",
)
graphcaches = relationship(
"GraphCache",
backref="sketch",
lazy="select",
cascade="save-update, merge, delete",
)
aggregationgroups = relationship(
"AggregationGroup", backref="sketch", lazy="select"
)
analysis = relationship("Analysis", backref="sketch", lazy="select")
analysissessions = relationship("AnalysisSession", backref="sketch", lazy="select")
searchhistories = relationship("SearchHistory", backref="sketch", lazy="dynamic")
scenarios = relationship("Scenario", backref="sketch", lazy="dynamic")
facets = relationship("Facet", backref="sketch", lazy="dynamic")
questions = relationship("InvestigativeQuestion", backref="sketch", lazy="dynamic")
"AggregationGroup",
backref="sketch",
lazy="select",
cascade="save-update, merge, delete",
)
analysis = relationship(
"Analysis",
backref="sketch",
lazy="select",
cascade="save-update, merge, delete",
)
analysissessions = relationship(
"AnalysisSession",
backref="sketch",
lazy="select",
cascade="save-update, merge, delete",
)
searchhistories = relationship(
"SearchHistory",
backref="sketch",
lazy="dynamic",
cascade="save-update, merge, delete",
)
scenarios = relationship(
"Scenario",
backref="sketch",
lazy="dynamic",
cascade="save-update, merge, delete",
)
facets = relationship(
"Facet",
backref="sketch",
lazy="dynamic",
cascade="save-update, merge, delete",
)
questions = relationship(
"InvestigativeQuestion",
backref="sketch",
lazy="dynamic",
cascade="save-update, merge, delete",
)

@property
def get_named_aggregations(self):
Expand Down
25 changes: 25 additions & 0 deletions timesketch/tsctl.py
Original file line number Diff line number Diff line change
Expand Up @@ -545,6 +545,31 @@ def print_table(table_data):
print()


@cli.command(name="sketch-delete")
@click.argument("sketch_id")
def sketch_delete(sketch_id):
"""Delete a sketch."""
sketch = Sketch.query.filter_by(id=sketch_id).first()
if not sketch:
print("Sketch does not exist.")
return
elif sketch.get_status.status == "deleted":
print(f"Sketch {sketch_id} is already deleted.")
return
else:
sketch_labels = [label.label for label in sketch.labels]
# do not delete if Sketch has a lithold label
if "lithold" in sketch_labels:
print("Sketch has lithold label, skipping")
return

print(f"Sketch {sketch_id} Name: ({sketch.name})")
sketch.delete()
db_session.delete(sketch)
db_session.commit()
print(f"Sketch {sketch_id} deleted.")


@cli.command(name="sketch-info")
@click.argument("sketch_id")
def sketch_info(sketch_id):
Expand Down