From 73b2030d83a598b2114c749103b4ee115c5bd3dc Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Thu, 29 Apr 2021 10:15:27 -0400 Subject: [PATCH 001/326] 7553 data model event changes --- .../sleuthkit/autopsy/casemodule/Case.java | 114 +++------------- .../casemodule/events/HostsChangedEvent.java | 41 ------ .../autopsy/casemodule/events/HostsEvent.java | 28 +--- .../casemodule/events/HostsRemovedEvent.java | 39 ------ .../events/OsAccountAddedEvent.java | 35 ----- .../events/OsAccountChangedEvent.java | 34 ----- .../events/OsAccountDeletedEvent.java | 37 ------ .../casemodule/events/OsAccountEvent.java | 64 --------- .../casemodule/events/PersonsAddedEvent.java | 16 ++- .../events/PersonsChangedEvent.java | 41 ------ .../events/PersonsDeletedEvent.java | 27 ++-- .../casemodule/events/PersonsEvent.java | 34 +---- .../casemodule/events/ReportAddedEvent.java | 4 +- .../events/TskDataModelChangeEvent.java | 124 ------------------ .../sleuthkit/autopsy/datamodel/HostNode.java | 6 +- .../autopsy/datamodel/OsAccounts.java | 6 +- .../autopsy/datamodel/PersonGroupingNode.java | 6 +- 17 files changed, 66 insertions(+), 590 deletions(-) delete mode 100644 Core/src/org/sleuthkit/autopsy/casemodule/events/HostsChangedEvent.java delete mode 100644 Core/src/org/sleuthkit/autopsy/casemodule/events/HostsRemovedEvent.java delete mode 100755 Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountAddedEvent.java delete mode 100755 Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountChangedEvent.java delete mode 100644 Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountDeletedEvent.java delete mode 100755 Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountEvent.java delete mode 100644 Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsChangedEvent.java delete mode 100755 Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangeEvent.java diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/Case.java b/Core/src/org/sleuthkit/autopsy/casemodule/Case.java index ddf8cc22b9..f77859d407 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/Case.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/Case.java @@ -84,13 +84,13 @@ import org.sleuthkit.autopsy.casemodule.events.DataSourceAddedEvent; import org.sleuthkit.autopsy.casemodule.events.DataSourceDeletedEvent; import org.sleuthkit.autopsy.casemodule.events.DataSourceNameChangedEvent; import org.sleuthkit.autopsy.casemodule.events.HostsAddedEvent; -import org.sleuthkit.autopsy.casemodule.events.HostsChangedEvent; -import org.sleuthkit.autopsy.casemodule.events.HostsRemovedEvent; -import org.sleuthkit.autopsy.casemodule.events.OsAccountAddedEvent; -import org.sleuthkit.autopsy.casemodule.events.OsAccountChangedEvent; -import org.sleuthkit.autopsy.casemodule.events.OsAccountDeletedEvent; +import org.sleuthkit.autopsy.casemodule.events.HostsUpdatedEvent; +import org.sleuthkit.autopsy.casemodule.events.HostsDeletedEvent; +import org.sleuthkit.autopsy.casemodule.events.OsAccountsAddedEvent; +import org.sleuthkit.autopsy.casemodule.events.OsAccountsUpdatedEvent; +import org.sleuthkit.autopsy.casemodule.events.OsAccountsDeletedEvent; import org.sleuthkit.autopsy.casemodule.events.PersonsAddedEvent; -import org.sleuthkit.autopsy.casemodule.events.PersonsChangedEvent; +import org.sleuthkit.autopsy.casemodule.events.PersonsUpdatedEvent; import org.sleuthkit.autopsy.casemodule.events.PersonsDeletedEvent; import org.sleuthkit.autopsy.casemodule.events.ReportAddedEvent; import org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.CaseNodeDataException; @@ -500,24 +500,18 @@ public class Case { } @Subscribe - public void publishOsAccountAddedEvent(TskEvent.OsAccountsAddedTskEvent event) { - for (OsAccount account : event.getOsAcounts()) { - eventPublisher.publish(new OsAccountAddedEvent(account)); - } + public void publishOsAccountsAddedEvent(TskEvent.OsAccountsAddedTskEvent event) { + eventPublisher.publish(new OsAccountsAddedEvent(event.getOsAcounts())); } @Subscribe - public void publishOsAccountChangedEvent(TskEvent.OsAccountsChangedTskEvent event) { - for (OsAccount account : event.getOsAcounts()) { - eventPublisher.publish(new OsAccountChangedEvent(account)); - } + public void publishOsAccountsUpdatedEvent(TskEvent.OsAccountsUpdatedTskEvent event) { + eventPublisher.publish(new OsAccountsUpdatedEvent(event.getOsAcounts())); } @Subscribe - public void publishOsAccountDeletedEvent(TskEvent.OsAccountsDeletedTskEvent event) { - for (Long accountId : event.getOsAcountObjectIds()) { - eventPublisher.publish(new OsAccountDeletedEvent(accountId)); - } + public void publishOsAccountsDeletedEvent(TskEvent.OsAccountsDeletedTskEvent event) { + eventPublisher.publish(new OsAccountsDeletedEvent(event.getObjectIds())); } /** @@ -528,8 +522,7 @@ public class Case { */ @Subscribe public void publishHostsAddedEvent(TskEvent.HostsAddedTskEvent event) { - eventPublisher.publish(new HostsAddedEvent( - event == null ? Collections.emptyList() : event.getHosts())); + eventPublisher.publish(new HostsAddedEvent(event.getHosts())); } /** @@ -539,9 +532,8 @@ public class Case { * @param event The sleuthkit event for the updating of hosts. */ @Subscribe - public void publishHostsChangedEvent(TskEvent.HostsChangedTskEvent event) { - eventPublisher.publish(new HostsChangedEvent( - event == null ? Collections.emptyList() : event.getHosts())); + public void publishHostsUpdatedEvent(TskEvent.HostsUpdatedTskEvent event) { + eventPublisher.publish(new HostsUpdatedEvent(event.getHosts())); } /** @@ -552,8 +544,7 @@ public class Case { */ @Subscribe public void publishHostsDeletedEvent(TskEvent.HostsDeletedTskEvent event) { - eventPublisher.publish(new HostsRemovedEvent( - event == null ? Collections.emptyList() : event.getHosts())); + eventPublisher.publish(new HostsDeletedEvent(event.getObjectIds())); } /** @@ -575,8 +566,8 @@ public class Case { * @param event The sleuthkit event for the updating of persons. */ @Subscribe - public void publishPersonsChangedEvent(TskEvent.PersonsChangedTskEvent event) { - eventPublisher.publish(new PersonsChangedEvent( + public void publishPersonsUpdatedEvent(TskEvent.PersonsUpdatedTskEvent event) { + eventPublisher.publish(new PersonsUpdatedEvent( event == null ? Collections.emptyList() : event.getPersons())); } @@ -588,8 +579,7 @@ public class Case { */ @Subscribe public void publishPersonsDeletedEvent(TskEvent.PersonsDeletedTskEvent event) { - eventPublisher.publish(new PersonsDeletedEvent( - event == null ? Collections.emptyList() : event.getPersons())); + eventPublisher.publish(new PersonsDeletedEvent(event.getObjectIds())); } } @@ -1826,72 +1816,6 @@ public class Case { eventPublisher.publish(new BlackBoardArtifactTagDeletedEvent(deletedTag)); } - public void notifyOsAccountAdded(OsAccount account) { - eventPublisher.publish(new OsAccountAddedEvent(account)); - } - - public void notifyOsAccountChanged(OsAccount account) { - eventPublisher.publish(new OsAccountChangedEvent(account)); - } - - public void notifyOsAccountRemoved(Long osAccountObjectId) { - eventPublisher.publish(new OsAccountDeletedEvent(osAccountObjectId)); - } - - /** - * Notify via an autopsy event that a host has been added. - * - * @param host The host that has been added. - */ - public void notifyHostAdded(Host host) { - eventPublisher.publish(new HostsAddedEvent(Collections.singletonList(host))); - } - - /** - * Notify via an autopsy event that a host has been changed. - * - * @param newValue The host that has been updated. - */ - public void notifyHostChanged(Host newValue) { - eventPublisher.publish(new HostsChangedEvent(Collections.singletonList(newValue))); - } - - /** - * Notify via an autopsy event that a host has been deleted. - * - * @param host The host that has been deleted. - */ - public void notifyHostDeleted(Host host) { - eventPublisher.publish(new HostsRemovedEvent(Collections.singletonList(host))); - } - - /** - * Notify via an autopsy event that a person has been added. - * - * @param person The person that has been added. - */ - public void notifyPersonAdded(Person person) { - eventPublisher.publish(new PersonsAddedEvent(Collections.singletonList(person))); - } - - /** - * Notify via an autopsy event that a person has been changed. - * - * @param newValue The person that has been updated. - */ - public void notifyPersonChanged(Person newValue) { - eventPublisher.publish(new PersonsChangedEvent(Collections.singletonList(newValue))); - } - - /** - * Notify via an autopsy event that a person has been deleted. - * - * @param person The person that has been deleted. - */ - public void notifyPersonDeleted(Person person) { - eventPublisher.publish(new PersonsDeletedEvent(Collections.singletonList(person))); - } - /** * Adds a report to the case. * diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsChangedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsChangedEvent.java deleted file mode 100644 index a5b8692c03..0000000000 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsChangedEvent.java +++ /dev/null @@ -1,41 +0,0 @@ -/* - * Autopsy Forensic Browser - * - * Copyright 2021 Basis Technology Corp. - * Contact: carrier sleuthkit org - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.sleuthkit.autopsy.casemodule.events; - -import java.util.List; -import org.sleuthkit.autopsy.casemodule.Case; -import org.sleuthkit.datamodel.Host; - -/** - * Event fired when hosts are changed. - */ -public class HostsChangedEvent extends HostsEvent { - - private static final long serialVersionUID = 1L; - - /** - * Main constructor. - * - * @param dataModelObjects The new values for the hosts that have been - * changed. - */ - public HostsChangedEvent(List dataModelObjects) { - super(Case.Events.HOSTS_CHANGED.name(), dataModelObjects); - } -} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsEvent.java index 7c9a31f01e..69f68c0b4e 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsEvent.java @@ -19,10 +19,8 @@ package org.sleuthkit.autopsy.casemodule.events; import java.util.ArrayList; -import java.util.Collections; import java.util.List; import java.util.Optional; -import java.util.stream.Collectors; import org.sleuthkit.datamodel.Host; import org.sleuthkit.datamodel.HostManager; import org.sleuthkit.datamodel.SleuthkitCase; @@ -31,32 +29,10 @@ import org.sleuthkit.datamodel.TskCoreException; /** * Base event class for when something pertaining to hosts changes. */ -public class HostsEvent extends TskDataModelChangeEvent { +public class HostsEvent extends TskDataModelChangedEvent { private static final long serialVersionUID = 1L; - /** - * Retrieves a list of ids from a list of hosts. - * - * @param hosts The hosts. - * @return The list of ids. - */ - private static List getIds(List hosts) { - return getSafeList(hosts).stream() - .filter(h -> h != null) - .map(h -> h.getHostId()).collect(Collectors.toList()); - } - - /** - * Returns the hosts or an empty list. - * - * @param hosts The host list. - * @return The host list or an empty list if the parameter is null. - */ - private static List getSafeList(List hosts) { - return hosts == null ? Collections.emptyList() : hosts; - } - /** * Main constructor. * @@ -65,7 +41,7 @@ public class HostsEvent extends TskDataModelChangeEvent { * @param dataModelObjects The list of hosts for the event. */ protected HostsEvent(String eventName, List dataModelObjects) { - super(eventName, getIds(dataModelObjects), new ArrayList<>(getSafeList(dataModelObjects))); + super(eventName, dataModelObjects, Host::getHostId); } @Override diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsRemovedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsRemovedEvent.java deleted file mode 100644 index 407b83c32a..0000000000 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsRemovedEvent.java +++ /dev/null @@ -1,39 +0,0 @@ -/* - * Autopsy Forensic Browser - * - * Copyright 2021 Basis Technology Corp. - * Contact: carrier sleuthkit org - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.sleuthkit.autopsy.casemodule.events; - -import java.util.List; -import org.sleuthkit.autopsy.casemodule.Case; -import org.sleuthkit.datamodel.Host; - -/** - * Event fired when hosts are removed. - */ -public class HostsRemovedEvent extends HostsEvent { - - private static final long serialVersionUID = 1L; - - /** - * Main constructor. - * @param dataModelObjects The list of hosts that have been deleted. - */ - public HostsRemovedEvent(List dataModelObjects) { - super(Case.Events.HOSTS_DELETED.name(), dataModelObjects); - } -} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountAddedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountAddedEvent.java deleted file mode 100755 index c9f89903f4..0000000000 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountAddedEvent.java +++ /dev/null @@ -1,35 +0,0 @@ -/* - * Autopsy Forensic Browser - * - * Copyright 2021 Basis Technology Corp. - * Contact: carrier sleuthkit org - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.sleuthkit.autopsy.casemodule.events; - -import org.sleuthkit.autopsy.casemodule.Case; -import org.sleuthkit.datamodel.OsAccount; - -/** - * Event published when an OsAccount is added to a case. - */ -public final class OsAccountAddedEvent extends OsAccountEvent { - - private static final long serialVersionUID = 1L; - - public OsAccountAddedEvent(OsAccount account) { - super(Case.Events.OS_ACCOUNT_ADDED.toString(), account); - } - -} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountChangedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountChangedEvent.java deleted file mode 100755 index 237373a8b9..0000000000 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountChangedEvent.java +++ /dev/null @@ -1,34 +0,0 @@ -/* - * Autopsy Forensic Browser - * - * Copyright 2021 Basis Technology Corp. - * Contact: carrier sleuthkit org - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.sleuthkit.autopsy.casemodule.events; - -import org.sleuthkit.autopsy.casemodule.Case; -import org.sleuthkit.datamodel.OsAccount; - -/** - * Event published when an OsAccount is updated. - */ -public final class OsAccountChangedEvent extends OsAccountEvent { - - private static final long serialVersionUID = 1L; - - public OsAccountChangedEvent(OsAccount account) { - super(Case.Events.OS_ACCOUNT_CHANGED.toString(), account); - } -} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountDeletedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountDeletedEvent.java deleted file mode 100644 index adc726fca8..0000000000 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountDeletedEvent.java +++ /dev/null @@ -1,37 +0,0 @@ -/* - * Autopsy Forensic Browser - * - * Copyright 2021 Basis Technology Corp. - * Contact: carrier sleuthkit org - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.sleuthkit.autopsy.casemodule.events; - -import org.sleuthkit.autopsy.casemodule.Case; -import org.sleuthkit.autopsy.events.AutopsyEvent; - -/** - * Event published when an OsAccount is deleted. - * - * oldValue will contain the objectId of the account that was removed. newValue - * will be null. - */ -public final class OsAccountDeletedEvent extends AutopsyEvent { - - private static final long serialVersionUID = 1L; - - public OsAccountDeletedEvent(Long osAccountObjectId) { - super(Case.Events.OS_ACCOUNT_REMOVED.toString(), osAccountObjectId, null); - } -} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountEvent.java deleted file mode 100755 index d34da7822d..0000000000 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountEvent.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * Autopsy Forensic Browser - * - * Copyright 2021 Basis Technology Corp. - * Contact: carrier sleuthkit org - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.sleuthkit.autopsy.casemodule.events; - -import java.util.ArrayList; -import java.util.List; -import java.util.stream.Collectors; -import java.util.stream.Stream; -import org.sleuthkit.datamodel.OsAccount; -import org.sleuthkit.datamodel.SleuthkitCase; -import org.sleuthkit.datamodel.TskCoreException; - -/** - * Parent class for specific OsAccount event classes. - */ -class OsAccountEvent extends TskDataModelChangeEvent { - - private static final long serialVersionUID = 1L; - - /** - * Construct a new OsAccountEvent. - * - * @param eventName The name of the event. - * @param account The OsAccount the event applies to. - */ - OsAccountEvent(String eventName, OsAccount account) { - super(eventName, Stream.of(account.getId()).collect(Collectors.toList()), Stream.of(account).collect(Collectors.toList())); - } - - /** - * Returns the OsAccount that changed. - * - * @return The OsAccount that was changed. - */ - public OsAccount getOsAccount() { - List accounts = getNewValue(); - return accounts.get(0); - } - - @Override - protected List getDataModelObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { - Long id = ids.get(0); - OsAccount account = caseDb.getOsAccountManager().getOsAccountByObjectId(id); - List accounts = new ArrayList<>(); - accounts.add(account); - return accounts; - } -} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsAddedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsAddedEvent.java index e2a8a7aabd..c61bc177f3 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsAddedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsAddedEvent.java @@ -23,17 +23,19 @@ import org.sleuthkit.autopsy.casemodule.Case; import org.sleuthkit.datamodel.Person; /** - * Event fired when new persons are added. + * Event fired when new persons are added to a case. */ public class PersonsAddedEvent extends PersonsEvent { - + private static final long serialVersionUID = 1L; - + /** - * Main constructor. - * @param dataModelObjects The persons that have been added. + * Constructs an event fired when new persons are added to a case. + * + * @param persons The persons that have been added. */ - public PersonsAddedEvent(List dataModelObjects) { - super(Case.Events.PERSONS_ADDED.name(), dataModelObjects); + public PersonsAddedEvent(List persons) { + super(Case.Events.PERSONS_ADDED.name(), persons); } + } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsChangedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsChangedEvent.java deleted file mode 100644 index f375a125bb..0000000000 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsChangedEvent.java +++ /dev/null @@ -1,41 +0,0 @@ -/* - * Autopsy Forensic Browser - * - * Copyright 2021 Basis Technology Corp. - * Contact: carrier sleuthkit org - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.sleuthkit.autopsy.casemodule.events; - -import java.util.List; -import org.sleuthkit.autopsy.casemodule.Case; -import org.sleuthkit.datamodel.Person; - -/** - * Event fired when persons are changed. - */ -public class PersonsChangedEvent extends PersonsEvent { - - private static final long serialVersionUID = 1L; - - /** - * Main constructor. - * - * @param dataModelObjects The new values for the persons that have been - * changed. - */ - public PersonsChangedEvent(List dataModelObjects) { - super(Case.Events.PERSONS_CHANGED.name(), dataModelObjects); - } -} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsDeletedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsDeletedEvent.java index a63fef32cb..db80759214 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsDeletedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsDeletedEvent.java @@ -18,22 +18,33 @@ */ package org.sleuthkit.autopsy.casemodule.events; +import java.util.Collections; import java.util.List; import org.sleuthkit.autopsy.casemodule.Case; import org.sleuthkit.datamodel.Person; +import org.sleuthkit.datamodel.SleuthkitCase; +import org.sleuthkit.datamodel.TskCoreException; /** - * Event fired when persons are removed. + * An event fired when persons are deleted from the case. */ -public class PersonsDeletedEvent extends PersonsEvent { - +public class PersonsDeletedEvent extends TskDataModelChangedEvent { + private static final long serialVersionUID = 1L; - + /** - * Main constructor. - * @param dataModelObjects The list of persons that have been deleted. + * Constructs an event fired when persons are deleted from the case. + * + * @param dataModelObjectIds The unique numeric IDs (case database row IDs) + * of the persons that have been deleted. */ - public PersonsDeletedEvent(List dataModelObjects) { - super(Case.Events.PERSONS_DELETED.name(), dataModelObjects); + public PersonsDeletedEvent(List dataModelObjectIds) { + super(Case.Events.PERSONS_DELETED.name(), dataModelObjectIds); } + + @Override + protected List getDataModelObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { + return Collections.emptyList(); + } + } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsEvent.java index e3f584d58a..5380ee4874 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsEvent.java @@ -19,10 +19,8 @@ package org.sleuthkit.autopsy.casemodule.events; import java.util.ArrayList; -import java.util.Collections; import java.util.List; import java.util.Optional; -import java.util.stream.Collectors; import org.sleuthkit.datamodel.Person; import org.sleuthkit.datamodel.PersonManager; import org.sleuthkit.datamodel.SleuthkitCase; @@ -31,30 +29,10 @@ import org.sleuthkit.datamodel.TskCoreException; /** * Base event class for when something pertaining to persons changes. */ -public class PersonsEvent extends TskDataModelChangeEvent { - - /** - * Retrieves a list of ids from a list of persons. - * - * @param persons The persons. - * @return The list of ids. - */ - private static List getIds(List persons) { - return getSafeList(persons).stream() - .filter(h -> h != null) - .map(h -> h.getPersonId()).collect(Collectors.toList()); - } - - /** - * Returns the persons or an empty list. - * - * @param persons The person list. - * @return The person list or an empty list if the parameter is null. - */ - private static List getSafeList(List persons) { - return persons == null ? Collections.emptyList() : persons; - } +public class PersonsEvent extends TskDataModelChangedEvent { + private static final long serialVersionUID = 1L; + /** * Main constructor. * @@ -62,10 +40,10 @@ public class PersonsEvent extends TskDataModelChangeEvent { * type. * @param dataModelObjects The list of persons for the event. */ - protected PersonsEvent(String eventName, List dataModelObjects) { - super(eventName, getIds(dataModelObjects), new ArrayList<>(getSafeList(dataModelObjects))); + PersonsEvent(String eventName, List dataModelObjects) { + super(eventName, dataModelObjects, Person::getPersonId); } - + @Override protected List getDataModelObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { PersonManager personManager = caseDb.getPersonManager(); diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/ReportAddedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/ReportAddedEvent.java index bb4145c804..47c5a30d5d 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/ReportAddedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/ReportAddedEvent.java @@ -30,7 +30,7 @@ import org.sleuthkit.datamodel.TskCoreException; /** * Event published when a report is added to a case. */ -public final class ReportAddedEvent extends TskDataModelChangeEvent { +public final class ReportAddedEvent extends TskDataModelChangedEvent { private static final long serialVersionUID = 1L; @@ -40,7 +40,7 @@ public final class ReportAddedEvent extends TskDataModelChangeEvent { * @param report The data source that was added. */ public ReportAddedEvent(Report report) { - super(Case.Events.REPORT_ADDED.toString(), Stream.of(report.getId()).collect(Collectors.toList()), Stream.of(report).collect(Collectors.toList())); + super(Case.Events.REPORT_ADDED.toString(), Stream.of(report).collect(Collectors.toList()), Report::getId); } public Report getReport() { diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangeEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangeEvent.java deleted file mode 100755 index 1bd9fd81ac..0000000000 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangeEvent.java +++ /dev/null @@ -1,124 +0,0 @@ -/* - * Autopsy Forensic Browser - * - * Copyright 2021 Basis Technology Corp. - * Contact: carrier sleuthkit org - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.sleuthkit.autopsy.casemodule.events; - -import java.util.Collections; -import java.util.List; -import java.util.logging.Level; -import org.sleuthkit.autopsy.casemodule.Case; -import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException; -import org.sleuthkit.autopsy.coreutils.Logger; -import org.sleuthkit.autopsy.events.AutopsyEvent; -import org.sleuthkit.datamodel.SleuthkitCase; -import org.sleuthkit.datamodel.TskCoreException; - -/** - * An application event generic used as a superclass for events published when - * something changes in the Sleuth Kit Data Model for a case. - * - * @param A Sleuth Kit Data Model object type. - */ -public abstract class TskDataModelChangeEvent extends AutopsyEvent { - - private static final long serialVersionUID = 1L; - private static final Logger logger = Logger.getLogger(TskDataModelChangeEvent.class.getName()); - private final List dataModelObjectIds; - private transient List dataModelObjects; - - /** - * Constructs an application event generic used as a superclass for events - * published when something changes in the Sleuth Kit Data Model for a case. - * - * @param eventName The event name. - * @param dataModelObjectIds The unique numeric IDs (TSK object IDs, case - * database row IDs, etc.) of the Sleuth Kit Data - * Model objects associated with this application - * event. - * @param dataModelObjects The Sleuth Kit Data Model objects associated - * with this application event - */ - protected TskDataModelChangeEvent(String eventName, List dataModelObjectIds, List dataModelObjects) { - super(eventName, null, null); - this.dataModelObjectIds = dataModelObjectIds; - this.dataModelObjects = dataModelObjects; - if (eventName == null) { - throw new IllegalArgumentException("eventName is null"); - } - if (dataModelObjectIds == null) { - throw new IllegalArgumentException("dataModelObjectIds is null"); - } - if (dataModelObjects == null) { - throw new IllegalArgumentException("dataModelObjects is null"); - } - } - - /** - * Gets the unique numeric IDs (TSK object IDs, case database row IDs, etc.) - * of the Sleuth Kit Data Model objects associated with this application - * event. - * - * @return The unique IDs. - */ - public final List getDataModelObjectIds() { - return Collections.unmodifiableList(dataModelObjectIds); - } - - /** - * Gets the Sleuth Kit Data Model objects associated with this application - * event. - * - * @return The objects. - */ - @Override - public List getNewValue() { - /* - * If this event came from another host collaborating on a multi-user - * case, the transient list of Sleuth Kit Data Model objects will be - * null and will need to be reconstructed on the current host. - */ - if (dataModelObjects == null) { - try { - Case currentCase = Case.getCurrentCaseThrows(); - SleuthkitCase caseDb = currentCase.getSleuthkitCase(); - dataModelObjects = getDataModelObjects(caseDb, dataModelObjectIds); - } catch (NoCurrentCaseException | TskCoreException ex) { - logger.log(Level.SEVERE, String.format("Error geting TSK Data Model objects for %s event (%s)", getPropertyName(), getSourceType()), ex); - return Collections.emptyList(); - } - } - return Collections.unmodifiableList(dataModelObjects); - } - - /** - * Gets the Sleuth Kit Data Model objects associated with this application - * event. - * - * @param caseDb The case database. - * @param ids The unique, numeric IDs (TSK object IDs, case database row - * IDs, etc.) of the Sleuth Kit Data Model objects. - * - * @return The objects. - * - * @throws org.sleuthkit.datamodel.TskCoreException If there is an error - * getting the Sleuth Kit - * Data Model objects. - */ - abstract protected List getDataModelObjects(SleuthkitCase caseDb, List ids) throws TskCoreException; - -} diff --git a/Core/src/org/sleuthkit/autopsy/datamodel/HostNode.java b/Core/src/org/sleuthkit/autopsy/datamodel/HostNode.java index a98bdb61dd..57253ef60e 100644 --- a/Core/src/org/sleuthkit/autopsy/datamodel/HostNode.java +++ b/Core/src/org/sleuthkit/autopsy/datamodel/HostNode.java @@ -38,7 +38,7 @@ import org.openide.util.WeakListeners; import org.openide.util.lookup.Lookups; import org.sleuthkit.autopsy.casemodule.Case; import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException; -import org.sleuthkit.autopsy.casemodule.events.HostsChangedEvent; +import org.sleuthkit.autopsy.casemodule.events.HostsUpdatedEvent; import org.sleuthkit.autopsy.coreutils.Logger; import org.sleuthkit.autopsy.datamodel.hosts.AssociatePersonsMenuAction; import org.sleuthkit.autopsy.datamodel.hosts.MergeHostMenuAction; @@ -177,8 +177,8 @@ public class HostNode extends DisplayableItemNode { @Override public void propertyChange(PropertyChangeEvent evt) { String eventType = evt.getPropertyName(); - if (hostId != null && eventType.equals(Case.Events.HOSTS_CHANGED.toString()) && evt instanceof HostsChangedEvent) { - ((HostsChangedEvent) evt).getNewValue().stream() + if (hostId != null && eventType.equals(Case.Events.HOSTS_CHANGED.toString()) && evt instanceof HostsUpdatedEvent) { + ((HostsUpdatedEvent) evt).getNewValue().stream() .filter(h -> h != null && h.getHostId() == hostId) .findFirst() .ifPresent((newHost) -> { diff --git a/Core/src/org/sleuthkit/autopsy/datamodel/OsAccounts.java b/Core/src/org/sleuthkit/autopsy/datamodel/OsAccounts.java index 170251bd13..42a69caa99 100755 --- a/Core/src/org/sleuthkit/autopsy/datamodel/OsAccounts.java +++ b/Core/src/org/sleuthkit/autopsy/datamodel/OsAccounts.java @@ -39,7 +39,7 @@ import org.openide.util.Exceptions; import org.openide.util.NbBundle.Messages; import org.openide.util.WeakListeners; import org.sleuthkit.autopsy.casemodule.Case; -import org.sleuthkit.autopsy.casemodule.events.OsAccountChangedEvent; +import org.sleuthkit.autopsy.casemodule.events.OsAccountsUpdatedEvent; import org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance; import org.sleuthkit.autopsy.corecomponents.DataResultViewerTable; import org.sleuthkit.autopsy.coreutils.Logger; @@ -184,9 +184,9 @@ public final class OsAccounts implements AutopsyVisitableItem { @Override public void propertyChange(PropertyChangeEvent evt) { if (evt.getPropertyName().equals(Case.Events.OS_ACCOUNT_CHANGED.name())) { - if (((OsAccountChangedEvent) evt).getOsAccount().getId() == account.getId()) { + if (((OsAccountsUpdatedEvent) evt).getOsAccount().getId() == account.getId()) { // Update the account node to the new one - account = ((OsAccountChangedEvent) evt).getOsAccount(); + account = ((OsAccountsUpdatedEvent) evt).getOsAccount(); updateSheet(); } } else if (evt.getPropertyName().equals(REALM_DATA_AVAILABLE_EVENT)) { diff --git a/Core/src/org/sleuthkit/autopsy/datamodel/PersonGroupingNode.java b/Core/src/org/sleuthkit/autopsy/datamodel/PersonGroupingNode.java index 4f12779ee8..3934ffa06c 100644 --- a/Core/src/org/sleuthkit/autopsy/datamodel/PersonGroupingNode.java +++ b/Core/src/org/sleuthkit/autopsy/datamodel/PersonGroupingNode.java @@ -36,7 +36,7 @@ import org.openide.util.WeakListeners; import org.openide.util.lookup.Lookups; import org.sleuthkit.autopsy.casemodule.Case; import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException; -import org.sleuthkit.autopsy.casemodule.events.PersonsChangedEvent; +import org.sleuthkit.autopsy.casemodule.events.PersonsUpdatedEvent; import org.sleuthkit.autopsy.coreutils.Logger; import org.sleuthkit.autopsy.datamodel.persons.DeletePersonAction; import org.sleuthkit.autopsy.datamodel.persons.EditPersonAction; @@ -145,8 +145,8 @@ public class PersonGroupingNode extends DisplayableItemNode { @Override public void propertyChange(PropertyChangeEvent evt) { String eventType = evt.getPropertyName(); - if (personId != null && eventType.equals(Case.Events.PERSONS_CHANGED.toString()) && evt instanceof PersonsChangedEvent) { - ((PersonsChangedEvent) evt).getNewValue().stream() + if (personId != null && eventType.equals(Case.Events.PERSONS_CHANGED.toString()) && evt instanceof PersonsUpdatedEvent) { + ((PersonsUpdatedEvent) evt).getNewValue().stream() .filter(p -> p != null && p.getPersonId() == personId) .findFirst() .ifPresent((newPerson) -> { From 34c72cdc3469adfcad1a19defc7d18a322548d09 Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Thu, 29 Apr 2021 10:17:34 -0400 Subject: [PATCH 002/326] 7553 data model event changes --- .../casemodule/events/HostsDeletedEvent.java | 51 ++++++ .../casemodule/events/HostsUpdatedEvent.java | 41 +++++ .../events/OsAccountsAddedEvent.java | 40 +++++ .../events/OsAccountsDeletedEvent.java | 49 ++++++ .../casemodule/events/OsAccountsEvent.java | 64 +++++++ .../events/OsAccountsUpdatedEvent.java | 41 +++++ .../events/PersonsUpdatedEvent.java | 41 +++++ .../events/TskDataModelChangedEvent.java | 165 ++++++++++++++++++ 8 files changed, 492 insertions(+) create mode 100755 Core/src/org/sleuthkit/autopsy/casemodule/events/HostsDeletedEvent.java create mode 100755 Core/src/org/sleuthkit/autopsy/casemodule/events/HostsUpdatedEvent.java create mode 100755 Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsAddedEvent.java create mode 100755 Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsDeletedEvent.java create mode 100755 Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsEvent.java create mode 100755 Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsUpdatedEvent.java create mode 100755 Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsUpdatedEvent.java create mode 100755 Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangedEvent.java diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsDeletedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsDeletedEvent.java new file mode 100755 index 0000000000..3d62b78405 --- /dev/null +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsDeletedEvent.java @@ -0,0 +1,51 @@ +/* + * Autopsy Forensic Browser + * + * Copyright 2021 Basis Technology Corp. + * Contact: carrier sleuthkit org + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.sleuthkit.autopsy.casemodule.events; + +import java.util.Collections; +import java.util.List; +import org.sleuthkit.autopsy.casemodule.Case; +import org.sleuthkit.datamodel.Host; +import org.sleuthkit.datamodel.SleuthkitCase; +import org.sleuthkit.datamodel.TskCoreException; + +/** + * Event fired when hosts are deleted. + */ +public class HostsDeletedEvent extends TskDataModelChangedEvent { + + private static final long serialVersionUID = 1L; + + /** + * Main constructor. + * + * @param dataModelObjectIds The unique numeric IDs (TSK object IDs, case + * database row IDs, etc.) of the Hosts that have + * been deleted. + */ + public HostsDeletedEvent(List dataModelObjectIds) { + super(Case.Events.HOSTS_DELETED.name(), dataModelObjectIds); + } + + @Override + protected List getDataModelObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { + return Collections.emptyList(); + } + +} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsUpdatedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsUpdatedEvent.java new file mode 100755 index 0000000000..6b06382c0a --- /dev/null +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsUpdatedEvent.java @@ -0,0 +1,41 @@ +/* + * Autopsy Forensic Browser + * + * Copyright 2021 Basis Technology Corp. + * Contact: carrier sleuthkit org + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.sleuthkit.autopsy.casemodule.events; + +import java.util.List; +import org.sleuthkit.autopsy.casemodule.Case; +import org.sleuthkit.datamodel.Host; + +/** + * Event fired when hosts are changed. + */ +public class HostsUpdatedEvent extends HostsEvent { + + private static final long serialVersionUID = 1L; + + /** + * Main constructor. + * + * @param dataModelObjects The new values for the hosts that have been + * changed. + */ + public HostsUpdatedEvent(List dataModelObjects) { + super(Case.Events.HOSTS_CHANGED.name(), dataModelObjects); + } +} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsAddedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsAddedEvent.java new file mode 100755 index 0000000000..49a722062b --- /dev/null +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsAddedEvent.java @@ -0,0 +1,40 @@ +/* + * Autopsy Forensic Browser + * + * Copyright 2021 Basis Technology Corp. + * Contact: carrier sleuthkit org + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.sleuthkit.autopsy.casemodule.events; + +import java.util.List; +import org.sleuthkit.autopsy.casemodule.Case; +import org.sleuthkit.datamodel.OsAccount; + +/** + * Event published when OS accounts are added to a case. + */ +public final class OsAccountsAddedEvent extends OsAccountsEvent { + + private static final long serialVersionUID = 1L; + + /** + * Constructs an event published when OS accounts are added to a case. + * @param accounts + */ + public OsAccountsAddedEvent(List accounts) { + super(Case.Events.OS_ACCOUNT_ADDED.toString(), accounts); + } + +} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsDeletedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsDeletedEvent.java new file mode 100755 index 0000000000..52fe8d49a8 --- /dev/null +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsDeletedEvent.java @@ -0,0 +1,49 @@ +/* + * Autopsy Forensic Browser + * + * Copyright 2021 Basis Technology Corp. + * Contact: carrier sleuthkit org + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.sleuthkit.autopsy.casemodule.events; + +import java.util.Collections; +import java.util.List; +import org.sleuthkit.autopsy.casemodule.Case; +import org.sleuthkit.datamodel.OsAccount; +import org.sleuthkit.datamodel.SleuthkitCase; +import org.sleuthkit.datamodel.TskCoreException; + +/** + * An event published when OS accounts are deleted from a case. + */ +public final class OsAccountsDeletedEvent extends TskDataModelChangedEvent { + + private static final long serialVersionUID = 1L; + + /** + * Constructs an event published when OS accounts are deleted from a case. + * + * @param osAccountObjectIds The object IDs of the deleted accounts. + */ + public OsAccountsDeletedEvent(List osAccountObjectIds) { + super(Case.Events.OS_ACCOUNT_REMOVED.toString(), osAccountObjectIds); + } + + @Override + protected List getDataModelObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { + return Collections.emptyList(); + } + +} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsEvent.java new file mode 100755 index 0000000000..af214776a8 --- /dev/null +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsEvent.java @@ -0,0 +1,64 @@ +/* + * Autopsy Forensic Browser + * + * Copyright 2021 Basis Technology Corp. + * Contact: carrier sleuthkit org + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.sleuthkit.autopsy.casemodule.events; + +import java.util.ArrayList; +import java.util.List; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.sleuthkit.datamodel.OsAccount; +import org.sleuthkit.datamodel.SleuthkitCase; +import org.sleuthkit.datamodel.TskCoreException; + +/** + * Parent class for specific OsAccount event classes. + */ +class OsAccountsEvent extends TskDataModelChangedEvent { + + private static final long serialVersionUID = 1L; + + /** + * Construct a new OsAccountEvent. + * + * @param eventName The name of the event. + * @param account The OsAccount the event applies to. + */ + OsAccountsEvent(String eventName, List accounts) { + super(eventName, accounts, OsAccount::getId); + } + + /** + * Returns the OsAccount that changed. + * + * @return The OsAccount that was changed. + */ + public OsAccount getOsAccount() { + List accounts = getNewValue(); + return accounts.get(0); + } + + @Override + protected List getDataModelObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { + Long id = ids.get(0); + OsAccount account = caseDb.getOsAccountManager().getOsAccountByObjectId(id); + List accounts = new ArrayList<>(); + accounts.add(account); + return accounts; + } +} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsUpdatedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsUpdatedEvent.java new file mode 100755 index 0000000000..22ef19584b --- /dev/null +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsUpdatedEvent.java @@ -0,0 +1,41 @@ +/* + * Autopsy Forensic Browser + * + * Copyright 2021 Basis Technology Corp. + * Contact: carrier sleuthkit org + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.sleuthkit.autopsy.casemodule.events; + +import java.util.List; +import org.sleuthkit.autopsy.casemodule.Case; +import org.sleuthkit.datamodel.OsAccount; + +/** + * Event published when OS accounts in the case have been updated. + */ +public final class OsAccountsUpdatedEvent extends OsAccountsEvent { + + private static final long serialVersionUID = 1L; + + /** + * Constructs an event published when OS accounts in the case have been + * updated. + * + * @param accounts The accounts. + */ + public OsAccountsUpdatedEvent(List accounts) { + super(Case.Events.OS_ACCOUNT_CHANGED.toString(), accounts); + } +} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsUpdatedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsUpdatedEvent.java new file mode 100755 index 0000000000..cb5308d7ce --- /dev/null +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsUpdatedEvent.java @@ -0,0 +1,41 @@ +/* + * Autopsy Forensic Browser + * + * Copyright 2021 Basis Technology Corp. + * Contact: carrier sleuthkit org + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.sleuthkit.autopsy.casemodule.events; + +import java.util.List; +import org.sleuthkit.autopsy.casemodule.Case; +import org.sleuthkit.datamodel.Person; + +/** + * An event fired when persons in a case are updated. + */ +public class PersonsUpdatedEvent extends PersonsEvent { + + private static final long serialVersionUID = 1L; + + /** + * Constructs an event fired when persons in a case are updated. + * + * @param persons The updated persons. + */ + public PersonsUpdatedEvent(List persons) { + super(Case.Events.PERSONS_CHANGED.name(), persons); + } + +} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangedEvent.java new file mode 100755 index 0000000000..68a47c35c1 --- /dev/null +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangedEvent.java @@ -0,0 +1,165 @@ +/* + * Autopsy Forensic Browser + * + * Copyright 2021 Basis Technology Corp. + * Contact: carrier sleuthkit org + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.sleuthkit.autopsy.casemodule.events; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.function.Function; +import java.util.logging.Level; +import java.util.stream.Collectors; +import org.sleuthkit.autopsy.casemodule.Case; +import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException; +import org.sleuthkit.autopsy.coreutils.Logger; +import org.sleuthkit.autopsy.events.AutopsyEvent; +import org.sleuthkit.datamodel.SleuthkitCase; +import org.sleuthkit.datamodel.TskCoreException; + +/** + * An abstract base class for application events published when Sleuth Kit Data + * Model objects for a case are added, updated, or deleted. + * + * @param A Sleuth Kit Data Model object type. + */ +public abstract class TskDataModelChangedEvent extends AutopsyEvent { + + private static final long serialVersionUID = 1L; + private static final Logger logger = Logger.getLogger(TskDataModelChangedEvent.class.getName()); + private final boolean isDeletionEvent; + private final List dataModelObjectIds; + private transient List dataModelObjects; + + /** + * Constructs an instance of an abstract base class for application events + * published when Sleuth Kit Data Model objects for a case are added or + * updated. The getNewValue() method of this event will return the objects + * and the getOldValue() method will return an empty list. + * + * @param eventName The event name. + * @param dataModelObjects The Sleuth Kit Data Model objects that have been + * added or updated. + * @param getIdMethod A method that can be applied to the data model + * objects to get their unique numeric IDs (TSK + * object IDs, case database row IDs, etc.). + */ + protected TskDataModelChangedEvent(String eventName, List dataModelObjects, Function getIdMethod) { + super(eventName, null, null); + isDeletionEvent = false; + this.dataModelObjectIds = new ArrayList<>(); + this.dataModelObjectIds.addAll(dataModelObjects.stream().map(o -> getIdMethod.apply(o)).collect(Collectors.toList())); + this.dataModelObjects = new ArrayList<>(); + this.dataModelObjects.addAll(dataModelObjects); + } + + /** + * Constructs an instance of an abstract base class for application events + * published when Sleuth Kit Data Model objects for a case are added or + * updated. The getOldValue() method of this event will return the object + * IDs and the getNewValue() method will return an empty list. + * + * @param eventName The event name. + * @param dataModelObjectIds The unique numeric IDs (TSK object IDs, case + * database row IDs, etc.) of the Sleuth Kit Data + * Model objects that have been deleted. + */ + protected TskDataModelChangedEvent(String eventName, List dataModelObjectIds) { + super(eventName, null, null); + isDeletionEvent = true; + this.dataModelObjectIds = new ArrayList<>(); + this.dataModelObjectIds.addAll(dataModelObjectIds); + dataModelObjects = Collections.emptyList(); + } + + /** + * Gets the the unique numeric IDs (TSK object IDs, case database row IDs, + * etc.) of the Sleuth Kit Data Model objects that were deleted. + * + * @return The unique IDs. + */ + @Override + public List getOldValue() { + if (isDeletionEvent) { + return getDataModelObjectIds(); + } else { + return Collections.emptyList(); + } + } + + /** + * Gets the Sleuth Kit Data Model objects that were added or updated. If + * this event came from another host collaborating on a multi-user case, the + * Sleuth Kit Data Model objects will be reconstructed on the current host. + * + * @return The objects. + */ + @Override + public List getNewValue() { + if (!isDeletionEvent) { + if (dataModelObjects == null) { + try { + Case currentCase = Case.getCurrentCaseThrows(); + SleuthkitCase caseDb = currentCase.getSleuthkitCase(); + dataModelObjects = getDataModelObjects(caseDb, dataModelObjectIds); + } catch (NoCurrentCaseException | TskCoreException ex) { + logger.log(Level.SEVERE, String.format("Error geting TSK Data Model objects for %s event (%s)", getPropertyName(), getSourceType()), ex); + return Collections.emptyList(); + } + } + return Collections.unmodifiableList(dataModelObjects); + } else { + return Collections.emptyList(); + } + } + + + /** + * Gets the unique numeric IDs (TSK object IDs, case database row IDs, etc.) + * of the Sleuth Kit Data Model objects associated with this application + * event. + * + * This method is provided as an optimization that allows handling of an + * event that came from another host collaborating on a multi-user case + * without reconstructing the data model objects that are the subject s of + * the event. + * + * @return The unique IDs. + */ + public final List getDataModelObjectIds() { + return Collections.unmodifiableList(dataModelObjectIds); + } + + /** + * Gets the Sleuth Kit Data Model objects associated with this application + * event. If this event came from another host collaborating on a multi-user + * case, the Sleuth Kit Data Model objects, this method will be called to + * reconstruct the objects on the current host. + * + * @param caseDb The case database. + * @param ids The unique, numeric IDs (TSK object IDs, case database row + * IDs, etc.) of the Sleuth Kit Data Model objects. + * + * @return The objects. + * + * @throws org.sleuthkit.datamodel.TskCoreException If there is an error + * getting the Sleuth Kit + * Data Model objects. + */ + abstract protected List getDataModelObjects(SleuthkitCase caseDb, List ids) throws TskCoreException; + +} From 856eced424d77879b4bd62693e2b29ccafc69946 Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Thu, 29 Apr 2021 11:55:59 -0400 Subject: [PATCH 003/326] 7553 data model event changes --- Core/src/org/sleuthkit/autopsy/casemodule/Case.java | 6 ++---- .../autopsy/casemodule/events/TskDataModelChangedEvent.java | 2 +- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/Case.java b/Core/src/org/sleuthkit/autopsy/casemodule/Case.java index f77859d407..b2790bd8ec 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/Case.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/Case.java @@ -555,8 +555,7 @@ public class Case { */ @Subscribe public void publishPersonsAddedEvent(TskEvent.PersonsAddedTskEvent event) { - eventPublisher.publish(new PersonsAddedEvent( - event == null ? Collections.emptyList() : event.getPersons())); + eventPublisher.publish(new PersonsAddedEvent(event.getPersons())); } /** @@ -567,8 +566,7 @@ public class Case { */ @Subscribe public void publishPersonsUpdatedEvent(TskEvent.PersonsUpdatedTskEvent event) { - eventPublisher.publish(new PersonsUpdatedEvent( - event == null ? Collections.emptyList() : event.getPersons())); + eventPublisher.publish(new PersonsUpdatedEvent(event.getPersons())); } /** diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangedEvent.java index 68a47c35c1..d0d8953e92 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangedEvent.java @@ -148,7 +148,7 @@ public abstract class TskDataModelChangedEvent extends AutopsyEvent { * Gets the Sleuth Kit Data Model objects associated with this application * event. If this event came from another host collaborating on a multi-user * case, the Sleuth Kit Data Model objects, this method will be called to - * reconstruct the objects on the current host. + * reconstruct the objects on the curartifactExists(), I think we should continue to use what we have and suppress the deprecation warnings.Bent host. * * @param caseDb The case database. * @param ids The unique, numeric IDs (TSK object IDs, case database row From bb2e65a770febdbb36e651cfff42b384e5e21ce5 Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Tue, 4 May 2021 14:05:49 -0400 Subject: [PATCH 004/326] 7553 data model event changes --- .../sleuthkit/autopsy/casemodule/Case.java | 25 ++- .../casemodule/events/HostsAddedEvent.java | 20 +- .../events/HostsAddedToPersonEvent.java | 39 ++++ .../casemodule/events/HostsDeletedEvent.java | 30 +-- .../autopsy/casemodule/events/HostsEvent.java | 46 ++-- .../events/HostsRemovedFromPersonEvent.java | 25 +++ .../casemodule/events/HostsUpdatedEvent.java | 14 +- .../events/OsAccountsAddedEvent.java | 17 +- .../events/OsAccountsDeletedEvent.java | 26 ++- .../casemodule/events/OsAccountsEvent.java | 52 ++--- .../events/OsAccountsUpdatedEvent.java | 14 +- .../casemodule/events/PersonHostsEvent.java | 75 +++++++ .../casemodule/events/PersonsAddedEvent.java | 8 +- .../events/PersonsDeletedEvent.java | 29 +-- .../casemodule/events/PersonsEvent.java | 51 +++-- .../events/PersonsUpdatedEvent.java | 10 +- .../casemodule/events/ReportAddedEvent.java | 25 ++- .../events/TskDataModelChangedEvent.java | 212 +++++++++++------- .../TskDataModelObjectsDeletedEvent.java | 60 +++++ .../datamodel/AutopsyTreeChildFactory.java | 5 +- .../datamodel/DataSourcesByTypeNode.java | 5 +- .../sleuthkit/autopsy/datamodel/HostNode.java | 4 +- .../autopsy/datamodel/OsAccounts.java | 19 +- .../autopsy/datamodel/PersonGroupingNode.java | 9 +- .../hosts/AssociateNewPersonAction.java | 3 +- .../hosts/AssociatePersonAction.java | 3 +- .../hosts/RemoveParentPersonAction.java | 5 +- .../autopsy/events/AutopsyEvent.java | 50 +++-- 28 files changed, 588 insertions(+), 293 deletions(-) create mode 100755 Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedToPersonEvent.java create mode 100755 Core/src/org/sleuthkit/autopsy/casemodule/events/HostsRemovedFromPersonEvent.java create mode 100755 Core/src/org/sleuthkit/autopsy/casemodule/events/PersonHostsEvent.java create mode 100755 Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelObjectsDeletedEvent.java diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/Case.java b/Core/src/org/sleuthkit/autopsy/casemodule/Case.java index b2790bd8ec..06809bffa8 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/Case.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/Case.java @@ -432,7 +432,7 @@ public class Case { * OSAccount associated with the current case added. Call getOsAccount * to get the added account; */ - OS_ACCOUNT_ADDED, + OS_ACCOUNTS_ADDED, /** * OSAccount associated with the current case has changed. Call * getOsAccount to get the changed account; @@ -441,7 +441,7 @@ public class Case { /** * OSAccount associated with the current case has been deleted. */ - OS_ACCOUNT_REMOVED, + OS_ACCOUNTS_DELETED, /** * Hosts associated with the current case added. */ @@ -449,7 +449,7 @@ public class Case { /** * Hosts associated with the current case has changed. */ - HOSTS_CHANGED, + HOSTS_UPDATED, /** * Hosts associated with the current case has been deleted. */ @@ -461,11 +461,20 @@ public class Case { /** * Persons associated with the current case has changed. */ - PERSONS_CHANGED, + PERSONS_UPDATED, /** * Persons associated with the current case has been deleted. */ - PERSONS_DELETED; + PERSONS_DELETED, + /** + * Hosts have been added to a person. + */ + HOSTS_ADDED_TO_PERSON, + /** + * Hosts have been removed from a person. + */ + HOSTS_REMOVED_FROM_PERSON; + }; /** @@ -511,7 +520,7 @@ public class Case { @Subscribe public void publishOsAccountsDeletedEvent(TskEvent.OsAccountsDeletedTskEvent event) { - eventPublisher.publish(new OsAccountsDeletedEvent(event.getObjectIds())); + eventPublisher.publish(new OsAccountsDeletedEvent(event.getOsAccountObjectIds())); } /** @@ -544,7 +553,7 @@ public class Case { */ @Subscribe public void publishHostsDeletedEvent(TskEvent.HostsDeletedTskEvent event) { - eventPublisher.publish(new HostsDeletedEvent(event.getObjectIds())); + eventPublisher.publish(new HostsDeletedEvent(event.getHostIds())); } /** @@ -577,7 +586,7 @@ public class Case { */ @Subscribe public void publishPersonsDeletedEvent(TskEvent.PersonsDeletedTskEvent event) { - eventPublisher.publish(new PersonsDeletedEvent(event.getObjectIds())); + eventPublisher.publish(new PersonsDeletedEvent(event.getPersonIds())); } } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedEvent.java index c10b66face..bf355b66b7 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedEvent.java @@ -23,17 +23,21 @@ import org.sleuthkit.autopsy.casemodule.Case; import org.sleuthkit.datamodel.Host; /** - * Event fired when new hosts are added. + * An application event published when hosts have been added to the Sleuth Kit + * data model for a case. */ -public class HostsAddedEvent extends HostsEvent { - +public final class HostsAddedEvent extends HostsEvent { + private static final long serialVersionUID = 1L; - + /** - * Main constructor. - * @param dataModelObjects The hosts that have been added. + * Constructs an application event published when hosts have been added to + * the Sleuth Kit data model for a case. + * + * @param persons The hosts that have been added. */ - public HostsAddedEvent(List dataModelObjects) { - super(Case.Events.HOSTS_ADDED.name(), dataModelObjects); + public HostsAddedEvent(List hosts) { + super(Case.Events.HOSTS_ADDED.name(), hosts); } + } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedToPersonEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedToPersonEvent.java new file mode 100755 index 0000000000..8b1b9da8a3 --- /dev/null +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedToPersonEvent.java @@ -0,0 +1,39 @@ +/* + * Autopsy Forensic Browser + * + * Copyright 2021 Basis Technology Corp. + * Contact: carrier sleuthkit org + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.sleuthkit.autopsy.casemodule.events; + +import java.util.Collections; +import java.util.List; +import org.sleuthkit.autopsy.casemodule.Case; +import org.sleuthkit.datamodel.Host; +import org.sleuthkit.datamodel.Person; + +/** + * + * @author rcordovano + */ +public final class HostsAddedToPersonEvent extends PersonHostsEvent { + + private static final long serialVersionUID = 1L; + + HostsAddedToPersonEvent(Person person, List hosts) { + super(Case.Events.HOSTS_ADDED_TO_PERSON.toString(), person, hosts); + } + +} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsDeletedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsDeletedEvent.java index 3d62b78405..24c2ae091b 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsDeletedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsDeletedEvent.java @@ -18,34 +18,34 @@ */ package org.sleuthkit.autopsy.casemodule.events; -import java.util.Collections; import java.util.List; import org.sleuthkit.autopsy.casemodule.Case; -import org.sleuthkit.datamodel.Host; -import org.sleuthkit.datamodel.SleuthkitCase; -import org.sleuthkit.datamodel.TskCoreException; /** - * Event fired when hosts are deleted. + * Application events published when hosts have been deleted from the Sleuth + * Kit data model for a case. */ -public class HostsDeletedEvent extends TskDataModelChangedEvent { +public final class HostsDeletedEvent extends TskDataModelObjectsDeletedEvent { private static final long serialVersionUID = 1L; /** - * Main constructor. + * Constructs an application event published when hosts have been deleted + * from the Sleuth Kit data model for a case. * - * @param dataModelObjectIds The unique numeric IDs (TSK object IDs, case - * database row IDs, etc.) of the Hosts that have - * been deleted. + * @param hostIds The host IDs of the deleted hosts. */ - public HostsDeletedEvent(List dataModelObjectIds) { - super(Case.Events.HOSTS_DELETED.name(), dataModelObjectIds); + public HostsDeletedEvent(List hostIds) { + super(Case.Events.HOSTS_DELETED.name(), hostIds); } - @Override - protected List getDataModelObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { - return Collections.emptyList(); + /** + * Gets the host IDs of the hosts that have been deleted. + * + * @return The host IDs. + */ + public List getHostIds() { + return getOldValue(); } } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsEvent.java index 69f68c0b4e..1ac350c272 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsEvent.java @@ -22,44 +22,48 @@ import java.util.ArrayList; import java.util.List; import java.util.Optional; import org.sleuthkit.datamodel.Host; -import org.sleuthkit.datamodel.HostManager; import org.sleuthkit.datamodel.SleuthkitCase; import org.sleuthkit.datamodel.TskCoreException; /** - * Base event class for when something pertaining to hosts changes. + * A base class for application events published when hosts in the Sleuth Kit + * data model for a case have been added or updated. */ -public class HostsEvent extends TskDataModelChangedEvent { +public class HostsEvent extends TskDataModelChangedEvent { private static final long serialVersionUID = 1L; /** - * Main constructor. + * Constructs the base class part of an application event published when + * hosts in the Sleuth Kit data model for a case have been added or updated. * * @param eventName The name of the Case.Events enum value for the event - * type. - * @param dataModelObjects The list of hosts for the event. + * type. + * @param hosts The hosts. */ - protected HostsEvent(String eventName, List dataModelObjects) { - super(eventName, dataModelObjects, Host::getHostId); + protected HostsEvent(String eventName, List hosts) { + super(eventName, null, null, hosts, Host::getHostId); + } + + /** + * Gets the hosts that have been added or updated. + * + * @return The hosts. + */ + public List getHosts() { + return getNewValue(); } @Override - protected List getDataModelObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { - HostManager hostManager = caseDb.getHostManager(); - List toRet = new ArrayList<>(); - if (ids != null) { - for (Long id : ids) { - if (id == null) { - continue; - } - - Optional thisHostOpt = hostManager.getHostById(id); - thisHostOpt.ifPresent((h) -> toRet.add(h)); + protected List getNewValueObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { + List hosts = new ArrayList<>(); + for (Long id : ids) { + Optional host = caseDb.getHostManager().getHostById(id); + if (host.isPresent()) { + hosts.add(host.get()); } } - - return toRet; + return hosts; } } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsRemovedFromPersonEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsRemovedFromPersonEvent.java new file mode 100755 index 0000000000..eaf200368d --- /dev/null +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsRemovedFromPersonEvent.java @@ -0,0 +1,25 @@ +/* + * To change this license header, choose License Headers in Project Properties. + * To change this template file, choose Tools | Templates + * and open the template in the editor. + */ +package org.sleuthkit.autopsy.casemodule.events; + +import java.util.List; +import org.sleuthkit.autopsy.casemodule.Case; +import org.sleuthkit.datamodel.Host; +import org.sleuthkit.datamodel.Person; + +/** + * + * @author rcordovano + */ +public class HostsRemovedFromPersonEvent extends PersonHostsEvent { + + private static final long serialVersionUID = 1L; + + HostsRemovedFromPersonEvent(Person person, List hosts) { + super(Case.Events.HOSTS_REMOVED_FROM_PERSON.toString(), person, hosts); + } + +} \ No newline at end of file diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsUpdatedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsUpdatedEvent.java index 6b06382c0a..ec00fc5ad6 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsUpdatedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsUpdatedEvent.java @@ -23,19 +23,21 @@ import org.sleuthkit.autopsy.casemodule.Case; import org.sleuthkit.datamodel.Host; /** - * Event fired when hosts are changed. + * Application events published when hosts in the Sleuth Kit data model for + * a case have been updated. */ public class HostsUpdatedEvent extends HostsEvent { private static final long serialVersionUID = 1L; /** - * Main constructor. + * Constructs an application event published when hosts in the Sleuth Kit + * data model for a case have been updated. * - * @param dataModelObjects The new values for the hosts that have been - * changed. + * @param hosts The updated persons. */ - public HostsUpdatedEvent(List dataModelObjects) { - super(Case.Events.HOSTS_CHANGED.name(), dataModelObjects); + public HostsUpdatedEvent(List hosts) { + super(Case.Events.HOSTS_UPDATED.name(), hosts); } + } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsAddedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsAddedEvent.java index 49a722062b..f4273408c6 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsAddedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsAddedEvent.java @@ -19,22 +19,25 @@ package org.sleuthkit.autopsy.casemodule.events; import java.util.List; -import org.sleuthkit.autopsy.casemodule.Case; +import static org.sleuthkit.autopsy.casemodule.Case.Events.OS_ACCOUNTS_ADDED; import org.sleuthkit.datamodel.OsAccount; /** - * Event published when OS accounts are added to a case. + * An application event published when OS accounts are added to the Sleuth Kit + * data model for a case. */ public final class OsAccountsAddedEvent extends OsAccountsEvent { private static final long serialVersionUID = 1L; - + /** - * Constructs an event published when OS accounts are added to a case. - * @param accounts + * Constructs an application event published when OS accounts are added to + * the Sleuth Kit data model for a case. + * + * @param osAccounts The OS accounts that were added. */ - public OsAccountsAddedEvent(List accounts) { - super(Case.Events.OS_ACCOUNT_ADDED.toString(), accounts); + public OsAccountsAddedEvent(List osAccounts) { + super(OS_ACCOUNTS_ADDED.toString(), osAccounts); } } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsDeletedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsDeletedEvent.java index 52fe8d49a8..f3f65a0aed 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsDeletedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsDeletedEvent.java @@ -18,32 +18,34 @@ */ package org.sleuthkit.autopsy.casemodule.events; -import java.util.Collections; import java.util.List; import org.sleuthkit.autopsy.casemodule.Case; -import org.sleuthkit.datamodel.OsAccount; -import org.sleuthkit.datamodel.SleuthkitCase; -import org.sleuthkit.datamodel.TskCoreException; /** - * An event published when OS accounts are deleted from a case. + * An application event published when OS accounts have been deleted from the + * Sleuth Kit data model for a case. */ -public final class OsAccountsDeletedEvent extends TskDataModelChangedEvent { +public final class OsAccountsDeletedEvent extends TskDataModelObjectsDeletedEvent { private static final long serialVersionUID = 1L; /** - * Constructs an event published when OS accounts are deleted from a case. + * Constructs an application event published when OS accounts have been + * deleted from the Sleuth Kit data model for a case. * - * @param osAccountObjectIds The object IDs of the deleted accounts. + * @param osAccountObjectIds TSK object IDs of the deleted accounts. */ public OsAccountsDeletedEvent(List osAccountObjectIds) { - super(Case.Events.OS_ACCOUNT_REMOVED.toString(), osAccountObjectIds); + super(Case.Events.OS_ACCOUNTS_DELETED.toString(), osAccountObjectIds); } - @Override - protected List getDataModelObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { - return Collections.emptyList(); + /** + * Gets the Sleuth Kit object IDs of the deleted OS accounts. + * + * @return The object IDs. + */ + List getOsAccountObjectIds() { + return getOldValue(); } } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsEvent.java index af214776a8..434d8c8f60 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsEvent.java @@ -20,45 +20,47 @@ package org.sleuthkit.autopsy.casemodule.events; import java.util.ArrayList; import java.util.List; -import java.util.stream.Collectors; -import java.util.stream.Stream; import org.sleuthkit.datamodel.OsAccount; import org.sleuthkit.datamodel.SleuthkitCase; import org.sleuthkit.datamodel.TskCoreException; /** - * Parent class for specific OsAccount event classes. + * A base class for application events published when OS accounts in the Sleuth + * Kit data model for a case have been added or updated. */ -class OsAccountsEvent extends TskDataModelChangedEvent { +class OsAccountsEvent extends TskDataModelChangedEvent { private static final long serialVersionUID = 1L; - + /** - * Construct a new OsAccountEvent. - * - * @param eventName The name of the event. - * @param account The OsAccount the event applies to. + * Constructs the base class part of an application event published when + * OS accounts in the Sleuth Kit data model for a case have been added or + * updated. + * + * @param eventName The name of the Case.Events enum value for the event + * type. + * @param account The OS accounts. */ - OsAccountsEvent(String eventName, List accounts) { - super(eventName, accounts, OsAccount::getId); + OsAccountsEvent(String eventName, List osAccounts) { + super(eventName, null, null, osAccounts, OsAccount::getId); } - + /** - * Returns the OsAccount that changed. - * - * @return The OsAccount that was changed. + * Gets the OS accounts that have been added or updated. + * + * @return The OS accounts. */ - public OsAccount getOsAccount() { - List accounts = getNewValue(); - return accounts.get(0); + public List getOsAccounts() { + return getNewValue(); } @Override - protected List getDataModelObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { - Long id = ids.get(0); - OsAccount account = caseDb.getOsAccountManager().getOsAccountByObjectId(id); - List accounts = new ArrayList<>(); - accounts.add(account); - return accounts; - } + protected List getNewValueObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { + List osAccounts = new ArrayList<>(); + for (Long id : ids) { + osAccounts.add(caseDb.getOsAccountManager().getOsAccountByObjectId(id)); + } + return osAccounts; + } + } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsUpdatedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsUpdatedEvent.java index 22ef19584b..9795f055d6 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsUpdatedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsUpdatedEvent.java @@ -23,19 +23,21 @@ import org.sleuthkit.autopsy.casemodule.Case; import org.sleuthkit.datamodel.OsAccount; /** - * Event published when OS accounts in the case have been updated. + * An application event published when OS accounts in the Sleuth Kit data model + * for a case have been updated. */ public final class OsAccountsUpdatedEvent extends OsAccountsEvent { private static final long serialVersionUID = 1L; /** - * Constructs an event published when OS accounts in the case have been - * updated. + * Constructs an application event published when OS accounts in the Sleuth + * Kit data model for a case have been updated. * - * @param accounts The accounts. + * @param osAccounts The OS accounts that were updated. */ - public OsAccountsUpdatedEvent(List accounts) { - super(Case.Events.OS_ACCOUNT_CHANGED.toString(), accounts); + public OsAccountsUpdatedEvent(List osAccounts) { + super(Case.Events.OS_ACCOUNT_CHANGED.toString(), osAccounts); } + } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonHostsEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonHostsEvent.java new file mode 100755 index 0000000000..f1426e38e4 --- /dev/null +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonHostsEvent.java @@ -0,0 +1,75 @@ +/* + * To change this license header, choose License Headers in Project Properties. + * To change this template file, choose Tools | Templates + * and open the template in the editor. + */ +package org.sleuthkit.autopsy.casemodule.events; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Optional; +import org.sleuthkit.datamodel.Host; +import org.sleuthkit.datamodel.Person; +import org.sleuthkit.datamodel.SleuthkitCase; +import org.sleuthkit.datamodel.TskCoreException; + +/** + * + * @author rcordovano + */ +public abstract class PersonHostsEvent extends TskDataModelChangedEvent { + + private static final long serialVersionUID = 1L; + + /** + * + * @param eventName + * @param person + * @param hosts + */ + PersonHostsEvent(String eventName, Person person, List hosts) { + super(eventName, Collections.singletonList(person), Person::getPersonId, hosts, Host::getHostId); + } + + /** + * + * @return + */ + Person getPerson() { + return getOldValue().get(0); + } + + /** + * + * @return + */ + List getHosts() { + return getNewValue(); + } + + @Override + protected List getOldValueObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { + List persons = new ArrayList<>(); + for (Long id : ids) { + Optional person = caseDb.getPersonManager().getPerson(id); + if (person.isPresent()) { + persons.add(person.get()); + } + } + return persons; + } + + @Override + protected List getNewValueObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { + List hosts = new ArrayList<>(); + for (Long id : ids) { + Optional host = caseDb.getHostManager().getHostById(id); + if (host.isPresent()) { + hosts.add(host.get()); + } + } + return hosts; + } + +} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsAddedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsAddedEvent.java index c61bc177f3..afd101eac3 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsAddedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsAddedEvent.java @@ -23,19 +23,21 @@ import org.sleuthkit.autopsy.casemodule.Case; import org.sleuthkit.datamodel.Person; /** - * Event fired when new persons are added to a case. + * An application event published when persons have been added to the Sleuth Kit + * data model for a case. */ public class PersonsAddedEvent extends PersonsEvent { private static final long serialVersionUID = 1L; /** - * Constructs an event fired when new persons are added to a case. + * Constructs an application event published when persons have been added to + * the Sleuth Kit data model for a case. * * @param persons The persons that have been added. */ public PersonsAddedEvent(List persons) { super(Case.Events.PERSONS_ADDED.name(), persons); } - + } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsDeletedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsDeletedEvent.java index db80759214..46c024b7dd 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsDeletedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsDeletedEvent.java @@ -18,33 +18,34 @@ */ package org.sleuthkit.autopsy.casemodule.events; -import java.util.Collections; import java.util.List; import org.sleuthkit.autopsy.casemodule.Case; -import org.sleuthkit.datamodel.Person; -import org.sleuthkit.datamodel.SleuthkitCase; -import org.sleuthkit.datamodel.TskCoreException; /** - * An event fired when persons are deleted from the case. + * Application events published when persons have been deleted from the Sleuth + * Kit data model for a case. */ -public class PersonsDeletedEvent extends TskDataModelChangedEvent { +public class PersonsDeletedEvent extends TskDataModelObjectsDeletedEvent { private static final long serialVersionUID = 1L; /** - * Constructs an event fired when persons are deleted from the case. + * Constructs an application event published when persons have been deleted + * from the Sleuth Kit data model for a case. * - * @param dataModelObjectIds The unique numeric IDs (case database row IDs) - * of the persons that have been deleted. + * @param personIds The IDs of the persons that have been deleted. */ - public PersonsDeletedEvent(List dataModelObjectIds) { - super(Case.Events.PERSONS_DELETED.name(), dataModelObjectIds); + public PersonsDeletedEvent(List personIds) { + super(Case.Events.PERSONS_DELETED.name(), personIds); } - @Override - protected List getDataModelObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { - return Collections.emptyList(); + /** + * Gets the person IDs of the persons that have been deleted. + * + * @return The person IDs. + */ + List getPersonIds() { + return getOldValue(); } } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsEvent.java index 5380ee4874..2d3b322ea7 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsEvent.java @@ -22,44 +22,49 @@ import java.util.ArrayList; import java.util.List; import java.util.Optional; import org.sleuthkit.datamodel.Person; -import org.sleuthkit.datamodel.PersonManager; import org.sleuthkit.datamodel.SleuthkitCase; import org.sleuthkit.datamodel.TskCoreException; /** - * Base event class for when something pertaining to persons changes. + * A base class for application events published when persons in the Sleuth Kit + * data model for a case have been added or updated. */ -public class PersonsEvent extends TskDataModelChangedEvent { +public class PersonsEvent extends TskDataModelChangedEvent { private static final long serialVersionUID = 1L; - + /** - * Main constructor. + * Constructs the base class part of an application event published when + * persons in the Sleuth Kit data model for a case have been added or + * updated. * * @param eventName The name of the Case.Events enum value for the event - * type. - * @param dataModelObjects The list of persons for the event. + * type. + * @param persons The persons. */ - PersonsEvent(String eventName, List dataModelObjects) { - super(eventName, dataModelObjects, Person::getPersonId); + PersonsEvent(String eventName, List persons) { + super(eventName, null, null, persons, Person::getPersonId); } - - @Override - protected List getDataModelObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { - PersonManager personManager = caseDb.getPersonManager(); - List toRet = new ArrayList<>(); - if (ids != null) { - for (Long id : ids) { - if (id == null) { - continue; - } - Optional thisPersonOpt = personManager.getPerson(id); - thisPersonOpt.ifPresent((h) -> toRet.add(h)); + /** + * Gets the persons that have been added or updated. + * + * @return The persons. + */ + public List getPersons() { + return getNewValue(); + } + + @Override + protected List getNewValueObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { + List persons = new ArrayList<>(); + for (Long id : ids) { + Optional person = caseDb.getPersonManager().getPerson(id); + if (person.isPresent()) { + persons.add(person.get()); } } - - return toRet; + return persons; } } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsUpdatedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsUpdatedEvent.java index cb5308d7ce..572b832688 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsUpdatedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonsUpdatedEvent.java @@ -23,19 +23,21 @@ import org.sleuthkit.autopsy.casemodule.Case; import org.sleuthkit.datamodel.Person; /** - * An event fired when persons in a case are updated. + * Application events published when persons in the Sleuth Kit data model for + * a case have been updated. */ public class PersonsUpdatedEvent extends PersonsEvent { private static final long serialVersionUID = 1L; /** - * Constructs an event fired when persons in a case are updated. + * Constructs an application event published when persons in the Sleuth Kit + * data model for a case have been updated. * * @param persons The updated persons. */ public PersonsUpdatedEvent(List persons) { - super(Case.Events.PERSONS_CHANGED.name(), persons); + super(Case.Events.PERSONS_UPDATED.name(), persons); } - + } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/ReportAddedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/ReportAddedEvent.java index 47c5a30d5d..9da76a4366 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/ReportAddedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/ReportAddedEvent.java @@ -28,33 +28,38 @@ import org.sleuthkit.datamodel.SleuthkitCase; import org.sleuthkit.datamodel.TskCoreException; /** - * Event published when a report is added to a case. + * An application event published when a report is added to a case. */ -public final class ReportAddedEvent extends TskDataModelChangedEvent { +public final class ReportAddedEvent extends TskDataModelChangedEvent { private static final long serialVersionUID = 1L; /** - * Constructs an event published when a report is added to a case. + * Constructs an application event published when a report is added to a + * case. * - * @param report The data source that was added. + * @param report The report that was added. */ public ReportAddedEvent(Report report) { - super(Case.Events.REPORT_ADDED.toString(), Stream.of(report).collect(Collectors.toList()), Report::getId); + super(Case.Events.REPORT_ADDED.toString(), null, null, Stream.of(report).collect(Collectors.toList()), Report::getId); } + /** + * Gets the reoprt that was added to the case. + * + * @return The report. + */ public Report getReport() { List reports = getNewValue(); return reports.get(0); } - + @Override - protected List getDataModelObjects(SleuthkitCase caseD, List ids) throws TskCoreException { + protected List getNewValueObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { Long id = ids.get(0); - Report report = caseD.getReportById(id); List reports = new ArrayList<>(); - reports.add(report); + reports.add(caseDb.getReportById(id)); return reports; } - + } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangedEvent.java index d0d8953e92..07ed7166d7 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangedEvent.java @@ -32,123 +32,142 @@ import org.sleuthkit.datamodel.SleuthkitCase; import org.sleuthkit.datamodel.TskCoreException; /** - * An abstract base class for application events published when Sleuth Kit Data - * Model objects for a case are added, updated, or deleted. + * An abstract base class for application events published when one or more + * Sleuth Kit Data Model objects for a case change in some way. * - * @param A Sleuth Kit Data Model object type. + * This class extends AutopsyEvent. The AutopsyEvent class extends + * PropertyChangeEvent to integrate with legacy use of JavaBeans + * PropertyChangeEvents and PropertyChangeListeners as an application event + * publisher-subcriber mechanism. Subclasses need to decide what constitutes + * "old" and "new" objects for them and are encouraged to provide getters for + * these values that do not require clients to cast the return values. + * + * The AutopsyEvent class implements Serializable to allow local event instances + * to be published to other Autopsy nodes over a network in serialized form. TSK + * Data Model objects are generally not serializable because they encapsulate a + * reference to a SleuthkitCase object that represents the case database and + * which has local JDBC Connection objects. For this reason, this class supports + * serialization of the unique numeric IDs (TSK object IDs, case database row + * IDs, etc.) of the subject TSK Data Model objects and the "reconstruction" of + * those objects on other Autopsy nodes by querying the case database by unique + * ID. + * + * @param The Sleuth Kit Data Model object type of the "old" data model + * objects. + * @param The Sleuth Kit Data Model object type of the "new" data model + * objects. */ -public abstract class TskDataModelChangedEvent extends AutopsyEvent { +public abstract class TskDataModelChangedEvent extends AutopsyEvent { private static final long serialVersionUID = 1L; private static final Logger logger = Logger.getLogger(TskDataModelChangedEvent.class.getName()); - private final boolean isDeletionEvent; - private final List dataModelObjectIds; - private transient List dataModelObjects; + private final boolean hasOldValue; + private final List oldValueIds; + private transient List oldValueObjects; + private final boolean hasNewValue; + private final List newValueIds; + private transient List newValueObjects; /** - * Constructs an instance of an abstract base class for application events - * published when Sleuth Kit Data Model objects for a case are added or - * updated. The getNewValue() method of this event will return the objects - * and the getOldValue() method will return an empty list. + * Constructs the base class part for application events published when one + * or more Sleuth Kit Data Model objects for a case change in some way. * - * @param eventName The event name. - * @param dataModelObjects The Sleuth Kit Data Model objects that have been - * added or updated. - * @param getIdMethod A method that can be applied to the data model - * objects to get their unique numeric IDs (TSK - * object IDs, case database row IDs, etc.). + * @param eventName The event name. + * @param oldValueObjects A list of he Data Model objects that have been + * designated as the "old" objects in the event. + * May be null. + * @param oldValueGetIdMethod A method that can be applied to the "old" data + * model objects to get their unique numeric IDs + * (TSK object IDs, case database row IDs, etc.). + * May be null if there are no "old" objects. + * @param newValueObjects A list of he Data Model objects that have been + * designated as the "new" objects in the event. + * May be null. + * @param newValueGetIdMethod A method that can be applied to the "new" data + * model objects to get their unique numeric IDs + * (TSK object IDs, case database row IDs, etc.). + * May be null if there are no "new" objects. */ - protected TskDataModelChangedEvent(String eventName, List dataModelObjects, Function getIdMethod) { + protected TskDataModelChangedEvent(String eventName, List oldValueObjects, Function oldValueGetIdMethod, List newValueObjects, Function newValueGetIdMethod) { super(eventName, null, null); - isDeletionEvent = false; - this.dataModelObjectIds = new ArrayList<>(); - this.dataModelObjectIds.addAll(dataModelObjects.stream().map(o -> getIdMethod.apply(o)).collect(Collectors.toList())); - this.dataModelObjects = new ArrayList<>(); - this.dataModelObjects.addAll(dataModelObjects); - } - - /** - * Constructs an instance of an abstract base class for application events - * published when Sleuth Kit Data Model objects for a case are added or - * updated. The getOldValue() method of this event will return the object - * IDs and the getNewValue() method will return an empty list. - * - * @param eventName The event name. - * @param dataModelObjectIds The unique numeric IDs (TSK object IDs, case - * database row IDs, etc.) of the Sleuth Kit Data - * Model objects that have been deleted. - */ - protected TskDataModelChangedEvent(String eventName, List dataModelObjectIds) { - super(eventName, null, null); - isDeletionEvent = true; - this.dataModelObjectIds = new ArrayList<>(); - this.dataModelObjectIds.addAll(dataModelObjectIds); - dataModelObjects = Collections.emptyList(); - } - - /** - * Gets the the unique numeric IDs (TSK object IDs, case database row IDs, - * etc.) of the Sleuth Kit Data Model objects that were deleted. - * - * @return The unique IDs. - */ - @Override - public List getOldValue() { - if (isDeletionEvent) { - return getDataModelObjectIds(); + oldValueIds = new ArrayList<>(); + this.oldValueObjects = new ArrayList<>(); + if (oldValueObjects != null) { + hasOldValue = true; + oldValueIds.addAll(oldValueObjects.stream() + .map(o -> oldValueGetIdMethod.apply(o)) + .collect(Collectors.toList())); + this.oldValueObjects.addAll(oldValueObjects); } else { - return Collections.emptyList(); + hasOldValue = false; + } + newValueIds = new ArrayList<>(); + this.newValueObjects = new ArrayList<>(); + if (oldValueObjects != null) { + hasNewValue = true; + newValueIds.addAll(newValueObjects.stream() + .map(o -> newValueGetIdMethod.apply(o)) + .collect(Collectors.toList())); + this.newValueObjects.addAll(newValueObjects); + } else { + hasNewValue = false; } } /** - * Gets the Sleuth Kit Data Model objects that were added or updated. If - * this event came from another host collaborating on a multi-user case, the - * Sleuth Kit Data Model objects will be reconstructed on the current host. + * Gets a list of the Data Model objects that have been designated as the + * "old" objects in the event. * - * @return The objects. + * @return The list of the "old" data model objects. May be empty. */ @Override - public List getNewValue() { - if (!isDeletionEvent) { - if (dataModelObjects == null) { + public List getOldValue() { + if (hasOldValue) { + if (oldValueObjects == null) { try { Case currentCase = Case.getCurrentCaseThrows(); SleuthkitCase caseDb = currentCase.getSleuthkitCase(); - dataModelObjects = getDataModelObjects(caseDb, dataModelObjectIds); + oldValueObjects = getOldValueObjects(caseDb, oldValueIds); } catch (NoCurrentCaseException | TskCoreException ex) { - logger.log(Level.SEVERE, String.format("Error geting TSK Data Model objects for %s event (%s)", getPropertyName(), getSourceType()), ex); + logger.log(Level.SEVERE, String.format("Error getting oldValue() TSK Data Model objects for %s event (%s)", getPropertyName(), getSourceType()), ex); return Collections.emptyList(); } } - return Collections.unmodifiableList(dataModelObjects); + return Collections.unmodifiableList(oldValueObjects); } else { return Collections.emptyList(); } } + /** + * Gets a list of the Data Model objects that have been designated as the + * "new" objects in the event. + * + * @return The list of the "new" data model objects. May be empty. + */ + @Override + public List getNewValue() { + if (hasNewValue) { + if (newValueObjects == null) { + try { + Case currentCase = Case.getCurrentCaseThrows(); + SleuthkitCase caseDb = currentCase.getSleuthkitCase(); + newValueObjects = getNewValueObjects(caseDb, newValueIds); + } catch (NoCurrentCaseException | TskCoreException ex) { + logger.log(Level.SEVERE, String.format("Error getting newValue() TSK Data Model objects for %s event (%s)", getPropertyName(), getSourceType()), ex); + return Collections.emptyList(); + } + } + return Collections.unmodifiableList(newValueObjects); + } else { + return Collections.emptyList(); + } + } /** - * Gets the unique numeric IDs (TSK object IDs, case database row IDs, etc.) - * of the Sleuth Kit Data Model objects associated with this application - * event. - * - * This method is provided as an optimization that allows handling of an - * event that came from another host collaborating on a multi-user case - * without reconstructing the data model objects that are the subject s of - * the event. - * - * @return The unique IDs. - */ - public final List getDataModelObjectIds() { - return Collections.unmodifiableList(dataModelObjectIds); - } - - /** - * Gets the Sleuth Kit Data Model objects associated with this application - * event. If this event came from another host collaborating on a multi-user - * case, the Sleuth Kit Data Model objects, this method will be called to - * reconstruct the objects on the curartifactExists(), I think we should continue to use what we have and suppress the deprecation warnings.Bent host. + * Reconstructs the "old" Sleuth Kit Data Model objects associated with this + * application event, if any, using the given unique numeric IDs (TSK object + * IDs, case database row IDs, etc.) to query the given case database. * * @param caseDb The case database. * @param ids The unique, numeric IDs (TSK object IDs, case database row @@ -160,6 +179,27 @@ public abstract class TskDataModelChangedEvent extends AutopsyEvent { * getting the Sleuth Kit * Data Model objects. */ - abstract protected List getDataModelObjects(SleuthkitCase caseDb, List ids) throws TskCoreException; + protected List getOldValueObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { + return Collections.emptyList(); + } + + /** + * Reconstructs the "new" Sleuth Kit Data Model objects associated with this + * application event, if any, using the given unique numeric IDs (TSK object + * IDs, case database row IDs, etc.) to query the given case database. + * + * @param caseDb The case database. + * @param ids The unique, numeric IDs (TSK object IDs, case database row + * IDs, etc.) of the Sleuth Kit Data Model objects. + * + * @return The objects. + * + * @throws org.sleuthkit.datamodel.TskCoreException If there is an error + * getting the Sleuth Kit + * Data Model objects. + */ + protected List getNewValueObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { + return Collections.emptyList(); + } } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelObjectsDeletedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelObjectsDeletedEvent.java new file mode 100755 index 0000000000..7e5929e4a1 --- /dev/null +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelObjectsDeletedEvent.java @@ -0,0 +1,60 @@ +/* + * Autopsy Forensic Browser + * + * Copyright 2021 Basis Technology Corp. + * Contact: carrier sleuthkit org + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.sleuthkit.autopsy.casemodule.events; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import org.sleuthkit.autopsy.events.AutopsyEvent; + +/** + * An abstract base class for application events published when one or more + * Sleuth Kit Data Model objects for a case have been deleted. + * + * This class extends AutopsyEvent. The AutopsyEvent class extends + * PropertyChangeEvent to integrate with legacy use of JavaBeans + * PropertyChangeEvents and PropertyChangeListeners as an application event + * publisher-subcriber mechanism. Subclasses need to decide what constitutes + * "old" and "new" objects for them. + * + * For this class the "old" values are the unique numeric IDs (TSK object IDs, + * case database row IDs, etc.) of the deleted TSK Data Model objects. There are + * no "new" values. Subclasses are encouraged to provide less generic getters + * with descriptive names for the unique IDs than the override of the inherited + * getOldValue() method below. These getters can be implemented by delegating to + * getOldValue(). + */ +public class TskDataModelObjectsDeletedEvent extends AutopsyEvent { + + private static final long serialVersionUID = 1L; + + private final List deletedObjectIds; + + protected TskDataModelObjectsDeletedEvent(String eventName, List deletedObjectIds) { + super(eventName, null, null); + this.deletedObjectIds = new ArrayList<>(); + this.deletedObjectIds.addAll(deletedObjectIds); + } + + @Override + public List getOldValue() { + return Collections.unmodifiableList(deletedObjectIds); + } + +} diff --git a/Core/src/org/sleuthkit/autopsy/datamodel/AutopsyTreeChildFactory.java b/Core/src/org/sleuthkit/autopsy/datamodel/AutopsyTreeChildFactory.java index 22b340d5f1..ca4368e1e4 100644 --- a/Core/src/org/sleuthkit/autopsy/datamodel/AutopsyTreeChildFactory.java +++ b/Core/src/org/sleuthkit/autopsy/datamodel/AutopsyTreeChildFactory.java @@ -47,13 +47,12 @@ import org.sleuthkit.datamodel.TskCoreException; */ public final class AutopsyTreeChildFactory extends ChildFactory.Detachable { - private static final Set LISTENING_EVENTS = EnumSet.of( - Case.Events.DATA_SOURCE_ADDED, + private static final Set LISTENING_EVENTS = EnumSet.of(Case.Events.DATA_SOURCE_ADDED, Case.Events.HOSTS_ADDED, Case.Events.HOSTS_DELETED, Case.Events.PERSONS_ADDED, Case.Events.PERSONS_DELETED, - Case.Events.PERSONS_CHANGED + Case.Events.PERSONS_UPDATED ); private static final Set LISTENING_EVENT_NAMES = LISTENING_EVENTS.stream() diff --git a/Core/src/org/sleuthkit/autopsy/datamodel/DataSourcesByTypeNode.java b/Core/src/org/sleuthkit/autopsy/datamodel/DataSourcesByTypeNode.java index 1fab7774c7..700875d161 100644 --- a/Core/src/org/sleuthkit/autopsy/datamodel/DataSourcesByTypeNode.java +++ b/Core/src/org/sleuthkit/autopsy/datamodel/DataSourcesByTypeNode.java @@ -50,11 +50,10 @@ public class DataSourcesByTypeNode extends DisplayableItemNode { */ public static class DataSourcesByTypeChildren extends ChildFactory.Detachable { - private static final Set UPDATE_EVTS = EnumSet.of( - Case.Events.DATA_SOURCE_ADDED, + private static final Set UPDATE_EVTS = EnumSet.of(Case.Events.DATA_SOURCE_ADDED, Case.Events.HOSTS_ADDED, Case.Events.HOSTS_DELETED, - Case.Events.HOSTS_CHANGED); + Case.Events.HOSTS_UPDATED); private static final Set UPDATE_EVT_STRS = UPDATE_EVTS.stream() .map(evt -> evt.name()) diff --git a/Core/src/org/sleuthkit/autopsy/datamodel/HostNode.java b/Core/src/org/sleuthkit/autopsy/datamodel/HostNode.java index 57253ef60e..644e2b6b80 100644 --- a/Core/src/org/sleuthkit/autopsy/datamodel/HostNode.java +++ b/Core/src/org/sleuthkit/autopsy/datamodel/HostNode.java @@ -177,7 +177,7 @@ public class HostNode extends DisplayableItemNode { @Override public void propertyChange(PropertyChangeEvent evt) { String eventType = evt.getPropertyName(); - if (hostId != null && eventType.equals(Case.Events.HOSTS_CHANGED.toString()) && evt instanceof HostsUpdatedEvent) { + if (hostId != null && eventType.equals(Case.Events.HOSTS_UPDATED.toString()) && evt instanceof HostsUpdatedEvent) { ((HostsUpdatedEvent) evt).getNewValue().stream() .filter(h -> h != null && h.getHostId() == hostId) .findFirst() @@ -246,7 +246,7 @@ public class HostNode extends DisplayableItemNode { host == null ? Lookups.fixed(displayName) : Lookups.fixed(host, displayName)); hostId = host == null ? null : host.getHostId(); - Case.addEventTypeSubscriber(EnumSet.of(Case.Events.HOSTS_CHANGED), + Case.addEventTypeSubscriber(EnumSet.of(Case.Events.HOSTS_UPDATED), WeakListeners.propertyChange(hostChangePcl, this)); super.setName(displayName); super.setDisplayName(displayName); diff --git a/Core/src/org/sleuthkit/autopsy/datamodel/OsAccounts.java b/Core/src/org/sleuthkit/autopsy/datamodel/OsAccounts.java index 42a69caa99..9472a65616 100755 --- a/Core/src/org/sleuthkit/autopsy/datamodel/OsAccounts.java +++ b/Core/src/org/sleuthkit/autopsy/datamodel/OsAccounts.java @@ -124,8 +124,8 @@ public final class OsAccounts implements AutopsyVisitableItem { @Override public void propertyChange(PropertyChangeEvent evt) { String eventType = evt.getPropertyName(); - if (eventType.equals(Case.Events.OS_ACCOUNT_ADDED.toString()) - || eventType.equals(Case.Events.OS_ACCOUNT_REMOVED.toString())) { + if (eventType.equals(Case.Events.OS_ACCOUNTS_ADDED.toString()) + || eventType.equals(Case.Events.OS_ACCOUNTS_DELETED.toString())) { refresh(true); } else if (eventType.equals(Case.Events.CURRENT_CASE.toString())) { // case was closed. Remove listeners so that we don't get called with a stale case handle @@ -139,13 +139,13 @@ public final class OsAccounts implements AutopsyVisitableItem { @Override protected void addNotify() { - Case.addEventTypeSubscriber(EnumSet.of(Case.Events.OS_ACCOUNT_ADDED, Case.Events.OS_ACCOUNT_REMOVED), listener); + Case.addEventTypeSubscriber(EnumSet.of(Case.Events.OS_ACCOUNTS_ADDED, Case.Events.OS_ACCOUNTS_DELETED), listener); Case.addEventTypeSubscriber(EnumSet.of(Case.Events.CURRENT_CASE), listener); } @Override protected void removeNotify() { - Case.removeEventTypeSubscriber(Collections.singleton(Case.Events.OS_ACCOUNT_ADDED), listener); + Case.removeEventTypeSubscriber(Collections.singleton(Case.Events.OS_ACCOUNTS_ADDED), listener); Case.removeEventTypeSubscriber(EnumSet.of(Case.Events.CURRENT_CASE), listener); } @@ -184,10 +184,13 @@ public final class OsAccounts implements AutopsyVisitableItem { @Override public void propertyChange(PropertyChangeEvent evt) { if (evt.getPropertyName().equals(Case.Events.OS_ACCOUNT_CHANGED.name())) { - if (((OsAccountsUpdatedEvent) evt).getOsAccount().getId() == account.getId()) { - // Update the account node to the new one - account = ((OsAccountsUpdatedEvent) evt).getOsAccount(); - updateSheet(); + OsAccountsUpdatedEvent updateEvent = (OsAccountsUpdatedEvent) evt; + for (OsAccount acct : updateEvent.getOsAccounts()) { + if (acct.getId() == account.getId()) { + account = acct; + updateSheet(); + break; + } } } else if (evt.getPropertyName().equals(REALM_DATA_AVAILABLE_EVENT)) { OsAccountRealm realm = (OsAccountRealm) evt.getNewValue(); diff --git a/Core/src/org/sleuthkit/autopsy/datamodel/PersonGroupingNode.java b/Core/src/org/sleuthkit/autopsy/datamodel/PersonGroupingNode.java index 3934ffa06c..736cab3028 100644 --- a/Core/src/org/sleuthkit/autopsy/datamodel/PersonGroupingNode.java +++ b/Core/src/org/sleuthkit/autopsy/datamodel/PersonGroupingNode.java @@ -68,10 +68,9 @@ public class PersonGroupingNode extends DisplayableItemNode { private static final Logger logger = Logger.getLogger(PersonChildren.class.getName()); - private static final Set CHILD_EVENTS = EnumSet.of( - Case.Events.HOSTS_ADDED, + private static final Set CHILD_EVENTS = EnumSet.of(Case.Events.HOSTS_ADDED, Case.Events.HOSTS_DELETED, - Case.Events.PERSONS_CHANGED); + Case.Events.PERSONS_UPDATED); private static final Set CHILD_EVENTS_STR = CHILD_EVENTS.stream() .map(ev -> ev.name()) @@ -145,7 +144,7 @@ public class PersonGroupingNode extends DisplayableItemNode { @Override public void propertyChange(PropertyChangeEvent evt) { String eventType = evt.getPropertyName(); - if (personId != null && eventType.equals(Case.Events.PERSONS_CHANGED.toString()) && evt instanceof PersonsUpdatedEvent) { + if (personId != null && eventType.equals(Case.Events.PERSONS_UPDATED.toString()) && evt instanceof PersonsUpdatedEvent) { ((PersonsUpdatedEvent) evt).getNewValue().stream() .filter(p -> p != null && p.getPersonId() == personId) .findFirst() @@ -192,7 +191,7 @@ public class PersonGroupingNode extends DisplayableItemNode { this.setIconBaseWithExtension(ICON_PATH); this.person = person; this.personId = person == null ? null : person.getPersonId(); - Case.addEventTypeSubscriber(EnumSet.of(Case.Events.PERSONS_CHANGED), + Case.addEventTypeSubscriber(EnumSet.of(Case.Events.PERSONS_UPDATED), WeakListeners.propertyChange(personChangePcl, this)); } diff --git a/Core/src/org/sleuthkit/autopsy/datamodel/hosts/AssociateNewPersonAction.java b/Core/src/org/sleuthkit/autopsy/datamodel/hosts/AssociateNewPersonAction.java index 2cb89995c6..ff86ea65db 100644 --- a/Core/src/org/sleuthkit/autopsy/datamodel/hosts/AssociateNewPersonAction.java +++ b/Core/src/org/sleuthkit/autopsy/datamodel/hosts/AssociateNewPersonAction.java @@ -20,6 +20,7 @@ package org.sleuthkit.autopsy.datamodel.hosts; import java.awt.Frame; import java.awt.event.ActionEvent; +import java.util.Collections; import java.util.logging.Level; import javax.swing.AbstractAction; import javax.swing.JOptionPane; @@ -66,7 +67,7 @@ public class AssociateNewPersonAction extends AbstractAction { newPersonName = getAddDialogName(); if (StringUtils.isNotBlank(newPersonName)) { Person person = Case.getCurrentCaseThrows().getSleuthkitCase().getPersonManager().newPerson(newPersonName); - Case.getCurrentCaseThrows().getSleuthkitCase().getPersonManager().setPerson(host, person); + Case.getCurrentCaseThrows().getSleuthkitCase().getPersonManager().addHostsToPerson(person, Collections.singletonList(host)); } } catch (NoCurrentCaseException | TskCoreException ex) { String hostName = this.host == null || this.host.getName() == null ? "" : this.host.getName(); diff --git a/Core/src/org/sleuthkit/autopsy/datamodel/hosts/AssociatePersonAction.java b/Core/src/org/sleuthkit/autopsy/datamodel/hosts/AssociatePersonAction.java index 70b31a1ac7..e9ca92791e 100644 --- a/Core/src/org/sleuthkit/autopsy/datamodel/hosts/AssociatePersonAction.java +++ b/Core/src/org/sleuthkit/autopsy/datamodel/hosts/AssociatePersonAction.java @@ -19,6 +19,7 @@ package org.sleuthkit.autopsy.datamodel.hosts; import java.awt.event.ActionEvent; +import java.util.Collections; import java.util.logging.Level; import javax.swing.AbstractAction; import javax.swing.JOptionPane; @@ -65,7 +66,7 @@ public class AssociatePersonAction extends AbstractAction { @Override public void actionPerformed(ActionEvent e) { try { - Case.getCurrentCaseThrows().getSleuthkitCase().getPersonManager().setPerson(host, person); + Case.getCurrentCaseThrows().getSleuthkitCase().getPersonManager().addHostsToPerson(person, Collections.singletonList(host)); } catch (NoCurrentCaseException | TskCoreException ex) { String hostName = this.host == null || this.host.getName() == null ? "" : this.host.getName(); String personName = this.person == null || this.person.getName() == null ? "" : this.person.getName(); diff --git a/Core/src/org/sleuthkit/autopsy/datamodel/hosts/RemoveParentPersonAction.java b/Core/src/org/sleuthkit/autopsy/datamodel/hosts/RemoveParentPersonAction.java index c8ae974bb0..f83d3bd874 100644 --- a/Core/src/org/sleuthkit/autopsy/datamodel/hosts/RemoveParentPersonAction.java +++ b/Core/src/org/sleuthkit/autopsy/datamodel/hosts/RemoveParentPersonAction.java @@ -19,6 +19,7 @@ package org.sleuthkit.autopsy.datamodel.hosts; import java.awt.event.ActionEvent; +import java.util.Collections; import java.util.logging.Level; import javax.swing.AbstractAction; import javax.swing.JOptionPane; @@ -46,6 +47,7 @@ public class RemoveParentPersonAction extends AbstractAction { private static final Logger logger = Logger.getLogger(RemoveParentPersonAction.class.getName()); + private final Person person; private final Host host; /** @@ -59,12 +61,13 @@ public class RemoveParentPersonAction extends AbstractAction { person == null || person.getName() == null ? Bundle.RemoveParentPersonAction_unknownPerson() : person.getName())); this.host = host; + this.person = person; } @Override public void actionPerformed(ActionEvent e) { try { - Case.getCurrentCaseThrows().getSleuthkitCase().getPersonManager().setPerson(host, null); + Case.getCurrentCaseThrows().getSleuthkitCase().getPersonManager().removeHostsFromPerson(person, Collections.singletonList(host)); } catch (NoCurrentCaseException | TskCoreException ex) { String hostName = this.host == null || this.host.getName() == null ? "" : this.host.getName(); logger.log(Level.WARNING, String.format("Unable to remove parent from host: %s", hostName), ex); diff --git a/Core/src/org/sleuthkit/autopsy/events/AutopsyEvent.java b/Core/src/org/sleuthkit/autopsy/events/AutopsyEvent.java index c329a03549..7c3a16e5a3 100644 --- a/Core/src/org/sleuthkit/autopsy/events/AutopsyEvent.java +++ b/Core/src/org/sleuthkit/autopsy/events/AutopsyEvent.java @@ -1,7 +1,7 @@ /* * Autopsy Forensic Browser * - * Copyright 2015 Basis Technology Corp. + * Copyright 2015-2021 Basis Technology Corp. * Contact: carrier sleuthkit org * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -22,12 +22,18 @@ import java.beans.PropertyChangeEvent; import java.io.Serializable; /** - * A base class for events to be published to registered subscribers on both - * this Autopsy node and other Autopsy nodes. The class extends - * PropertyChangeEvent to integrate with legacy use of JavaBeans - * PropertyChangeEvents and PropertyChangeListeners as an application event - * system, and implements Serializable to allow it to be published over a - * network in serialized form. + * A base class for application events that can be published to registered + * subscribers on both this Autopsy node and other Autopsy nodes. + * + * The class extends PropertyChangeEvent to integrate with legacy use of + * JavaBeans PropertyChangeEvents and PropertyChangeListeners as an application + * event publisher-subcriber mechanism. Subclasses need to decide what + * constitutes "old" and "new" objects for them and are encouraged to provide + * getters for these values that do not require clients to cast the return + * values. + * + * This class implements Serializable to allow it to be published over a network + * in serialized form. */ public class AutopsyEvent extends PropertyChangeEvent implements Serializable { @@ -36,17 +42,22 @@ public class AutopsyEvent extends PropertyChangeEvent implements Serializable { /** * Events have a source field set to local or remote to allow event - * subscribers to filter events by source type. + * subscribers to filter events by source type. For a multi-user case, a + * local event has happened on this Autopsy node, and a remote event has + * happened on another Autopsy node. + * + * Events are local by default and are changed to remote events by the event + * publishers on other Autopsy nodes upon event receipt. */ public enum SourceType { - LOCAL, REMOTE }; /** - * Constructs an event that can be published to registered subscribers on - * both this Autopsy node and other Autopsy nodes. + * Constructs the base class part of an application event that can be + * published to registered subscribers on both this Autopsy node and other + * Autopsy nodes. * * @param eventName The event name. * @param oldValue The "old" value to associate with the event. May be @@ -60,7 +71,7 @@ public class AutopsyEvent extends PropertyChangeEvent implements Serializable { } /** - * Gets the source type (local or remote). + * Gets the event source type (local or remote). * * @return SourceType The source type of the event, local or remote. */ @@ -69,12 +80,9 @@ public class AutopsyEvent extends PropertyChangeEvent implements Serializable { } /** - * Gets the source type (local or remote) as a string. This is for clients - * that do not have access to the AutopsyEvent type, and is necessary - * because the events package is not currently a public package within the - * Autopsy-Core NetBeans Module (NBM). + * Gets the event source type (local or remote) as a string. * - * @return A string, either "LOCAL" or "REMOTE", as an Object. + * @return A string, either "LOCAL" or "REMOTE." */ @Override public Object getSource() { @@ -82,10 +90,10 @@ public class AutopsyEvent extends PropertyChangeEvent implements Serializable { } /** - * Sets the source type (local or remote). This field is mutable in this way - * to allow an event to be published both locally and remotely without - * requiring the construction of two separate objects. It is for use by the - * event publishing classes within this package only. + * Sets the source type (local or remote). This field is mutable to allow an + * event to be published both locally and remotely without requiring the + * construction of two separate objects. It is for use by the event + * publishing classes within this package only. * * @param sourceType The source type of the event, local or remote. */ From 0ee586196f5fd7de832f7a2df0322d05d629d550 Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Tue, 4 May 2021 14:24:24 -0400 Subject: [PATCH 005/326] 7553 data model event changes --- .../sleuthkit/autopsy/casemodule/Case.java | 26 +++++++++---------- .../events/OsAccountsUpdatedEvent.java | 2 +- .../autopsy/datamodel/OsAccounts.java | 4 +-- 3 files changed, 15 insertions(+), 17 deletions(-) diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/Case.java b/Core/src/org/sleuthkit/autopsy/casemodule/Case.java index 06809bffa8..f18c600942 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/Case.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/Case.java @@ -429,49 +429,47 @@ public class Case { */ CR_COMMENT_CHANGED, /** - * OSAccount associated with the current case added. Call getOsAccount - * to get the added account; + * One or more OS accounts have been added to the case. */ OS_ACCOUNTS_ADDED, /** - * OSAccount associated with the current case has changed. Call - * getOsAccount to get the changed account; + * One or more OS accounts in the case have been updated. */ - OS_ACCOUNT_CHANGED, + OS_ACCOUNTS_UPDATED, /** - * OSAccount associated with the current case has been deleted. + * One or more OS accounts have been deleted from the case. */ OS_ACCOUNTS_DELETED, /** - * Hosts associated with the current case added. + * One or more hosts have been added to the case. */ HOSTS_ADDED, /** - * Hosts associated with the current case has changed. + * One or more hosts in the case have been updated. */ HOSTS_UPDATED, /** - * Hosts associated with the current case has been deleted. + * One or more hosts have been deleted from the case. */ HOSTS_DELETED, /** - * Persons associated with the current case added. + * One or more persons have been added to the case. */ PERSONS_ADDED, /** - * Persons associated with the current case has changed. + * One or more persons in the case have been updated. */ PERSONS_UPDATED, /** - * Persons associated with the current case has been deleted. + * One or more hosts persons been deleted from the case. */ PERSONS_DELETED, /** - * Hosts have been added to a person. + * One or more hosts have been added to a person. */ HOSTS_ADDED_TO_PERSON, /** - * Hosts have been removed from a person. + * One or more hosts have been removed from a person. */ HOSTS_REMOVED_FROM_PERSON; diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsUpdatedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsUpdatedEvent.java index 9795f055d6..65767ccdfc 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsUpdatedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/OsAccountsUpdatedEvent.java @@ -37,7 +37,7 @@ public final class OsAccountsUpdatedEvent extends OsAccountsEvent { * @param osAccounts The OS accounts that were updated. */ public OsAccountsUpdatedEvent(List osAccounts) { - super(Case.Events.OS_ACCOUNT_CHANGED.toString(), osAccounts); + super(Case.Events.OS_ACCOUNTS_UPDATED.toString(), osAccounts); } } diff --git a/Core/src/org/sleuthkit/autopsy/datamodel/OsAccounts.java b/Core/src/org/sleuthkit/autopsy/datamodel/OsAccounts.java index 9472a65616..322ac8cddb 100755 --- a/Core/src/org/sleuthkit/autopsy/datamodel/OsAccounts.java +++ b/Core/src/org/sleuthkit/autopsy/datamodel/OsAccounts.java @@ -183,7 +183,7 @@ public final class OsAccounts implements AutopsyVisitableItem { private final PropertyChangeListener listener = new PropertyChangeListener() { @Override public void propertyChange(PropertyChangeEvent evt) { - if (evt.getPropertyName().equals(Case.Events.OS_ACCOUNT_CHANGED.name())) { + if (evt.getPropertyName().equals(Case.Events.OS_ACCOUNTS_UPDATED.name())) { OsAccountsUpdatedEvent updateEvent = (OsAccountsUpdatedEvent) evt; for (OsAccount acct : updateEvent.getOsAccounts()) { if (acct.getId() == account.getId()) { @@ -224,7 +224,7 @@ public final class OsAccounts implements AutopsyVisitableItem { setDisplayName(account.getName()); setIconBaseWithExtension(ICON_PATH); - Case.addEventTypeSubscriber(Collections.singleton(Case.Events.OS_ACCOUNT_CHANGED), weakListener); + Case.addEventTypeSubscriber(Collections.singleton(Case.Events.OS_ACCOUNTS_UPDATED), weakListener); } @Override From 92cba46d6d0ed26d2f40498ea79c93a6bdb3b8da Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Tue, 4 May 2021 15:07:51 -0400 Subject: [PATCH 006/326] 7553 data model event changes --- .../sleuthkit/autopsy/casemodule/Case.java | 13 ++++++ .../events/HostsAddedToPersonEvent.java | 18 +++++--- .../events/HostsRemovedFromPersonEvent.java | 40 ++++++++++++---- .../casemodule/events/PersonHostsEvent.java | 46 ++++++++++--------- 4 files changed, 80 insertions(+), 37 deletions(-) diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/Case.java b/Core/src/org/sleuthkit/autopsy/casemodule/Case.java index f18c600942..0274dd7c23 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/Case.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/Case.java @@ -84,8 +84,10 @@ import org.sleuthkit.autopsy.casemodule.events.DataSourceAddedEvent; import org.sleuthkit.autopsy.casemodule.events.DataSourceDeletedEvent; import org.sleuthkit.autopsy.casemodule.events.DataSourceNameChangedEvent; import org.sleuthkit.autopsy.casemodule.events.HostsAddedEvent; +import org.sleuthkit.autopsy.casemodule.events.HostsAddedToPersonEvent; import org.sleuthkit.autopsy.casemodule.events.HostsUpdatedEvent; import org.sleuthkit.autopsy.casemodule.events.HostsDeletedEvent; +import org.sleuthkit.autopsy.casemodule.events.HostsRemovedFromPersonEvent; import org.sleuthkit.autopsy.casemodule.events.OsAccountsAddedEvent; import org.sleuthkit.autopsy.casemodule.events.OsAccountsUpdatedEvent; import org.sleuthkit.autopsy.casemodule.events.OsAccountsDeletedEvent; @@ -586,6 +588,17 @@ public class Case { public void publishPersonsDeletedEvent(TskEvent.PersonsDeletedTskEvent event) { eventPublisher.publish(new PersonsDeletedEvent(event.getPersonIds())); } + + @Subscribe + public void publishHostsAddedToPersonEvent(TskEvent.HostsAddedToPersonTskEvent event) { + eventPublisher.publish(new HostsAddedToPersonEvent(event.getPerson(), event.getHosts())); + } + + @Subscribe + public void publisHostsRemovedFromPersonEvent(TskEvent.HostsRemovedFromPersonTskEvent event) { + eventPublisher.publish(new HostsRemovedFromPersonEvent(event.getPerson(), event.getHosts())); + } + } /** diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedToPersonEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedToPersonEvent.java index 8b1b9da8a3..a7937330d2 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedToPersonEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedToPersonEvent.java @@ -18,22 +18,28 @@ */ package org.sleuthkit.autopsy.casemodule.events; -import java.util.Collections; import java.util.List; import org.sleuthkit.autopsy.casemodule.Case; import org.sleuthkit.datamodel.Host; import org.sleuthkit.datamodel.Person; /** - * - * @author rcordovano + * Application events published when one or more hosts have been added to a + * person. */ public final class HostsAddedToPersonEvent extends PersonHostsEvent { - + private static final long serialVersionUID = 1L; - + + /** + * Constructs an application event published when one or more hosts have + * been added to a person. + * + * @param person The person. + * @param hosts The hosts. + */ HostsAddedToPersonEvent(Person person, List hosts) { super(Case.Events.HOSTS_ADDED_TO_PERSON.toString(), person, hosts); } - + } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsRemovedFromPersonEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsRemovedFromPersonEvent.java index eaf200368d..df84e0bbaa 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsRemovedFromPersonEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsRemovedFromPersonEvent.java @@ -1,7 +1,20 @@ /* - * To change this license header, choose License Headers in Project Properties. - * To change this template file, choose Tools | Templates - * and open the template in the editor. + * Autopsy Forensic Browser + * + * Copyright 2021 Basis Technology Corp. + * Contact: carrier sleuthkit org + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ package org.sleuthkit.autopsy.casemodule.events; @@ -11,15 +24,22 @@ import org.sleuthkit.datamodel.Host; import org.sleuthkit.datamodel.Person; /** - * - * @author rcordovano + * Application events published when one or more hosts have been removed from a + * person. */ -public class HostsRemovedFromPersonEvent extends PersonHostsEvent { - +public class HostsRemovedFromPersonEvent extends PersonHostsEvent { + private static final long serialVersionUID = 1L; - + + /** + * Constructs an application event published when one or more hosts have + * been removed from a person. + * + * @param person The person. + * @param hosts The hosts. + */ HostsRemovedFromPersonEvent(Person person, List hosts) { super(Case.Events.HOSTS_REMOVED_FROM_PERSON.toString(), person, hosts); } - -} \ No newline at end of file + +} diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonHostsEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonHostsEvent.java index f1426e38e4..edf0f8b65d 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonHostsEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/PersonHostsEvent.java @@ -15,37 +15,41 @@ import org.sleuthkit.datamodel.SleuthkitCase; import org.sleuthkit.datamodel.TskCoreException; /** - * - * @author rcordovano + * An abstract super class for person and host association change events. */ public abstract class PersonHostsEvent extends TskDataModelChangedEvent { - + private static final long serialVersionUID = 1L; - + /** - * - * @param eventName - * @param person - * @param hosts + * Constructs the abstract super class part of a person and host association + * change event. + * + * @param eventName The name of the Case.Events enum value for the event + * type. + * @param person The person that is the subject of the event. + * @param hosts The hosts that are the subject of the event. */ PersonHostsEvent(String eventName, Person person, List hosts) { super(eventName, Collections.singletonList(person), Person::getPersonId, hosts, Host::getHostId); } - + /** - * - * @return + * Gets the person. + * + * @return The person. */ - Person getPerson() { + public Person getPerson() { return getOldValue().get(0); } - + /** - * - * @return + * Gets the hosts. + * + * @return The hosts. */ - List getHosts() { - return getNewValue(); + public List getHosts() { + return getNewValue(); } @Override @@ -58,8 +62,8 @@ public abstract class PersonHostsEvent extends TskDataModelChangedEvent getNewValueObjects(SleuthkitCase caseDb, List ids) throws TskCoreException { List hosts = new ArrayList<>(); @@ -70,6 +74,6 @@ public abstract class PersonHostsEvent extends TskDataModelChangedEvent Date: Tue, 4 May 2021 15:21:57 -0400 Subject: [PATCH 007/326] 7553 data model event changes --- .../autopsy/casemodule/events/HostsAddedToPersonEvent.java | 2 +- .../autopsy/casemodule/events/HostsRemovedFromPersonEvent.java | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedToPersonEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedToPersonEvent.java index a7937330d2..7bee69fd24 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedToPersonEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedToPersonEvent.java @@ -38,7 +38,7 @@ public final class HostsAddedToPersonEvent extends PersonHostsEvent { * @param person The person. * @param hosts The hosts. */ - HostsAddedToPersonEvent(Person person, List hosts) { + public HostsAddedToPersonEvent(Person person, List hosts) { super(Case.Events.HOSTS_ADDED_TO_PERSON.toString(), person, hosts); } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsRemovedFromPersonEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsRemovedFromPersonEvent.java index df84e0bbaa..2d51cbba5b 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsRemovedFromPersonEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsRemovedFromPersonEvent.java @@ -38,7 +38,7 @@ public class HostsRemovedFromPersonEvent extends PersonHostsEvent { * @param person The person. * @param hosts The hosts. */ - HostsRemovedFromPersonEvent(Person person, List hosts) { + public HostsRemovedFromPersonEvent(Person person, List hosts) { super(Case.Events.HOSTS_REMOVED_FROM_PERSON.toString(), person, hosts); } From 98ea5d2bc967aa0efd12f49018e85e5f0d64c4f2 Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Fri, 7 May 2021 12:06:27 -0400 Subject: [PATCH 008/326] 7553 data model event changes --- Core/src/org/sleuthkit/autopsy/casemodule/Case.java | 2 +- .../sleuthkit/autopsy/casemodule/events/HostsAddedEvent.java | 4 ++-- .../org/sleuthkit/autopsy/casemodule/events/HostsEvent.java | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/Case.java b/Core/src/org/sleuthkit/autopsy/casemodule/Case.java index 0274dd7c23..b477b11ea4 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/Case.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/Case.java @@ -463,7 +463,7 @@ public class Case { */ PERSONS_UPDATED, /** - * One or more hosts persons been deleted from the case. + * One or more persons been deleted from the case. */ PERSONS_DELETED, /** diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedEvent.java index bf355b66b7..b598c375d6 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedEvent.java @@ -23,7 +23,7 @@ import org.sleuthkit.autopsy.casemodule.Case; import org.sleuthkit.datamodel.Host; /** - * An application event published when hosts have been added to the Sleuth Kit + * Application events published when hosts have been added to the Sleuth Kit * data model for a case. */ public final class HostsAddedEvent extends HostsEvent { @@ -39,5 +39,5 @@ public final class HostsAddedEvent extends HostsEvent { public HostsAddedEvent(List hosts) { super(Case.Events.HOSTS_ADDED.name(), hosts); } - + } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsEvent.java index 1ac350c272..465d265083 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsEvent.java @@ -41,7 +41,7 @@ public class HostsEvent extends TskDataModelChangedEvent { * type. * @param hosts The hosts. */ - protected HostsEvent(String eventName, List hosts) { + HostsEvent(String eventName, List hosts) { super(eventName, null, null, hosts, Host::getHostId); } From 90fc3c7153f0d15321bb5cb73aa9af5a552e83f8 Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Mon, 10 May 2021 10:29:35 -0400 Subject: [PATCH 009/326] 7553 data model event changes --- .../sleuthkit/autopsy/casemodule/events/HostsAddedEvent.java | 2 +- .../autopsy/casemodule/events/TskDataModelChangedEvent.java | 2 +- Core/src/org/sleuthkit/autopsy/datamodel/HostNode.java | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedEvent.java index b598c375d6..f188c7d5a3 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/HostsAddedEvent.java @@ -34,7 +34,7 @@ public final class HostsAddedEvent extends HostsEvent { * Constructs an application event published when hosts have been added to * the Sleuth Kit data model for a case. * - * @param persons The hosts that have been added. + * @param hosts The hosts that have been added. */ public HostsAddedEvent(List hosts) { super(Case.Events.HOSTS_ADDED.name(), hosts); diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangedEvent.java b/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangedEvent.java index 07ed7166d7..83ced035fc 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangedEvent.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/events/TskDataModelChangedEvent.java @@ -103,7 +103,7 @@ public abstract class TskDataModelChangedEvent extends AutopsyEvent { } newValueIds = new ArrayList<>(); this.newValueObjects = new ArrayList<>(); - if (oldValueObjects != null) { + if (newValueObjects != null) { hasNewValue = true; newValueIds.addAll(newValueObjects.stream() .map(o -> newValueGetIdMethod.apply(o)) diff --git a/Core/src/org/sleuthkit/autopsy/datamodel/HostNode.java b/Core/src/org/sleuthkit/autopsy/datamodel/HostNode.java index 644e2b6b80..99b0461112 100644 --- a/Core/src/org/sleuthkit/autopsy/datamodel/HostNode.java +++ b/Core/src/org/sleuthkit/autopsy/datamodel/HostNode.java @@ -178,7 +178,7 @@ public class HostNode extends DisplayableItemNode { public void propertyChange(PropertyChangeEvent evt) { String eventType = evt.getPropertyName(); if (hostId != null && eventType.equals(Case.Events.HOSTS_UPDATED.toString()) && evt instanceof HostsUpdatedEvent) { - ((HostsUpdatedEvent) evt).getNewValue().stream() + ((HostsUpdatedEvent) evt).getHosts().stream() .filter(h -> h != null && h.getHostId() == hostId) .findFirst() .ifPresent((newHost) -> { From 2e1cd9d4b1913b664443066a3a658e59891e6367 Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Tue, 11 May 2021 09:38:18 -0400 Subject: [PATCH 010/326] 7553 data model event changes --- .../org/sleuthkit/autopsy/datamodel/PersonGroupingNode.java | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Core/src/org/sleuthkit/autopsy/datamodel/PersonGroupingNode.java b/Core/src/org/sleuthkit/autopsy/datamodel/PersonGroupingNode.java index 736cab3028..eccf0eb18a 100644 --- a/Core/src/org/sleuthkit/autopsy/datamodel/PersonGroupingNode.java +++ b/Core/src/org/sleuthkit/autopsy/datamodel/PersonGroupingNode.java @@ -69,8 +69,11 @@ public class PersonGroupingNode extends DisplayableItemNode { private static final Logger logger = Logger.getLogger(PersonChildren.class.getName()); private static final Set CHILD_EVENTS = EnumSet.of(Case.Events.HOSTS_ADDED, + Case.Events.HOSTS_ADDED, Case.Events.HOSTS_DELETED, - Case.Events.PERSONS_UPDATED); + Case.Events.PERSONS_UPDATED, + Case.Events.HOSTS_ADDED_TO_PERSON, + Case.Events.HOSTS_REMOVED_FROM_PERSON); private static final Set CHILD_EVENTS_STR = CHILD_EVENTS.stream() .map(ev -> ev.name()) From f76469a43564a5ba388ed5366953f42f27c69eed Mon Sep 17 00:00:00 2001 From: Seb2lyon Date: Wed, 12 May 2021 05:33:11 +0200 Subject: [PATCH 011/326] Create the doxygen-user_fr directory and translate : configuration, installation and performance pages --- docs/doxygen-user_fr/Doxyfile | 2366 +++++++++++++++++ docs/doxygen-user_fr/EXIF_parser_page.dox | 28 + docs/doxygen-user_fr/README.txt | 4 + docs/doxygen-user_fr/adHocKeywordSearch.dox | 105 + docs/doxygen-user_fr/aleapp.dox | 20 + docs/doxygen-user_fr/android_analyzer.dox | 63 + docs/doxygen-user_fr/archive_extractor.dox | 47 + docs/doxygen-user_fr/auto_ingest.dox | 97 + .../auto_ingest_administration.dox | 94 + docs/doxygen-user_fr/auto_ingest_setup.dox | 112 + docs/doxygen-user_fr/case_management.dox | 56 + docs/doxygen-user_fr/central_repo.dox | 243 ++ docs/doxygen-user_fr/command_line_ingest.dox | 208 ++ docs/doxygen-user_fr/common_files.dox | 72 + docs/doxygen-user_fr/communications.dox | 83 + docs/doxygen-user_fr/configuration.dox | 61 + docs/doxygen-user_fr/content_viewer.dox | 117 + .../doxygen-user_fr/data_source_integrity.dox | 54 + docs/doxygen-user_fr/data_source_summary.dox | 89 + docs/doxygen-user_fr/data_sources.dox | 154 ++ docs/doxygen-user_fr/drone.dox | 35 + docs/doxygen-user_fr/email_parser.dox | 39 + docs/doxygen-user_fr/encryption_detection.dox | 43 + docs/doxygen-user_fr/experimental.dox | 16 + docs/doxygen-user_fr/extension_mismatch.dox | 42 + docs/doxygen-user_fr/file_discovery.dox | 236 ++ docs/doxygen-user_fr/file_export.dox | 72 + docs/doxygen-user_fr/file_search.dox | 44 + docs/doxygen-user_fr/filetype.dox | 46 + docs/doxygen-user_fr/footer.html | 7 + docs/doxygen-user_fr/geolocation.dox | 152 ++ docs/doxygen-user_fr/gpx.dox | 52 + docs/doxygen-user_fr/hashdb_lookup.dox | 112 + docs/doxygen-user_fr/hosts.dox | 50 + docs/doxygen-user_fr/ileapp.dox | 20 + docs/doxygen-user_fr/image_gallery.dox | 125 + .../images/AutoIngest/admin_file.png | Bin 0 -> 31551 bytes .../images/AutoIngest/admin_jobs_cancel.png | Bin 0 -> 8331 bytes .../AutoIngest/admin_jobs_completed.png | Bin 0 -> 10504 bytes .../images/AutoIngest/admin_jobs_panel.png | Bin 0 -> 13546 bytes .../images/AutoIngest/admin_nodes_panel.png | Bin 0 -> 12103 bytes .../images/AutoIngest/advanced_settings.png | Bin 0 -> 28132 bytes .../AutoIngest/auto_ingest_in_progress.png | Bin 0 -> 51766 bytes .../AutoIngest/auto_ingest_mode_setup.png | Bin 0 -> 46389 bytes .../images/AutoIngest/case_delete_confirm.png | Bin 0 -> 12456 bytes .../images/AutoIngest/cases_context_menu.png | Bin 0 -> 11843 bytes .../images/AutoIngest/cases_panel.png | Bin 0 -> 54901 bytes .../images/AutoIngest/error_suppression.png | Bin 0 -> 78699 bytes .../images/AutoIngest/examiner_dashboard.png | Bin 0 -> 67864 bytes .../AutoIngest/file_export_dir_structure.png | Bin 0 -> 16888 bytes .../AutoIngest/file_export_encrypton.png | Bin 0 -> 18529 bytes .../AutoIngest/file_export_file_loc.png | Bin 0 -> 8712 bytes .../AutoIngest/file_export_json_loc.png | Bin 0 -> 9274 bytes .../images/AutoIngest/file_export_keyword.png | Bin 0 -> 16892 bytes .../images/AutoIngest/file_export_png.png | Bin 0 -> 16041 bytes .../images/AutoIngest/file_export_size.png | Bin 0 -> 16532 bytes .../images/AutoIngest/file_exporter_main.png | Bin 0 -> 42047 bytes .../images/AutoIngest/health_monitor.png | Bin 0 -> 162443 bytes .../AutoIngest/health_monitor_disabled.png | Bin 0 -> 7582 bytes .../manifest_file_in_file_explorer.png | Bin 0 -> 8428 bytes .../AutoIngest/manifest_tool_root_folder.png | Bin 0 -> 20568 bytes .../images/AutoIngest/manifest_tool_ui.png | Bin 0 -> 18789 bytes .../images/AutoIngest/master_node.png | Bin 0 -> 16363 bytes .../images/AutoIngest/metrics.png | Bin 0 -> 10922 bytes .../AutoIngest/no_periodic_searches.png | Bin 0 -> 47172 bytes .../images/AutoIngest/overview_pic1.png | Bin 0 -> 82173 bytes .../images/AutoIngest/overview_pic2.png | Bin 0 -> 173128 bytes .../images/AutoIngest/test_button_failure.png | Bin 0 -> 4636 bytes .../DataSourceSummary/ds_summary_analysis.png | Bin 0 -> 16843 bytes .../ds_summary_container.png | Bin 0 -> 25109 bytes .../DataSourceSummary/ds_summary_export.png | Bin 0 -> 6730 bytes .../DataSourceSummary/ds_summary_geo.png | Bin 0 -> 29783 bytes .../DataSourceSummary/ds_summary_ingest.png | Bin 0 -> 33151 bytes .../DataSourceSummary/ds_summary_noRA.png | Bin 0 -> 4912 bytes .../ds_summary_past_cases.png | Bin 0 -> 17122 bytes .../ds_summary_recent_files.png | Bin 0 -> 32807 bytes .../ds_summary_result_viewer.png | Bin 0 -> 76590 bytes .../DataSourceSummary/ds_summary_timeline.png | Bin 0 -> 18376 bytes .../DataSourceSummary/ds_summary_types.png | Bin 0 -> 48624 bytes .../ds_summary_user_activity.png | Bin 0 -> 28675 bytes .../DataSourceSummary/ds_summary_window.png | Bin 0 -> 57034 bytes docs/doxygen-user_fr/images/EXIF-heic.png | Bin 0 -> 217710 bytes docs/doxygen-user_fr/images/EXIF-tree.PNG | Bin 0 -> 48979 bytes .../FileDiscovery/fd_dataSourceFilter.png | Bin 0 -> 4898 bytes .../images/FileDiscovery/fd_dateFilter.png | Bin 0 -> 7562 bytes .../images/FileDiscovery/fd_documents.png | Bin 0 -> 95281 bytes .../images/FileDiscovery/fd_domainDetails.png | Bin 0 -> 51738 bytes .../FileDiscovery/fd_domainResultFilter.png | Bin 0 -> 7467 bytes .../images/FileDiscovery/fd_domains.png | Bin 0 -> 79989 bytes .../images/FileDiscovery/fd_dupeEx.png | Bin 0 -> 198237 bytes .../FileDiscovery/fd_fileSizeFilter.png | Bin 0 -> 6405 bytes .../images/FileDiscovery/fd_fileType.png | Bin 0 -> 9694 bytes .../images/FileDiscovery/fd_grouping.png | Bin 0 -> 11535 bytes .../images/FileDiscovery/fd_groupingInt.png | Bin 0 -> 2193 bytes .../images/FileDiscovery/fd_groupingSize.png | Bin 0 -> 3060 bytes .../images/FileDiscovery/fd_hashSetFilter.png | Bin 0 -> 2999 bytes .../images/FileDiscovery/fd_icon.png | Bin 0 -> 162305 bytes .../FileDiscovery/fd_instanceContext.png | Bin 0 -> 79640 bytes .../fd_interestingItemsFilter.png | Bin 0 -> 3528 bytes .../FileDiscovery/fd_knownAccountFilter.png | Bin 0 -> 2048 bytes .../images/FileDiscovery/fd_loadSettings.png | Bin 0 -> 12107 bytes .../images/FileDiscovery/fd_main.png | Bin 0 -> 406288 bytes .../images/FileDiscovery/fd_notableFilter.png | Bin 0 -> 1878 bytes .../images/FileDiscovery/fd_objectFilter.png | Bin 0 -> 4904 bytes .../images/FileDiscovery/fd_paging.png | Bin 0 -> 109569 bytes .../images/FileDiscovery/fd_parentEx2.png | Bin 0 -> 3028 bytes .../images/FileDiscovery/fd_parentFilter.png | Bin 0 -> 6733 bytes .../images/FileDiscovery/fd_pastOccur.png | Bin 0 -> 6600 bytes .../images/FileDiscovery/fd_resultGroups.png | Bin 0 -> 270439 bytes .../images/FileDiscovery/fd_setup.png | Bin 0 -> 56218 bytes .../FileDiscovery/fd_userContentArtifact.png | Bin 0 -> 23080 bytes .../FileDiscovery/fd_userCreatedFilter.png | Bin 0 -> 1473 bytes .../images/FileDiscovery/fd_videos.png | Bin 0 -> 426858 bytes .../FileDiscovery/file-icon-deleted.png | Bin 0 -> 636 bytes .../FileDiscovery/red-circle-exclamation.png | Bin 0 -> 314 bytes .../FileDiscovery/yellow-circle-yield.png | Bin 0 -> 578 bytes .../ImageGallery/application_view_tile.PNG | Bin 0 -> 465 bytes .../images/ImageGallery/bisque.PNG | Bin 0 -> 276 bytes .../images/ImageGallery/drawabletile.PNG | Bin 0 -> 21419 bytes .../images/ImageGallery/flag_gray.PNG | Bin 0 -> 15505 bytes .../images/ImageGallery/flag_red.PNG | Bin 0 -> 665 bytes .../images/ImageGallery/folder_picture.PNG | Bin 0 -> 713 bytes .../images/ImageGallery/gray.PNG | Bin 0 -> 280 bytes .../images/ImageGallery/green.PNG | Bin 0 -> 276 bytes .../images/ImageGallery/hashset_hits.PNG | Bin 0 -> 1451 bytes .../images/ImageGallery/orange.PNG | Bin 0 -> 276 bytes .../images/ImageGallery/purpledash.PNG | Bin 0 -> 445 bytes .../images/ImageGallery/red.PNG | Bin 0 -> 276 bytes .../images/ImageGallery/slide.PNG | Bin 0 -> 620 bytes .../images/ImageGallery/video-file.PNG | Bin 0 -> 718 bytes .../images/ImageGallery/yellow.PNG | Bin 0 -> 276 bytes .../images/InterestingFiles/bomb_png.png | Bin 0 -> 23271 bytes .../InterestingFiles/download_archive.png | Bin 0 -> 23544 bytes .../images/InterestingFiles/if_create_set.png | Bin 0 -> 8947 bytes .../images/InterestingFiles/if_export.png | Bin 0 -> 22941 bytes .../images/InterestingFiles/if_new_rule.png | Bin 0 -> 23381 bytes .../if_official_rule_details.png | Bin 0 -> 77029 bytes .../images/InterestingFiles/ingest.png | Bin 0 -> 69834 bytes .../images/InterestingFiles/main.png | Bin 0 -> 71819 bytes .../InterestingFiles/new_large_files.png | Bin 0 -> 24102 bytes .../images/InterestingFiles/new_rule.png | Bin 0 -> 22696 bytes .../images/InterestingFiles/new_rule_set.png | Bin 0 -> 9392 bytes .../InterestingFiles/private_folder.png | Bin 0 -> 22816 bytes .../images/InterestingFiles/results.png | Bin 0 -> 97994 bytes docs/doxygen-user_fr/images/JRE_bitness.PNG | Bin 0 -> 5270 bytes .../images/LogicalImager/VHDfolder.png | Bin 0 -> 19161 bytes .../images/LogicalImager/command_prompt.png | Bin 0 -> 17049 bytes .../images/LogicalImager/config_flag.png | Bin 0 -> 679 bytes .../images/LogicalImager/configure_drive.png | Bin 0 -> 42258 bytes .../images/LogicalImager/dsp_select.png | Bin 0 -> 42067 bytes .../images/LogicalImager/exe_folder.png | Bin 0 -> 6565 bytes .../images/LogicalImager/fileTree.png | Bin 0 -> 29503 bytes .../images/LogicalImager/full_path_rule.png | Bin 0 -> 17204 bytes .../images/LogicalImager/image_flag.png | Bin 0 -> 575 bytes .../images/LogicalImager/import.png | Bin 0 -> 44047 bytes .../images/LogicalImager/interestingFiles.png | Bin 0 -> 32686 bytes .../LogicalImager/main_config_panel.png | Bin 0 -> 52795 bytes .../images/LogicalImager/new_attr_rule.png | Bin 0 -> 37044 bytes .../images/LogicalImager/nonVHDexport.png | Bin 0 -> 27438 bytes .../images/LogicalImager/nonVHDfolder.png | Bin 0 -> 16176 bytes .../images/LogicalImager/output_folder.png | Bin 0 -> 9409 bytes .../images/LogicalImager/save.png | Bin 0 -> 27127 bytes .../images/LogicalImager/select_folder.png | Bin 0 -> 30440 bytes .../images/LogicalImager/tools_menu.png | Bin 0 -> 16797 bytes .../images/Personas/persona_edit.png | Bin 0 -> 21913 bytes .../images/Personas/personas_calllog.png | Bin 0 -> 65752 bytes .../Personas/personas_contact_found.png | Bin 0 -> 73102 bytes .../Personas/personas_contact_not_found.png | Bin 0 -> 10129 bytes .../images/Personas/personas_create.png | Bin 0 -> 25135 bytes .../Personas/personas_create_account.png | Bin 0 -> 4587 bytes .../images/Personas/personas_cvt_accounts.png | Bin 0 -> 58531 bytes .../images/Personas/personas_cvt_hover.png | Bin 0 -> 10563 bytes .../images/Personas/personas_main.png | Bin 0 -> 38400 bytes .../images/Personas/personas_message.png | Bin 0 -> 63477 bytes .../images/StartActiveMQService.PNG | Bin 0 -> 9672 bytes .../images/StopActiveMQService.PNG | Bin 0 -> 19399 bytes .../images/activeMQ_node_cleanup.png | Bin 0 -> 36714 bytes docs/doxygen-user_fr/images/activemq.PNG | Bin 0 -> 104217 bytes .../images/add-data-source.PNG | Bin 0 -> 1005 bytes docs/doxygen-user_fr/images/aleapp_main.jpg | Bin 0 -> 100492 bytes .../images/android_analyzer_output.PNG | Bin 0 -> 37166 bytes .../images/apachebadmessage.PNG | Bin 0 -> 3566 bytes docs/doxygen-user_fr/images/case-newcase.PNG | Bin 0 -> 25810 bytes .../images/case_properties.png | Bin 0 -> 25498 bytes .../images/central_repo_content_viewer.png | Bin 0 -> 24594 bytes .../images/central_repo_details.png | Bin 0 -> 28936 bytes .../images/central_repo_ingest_settings.png | Bin 0 -> 26385 bytes .../images/central_repo_interesting_items.png | Bin 0 -> 6477 bytes .../images/central_repo_manage_tags.png | Bin 0 -> 11196 bytes .../images/central_repo_new_org.png | Bin 0 -> 8711 bytes .../images/central_repo_options.png | Bin 0 -> 58107 bytes .../images/central_repo_orgs.png | Bin 0 -> 16137 bytes .../images/central_repo_postgres.png | Bin 0 -> 12123 bytes .../images/central_repo_sqlite.png | Bin 0 -> 13640 bytes .../images/central_repo_tag_file.png | Bin 0 -> 45422 bytes .../images/central_repo_types.png | Bin 0 -> 16687 bytes .../change_logical_file_set_display_name.PNG | Bin 0 -> 30635 bytes .../images/command_line_ingest_bin_dir.png | Bin 0 -> 4012 bytes .../command_line_ingest_case_folder.png | Bin 0 -> 27435 bytes .../command_line_ingest_command_entry.png | Bin 0 -> 2180 bytes .../command_line_ingest_console_output.png | Bin 0 -> 9112 bytes .../images/command_line_ingest_dialog.png | Bin 0 -> 15326 bytes .../images/command_line_ingest_open_case.png | Bin 0 -> 35859 bytes .../images/command_line_ingest_options.png | Bin 0 -> 24634 bytes .../command_line_ingest_output_folder.png | Bin 0 -> 16295 bytes .../images/command_line_ingest_profile.png | Bin 0 -> 31547 bytes .../images/command_line_ingest_report.png | Bin 0 -> 9470 bytes .../images/common_properties_cr.png | Bin 0 -> 42767 bytes .../common_properties_cr_case_select.png | Bin 0 -> 5418 bytes .../images/common_properties_cr_property.png | Bin 0 -> 5077 bytes .../images/common_properties_intra_case.png | Bin 0 -> 37695 bytes .../images/common_properties_result.png | Bin 0 -> 32722 bytes .../common_properties_result_case_sort.png | Bin 0 -> 23210 bytes .../images/common_properties_select_ds.png | Bin 0 -> 8826 bytes .../images/content_viewer_annotations.png | Bin 0 -> 25790 bytes .../images/content_viewer_app_image.png | Bin 0 -> 321627 bytes .../images/content_viewer_app_plist.png | Bin 0 -> 35211 bytes .../images/content_viewer_app_sqlite.png | Bin 0 -> 38611 bytes .../images/content_viewer_context.png | Bin 0 -> 43088 bytes .../images/content_viewer_hex.png | Bin 0 -> 33981 bytes .../content_viewer_hex_editor_setup.png | Bin 0 -> 29154 bytes .../images/content_viewer_html.png | Bin 0 -> 37589 bytes .../images/content_viewer_hxd_progress.png | Bin 0 -> 2753 bytes .../images/content_viewer_indexed_text.png | Bin 0 -> 27172 bytes .../images/content_viewer_message.png | Bin 0 -> 24211 bytes .../images/content_viewer_metadata.png | Bin 0 -> 33743 bytes .../images/content_viewer_options_panel.png | Bin 0 -> 19332 bytes .../images/content_viewer_os_account.png | Bin 0 -> 22345 bytes .../content_viewer_other_occurrences.png | Bin 0 -> 30436 bytes .../images/content_viewer_registry.png | Bin 0 -> 43017 bytes .../content_viewer_results_bookmark.png | Bin 0 -> 19444 bytes .../images/content_viewer_results_call.png | Bin 0 -> 15321 bytes .../content_viewer_strings_cyrillic.png | Bin 0 -> 49369 bytes .../images/content_viewer_strings_latin.png | Bin 0 -> 36691 bytes .../images/content_viewer_video.png | Bin 0 -> 143538 bytes .../images/credentialsWithDomain.PNG | Bin 0 -> 34410 bytes .../images/custom_web_categories.png | Bin 0 -> 36483 bytes .../images/custom_web_categories_results.png | Bin 0 -> 43448 bytes docs/doxygen-user_fr/images/cvt_call_log.png | Bin 0 -> 26862 bytes docs/doxygen-user_fr/images/cvt_contacts.png | Bin 0 -> 6249 bytes docs/doxygen-user_fr/images/cvt_links.png | Bin 0 -> 47283 bytes docs/doxygen-user_fr/images/cvt_main.png | Bin 0 -> 99668 bytes docs/doxygen-user_fr/images/cvt_media.png | Bin 0 -> 86846 bytes .../images/cvt_message_attach.png | Bin 0 -> 15273 bytes .../images/cvt_message_email.png | Bin 0 -> 36238 bytes .../images/cvt_messages_threaded.png | Bin 0 -> 9475 bytes .../images/cvt_select_account.png | Bin 0 -> 19457 bytes docs/doxygen-user_fr/images/cvt_snapshot.png | Bin 0 -> 37691 bytes .../images/cvt_summary_tab.png | Bin 0 -> 60772 bytes docs/doxygen-user_fr/images/cvt_visualize.png | Bin 0 -> 41719 bytes .../images/data-source-progress-bar.PNG | Bin 0 -> 28692 bytes .../images/data_source_delete.png | Bin 0 -> 32215 bytes .../images/data_source_disk_image.png | Bin 0 -> 46393 bytes .../images/data_source_host_select.png | Bin 0 -> 31369 bytes .../images/data_source_integrity_add_ds.png | Bin 0 -> 37905 bytes .../data_source_integrity_failed_artifact.png | Bin 0 -> 40357 bytes .../data_source_integrity_failed_inbox.png | Bin 0 -> 34893 bytes .../data_source_integrity_ingest_settings.png | Bin 0 -> 28330 bytes .../images/data_source_integrity_metadata.png | Bin 0 -> 54819 bytes .../images/data_source_integrity_pass1.png | Bin 0 -> 16030 bytes .../images/data_source_integrity_pass2.png | Bin 0 -> 5664 bytes docs/doxygen-user_fr/images/dzkrun.PNG | Bin 0 -> 51961 bytes .../images/email_attachments.png | Bin 0 -> 27543 bytes docs/doxygen-user_fr/images/email_results.PNG | Bin 0 -> 52926 bytes .../images/encrypt_entropy.png | Bin 0 -> 7256 bytes docs/doxygen-user_fr/images/encrypt_inbox.png | Bin 0 -> 53498 bytes .../doxygen-user_fr/images/encrypt_module.png | Bin 0 -> 49653 bytes docs/doxygen-user_fr/images/encrypt_tree.png | Bin 0 -> 25926 bytes .../images/example-of-file-search.PNG | Bin 0 -> 34870 bytes .../images/experimental_plugins_menu.png | Bin 0 -> 49612 bytes docs/doxygen-user_fr/images/explorer-tree.PNG | Bin 0 -> 28623 bytes ...ension-mismatch-detected-configuration.PNG | Bin 0 -> 70788 bytes ...sion-mismatch-detected-ingest-settings.PNG | Bin 0 -> 47540 bytes .../images/extension-mismatch-detected.PNG | Bin 0 -> 84139 bytes .../images/extracted_content.PNG | Bin 0 -> 19689 bytes .../images/extracting-unallocated-space.PNG | Bin 0 -> 10031 bytes docs/doxygen-user_fr/images/filetype.PNG | Bin 0 -> 43576 bytes docs/doxygen-user_fr/images/geo_add_ds.png | Bin 0 -> 391594 bytes .../images/geo_command_line.png | Bin 0 -> 403591 bytes .../images/geo_context_menu.png | Bin 0 -> 26359 bytes docs/doxygen-user_fr/images/geo_details.png | Bin 0 -> 83199 bytes .../images/geo_details_bookmark.png | Bin 0 -> 95648 bytes .../images/geo_filter_datasource.png | Bin 0 -> 6969 bytes .../images/geo_filter_time.png | Bin 0 -> 8074 bytes .../images/geo_filter_type.png | Bin 0 -> 7212 bytes docs/doxygen-user_fr/images/geo_gen_tiles.png | Bin 0 -> 347193 bytes docs/doxygen-user_fr/images/geo_main.png | Bin 0 -> 274427 bytes .../images/geo_openstreetmap.png | Bin 0 -> 24204 bytes docs/doxygen-user_fr/images/geo_report.png | Bin 0 -> 33081 bytes .../images/geo_tile_folder.png | Bin 0 -> 63103 bytes .../images/geo_track_points.png | Bin 0 -> 30659 bytes .../images/geolocation_drone_path.png | Bin 0 -> 57538 bytes .../images/gps_track_artifact.png | Bin 0 -> 69347 bytes docs/doxygen-user_fr/images/gpx_results.png | Bin 0 -> 48267 bytes .../images/grantAccessToComputer.PNG | Bin 0 -> 5247 bytes .../images/groups.properties.after.PNG | Bin 0 -> 25653 bytes .../images/groups.properties.before.PNG | Bin 0 -> 9476 bytes docs/doxygen-user_fr/images/hash-lookup.PNG | Bin 0 -> 46924 bytes docs/doxygen-user_fr/images/hash_add.png | Bin 0 -> 30773 bytes .../images/hash_add_context.png | Bin 0 -> 22878 bytes docs/doxygen-user_fr/images/hash_import.png | Bin 0 -> 22625 bytes docs/doxygen-user_fr/images/hash_indexing.png | Bin 0 -> 14392 bytes docs/doxygen-user_fr/images/hash_new_db.png | Bin 0 -> 18028 bytes docs/doxygen-user_fr/images/hashset-hits.PNG | Bin 0 -> 299703 bytes docs/doxygen-user_fr/images/host_merge.png | Bin 0 -> 20761 bytes .../images/host_merge_result.png | Bin 0 -> 8002 bytes .../images/host_os_accounts.png | Bin 0 -> 68886 bytes docs/doxygen-user_fr/images/ileapp_main.jpg | Bin 0 -> 220727 bytes docs/doxygen-user_fr/images/inbox-button.PNG | Bin 0 -> 6150 bytes .../images/inbox-detail-screen.PNG | Bin 0 -> 18208 bytes .../images/inbox-main-screen.PNG | Bin 0 -> 33456 bytes .../images/ingest-already-run.PNG | Bin 0 -> 47228 bytes .../images/ingest-file-filters.PNG | Bin 0 -> 55332 bytes .../doxygen-user_fr/images/ingest-history.PNG | Bin 0 -> 28105 bytes .../images/ingest-profile-create.PNG | Bin 0 -> 33540 bytes .../images/ingest-profiles.PNG | Bin 0 -> 47998 bytes .../images/ingest_pipeline.PNG | Bin 0 -> 17268 bytes .../images/ingest_progress_snapshot.PNG | Bin 0 -> 29634 bytes .../doxygen-user_fr/images/insertTextHere.PNG | Bin 0 -> 35946 bytes docs/doxygen-user_fr/images/insertedText.PNG | Bin 0 -> 49921 bytes .../images/keyword-search-ad-hoc.PNG | Bin 0 -> 87478 bytes .../images/keyword-search-bar.PNG | Bin 0 -> 8808 bytes ...rd-search-configuration-dialog-general.PNG | Bin 0 -> 47686 bytes ...configuration-dialog-string-extraction.PNG | Bin 0 -> 45289 bytes .../keyword-search-configuration-dialog.PNG | Bin 0 -> 50738 bytes ...word-search-configuration-new-keywords.PNG | Bin 0 -> 11947 bytes .../images/keyword-search-hits.PNG | Bin 0 -> 120348 bytes .../images/keyword-search-inbox.PNG | Bin 0 -> 13940 bytes .../images/keyword-search-ingest-settings.PNG | Bin 0 -> 56648 bytes .../images/keyword-search-list-results.PNG | Bin 0 -> 54920 bytes .../images/keyword-search-list.PNG | Bin 0 -> 18558 bytes .../images/keyword-search-ocr-image.png | Bin 0 -> 74404 bytes .../keyword-search-ocr-indexed-text.png | Bin 0 -> 16833 bytes .../images/keyword_results.PNG | Bin 0 -> 103637 bytes .../images/live_triage_case.png | Bin 0 -> 26594 bytes .../images/live_triage_dialog.png | Bin 0 -> 17794 bytes .../doxygen-user_fr/images/live_triage_ds.png | Bin 0 -> 39635 bytes .../images/live_triage_import_hash.png | Bin 0 -> 25738 bytes .../images/live_triage_script.png | Bin 0 -> 12839 bytes .../images/local-disk-data-source.PNG | Bin 0 -> 43637 bytes docs/doxygen-user_fr/images/log4j.PNG | Bin 0 -> 19174 bytes docs/doxygen-user_fr/images/manage_hosts.png | Bin 0 -> 12281 bytes .../doxygen-user_fr/images/maxConnections.PNG | Bin 0 -> 14065 bytes .../images/maxinactivityduration.PNG | Bin 0 -> 16855 bytes .../doxygen-user_fr/images/messagebubbles.PNG | Bin 0 -> 9177 bytes .../images/messagebubblesbigger.PNG | Bin 0 -> 33086 bytes .../doxygen-user_fr/images/mime-type-tree.PNG | Bin 0 -> 11064 bytes .../images/module_install_netbeans.png | Bin 0 -> 39717 bytes .../images/module_install_python.png | Bin 0 -> 39640 bytes docs/doxygen-user_fr/images/mt_config.png | Bin 0 -> 61244 bytes .../images/mt_content_viewer_translated.png | Bin 0 -> 33239 bytes .../mt_content_viewer_untranslated_text.png | Bin 0 -> 44524 bytes .../images/mt_file_name_enable.png | Bin 0 -> 2149 bytes .../images/mt_file_name_original.png | Bin 0 -> 26983 bytes .../images/mt_file_names_translated.png | Bin 0 -> 27383 bytes .../images/mt_message_orig.png | Bin 0 -> 40382 bytes .../images/mt_message_translated.png | Bin 0 -> 29809 bytes docs/doxygen-user_fr/images/mt_ocr_image.png | Bin 0 -> 139641 bytes docs/doxygen-user_fr/images/mt_ocr_result.png | Bin 0 -> 17755 bytes .../images/multi-user-case-properties.PNG | Bin 0 -> 20146 bytes .../images/multi-user-network.png | Bin 0 -> 103386 bytes .../images/multi_user_case_select.png | Bin 0 -> 15919 bytes docs/doxygen-user_fr/images/newLoginRole.PNG | Bin 0 -> 7320 bytes docs/doxygen-user_fr/images/newPassword.PNG | Bin 0 -> 7108 bytes docs/doxygen-user_fr/images/newRights.PNG | Bin 0 -> 7609 bytes .../images/newUserAndPassword.PNG | Bin 0 -> 17765 bytes .../images/new_case_optional_info.png | Bin 0 -> 27740 bytes .../images/nsrl_import_process.PNG | Bin 0 -> 63236 bytes .../images/objectTypesComputers.PNG | Bin 0 -> 7500 bytes .../object_detection_classifier_dir.PNG | Bin 0 -> 11696 bytes .../images/object_detection_results.PNG | Bin 0 -> 179204 bytes .../images/object_detection_warning.PNG | Bin 0 -> 4821 bytes .../images/open-file-search-component-1.PNG | Bin 0 -> 33261 bytes .../images/open-file-search-component-2.PNG | Bin 0 -> 23523 bytes .../images/open_log_folder.PNG | Bin 0 -> 8397 bytes .../images/open_output_folder.PNG | Bin 0 -> 13308 bytes .../images/options_application.png | Bin 0 -> 50499 bytes .../images/options_ext_viewer.jpg | Bin 0 -> 50953 bytes .../options_ext_viewer_context_menu.jpg | Bin 0 -> 60836 bytes docs/doxygen-user_fr/images/options_logo.png | Bin 0 -> 15928 bytes .../images/options_logo_report.jpg | Bin 0 -> 101783 bytes .../images/othernodeingesting.PNG | Bin 0 -> 734 bytes docs/doxygen-user_fr/images/pgAdmin.PNG | Bin 0 -> 14140 bytes .../images/photo_rec_custom.png | Bin 0 -> 64341 bytes .../images/photo_rec_extensions.png | Bin 0 -> 17553 bytes .../images/photo_rec_settings.PNG | Bin 0 -> 62918 bytes .../images/photorec_output.PNG | Bin 0 -> 83724 bytes docs/doxygen-user_fr/images/plaso_config.png | Bin 0 -> 31628 bytes .../doxygen-user_fr/images/plaso_timeline.png | Bin 0 -> 74025 bytes .../images/portable_case_chunks.png | Bin 0 -> 5888 bytes .../images/portable_case_empty_image.png | Bin 0 -> 72570 bytes .../images/portable_case_folder.png | Bin 0 -> 14228 bytes .../portable_case_interesting_items.png | Bin 0 -> 3358 bytes .../images/portable_case_open_bat.png | Bin 0 -> 17234 bytes .../images/portable_case_original_version.png | Bin 0 -> 297647 bytes .../images/portable_case_portable_version.png | Bin 0 -> 280664 bytes .../images/portable_case_report_panel.png | Bin 0 -> 33865 bytes .../images/portable_case_tags.png | Bin 0 -> 4558 bytes .../images/portable_case_unpackage.png | Bin 0 -> 15641 bytes .../images/postgresqlinstall3.PNG | Bin 0 -> 4168 bytes .../images/postgresqlinstall4.PNG | Bin 0 -> 10499 bytes .../images/postgresqlinstall5.PNG | Bin 0 -> 9864 bytes .../images/postgresqlinstall6.PNG | Bin 0 -> 9334 bytes .../images/postgresqlinstall7.PNG | Bin 0 -> 20948 bytes .../images/previous-version-already-run.PNG | Bin 0 -> 52619 bytes .../images/profile-data-source-panel.PNG | Bin 0 -> 31817 bytes docs/doxygen-user_fr/images/proxySettings.PNG | Bin 0 -> 29844 bytes .../images/quick_search_configuration.png | Bin 0 -> 50888 bytes .../images/quick_search_result.png | Bin 0 -> 16844 bytes docs/doxygen-user_fr/images/reports_case.png | Bin 0 -> 26080 bytes .../images/reports_datasource_select.png | Bin 0 -> 11314 bytes docs/doxygen-user_fr/images/reports_excel.png | Bin 0 -> 42026 bytes .../images/reports_files_config.png | Bin 0 -> 21102 bytes .../images/reports_files_delimiter.png | Bin 0 -> 24161 bytes .../images/reports_files_results.png | Bin 0 -> 8520 bytes .../doxygen-user_fr/images/reports_folder.png | Bin 0 -> 17996 bytes .../images/reports_hashes_config.png | Bin 0 -> 9303 bytes .../images/reports_html_all_results.png | Bin 0 -> 18451 bytes .../images/reports_html_art_select.png | Bin 0 -> 22623 bytes .../images/reports_html_display.png | Bin 0 -> 52157 bytes .../images/reports_html_header.png | Bin 0 -> 24983 bytes .../images/reports_html_tagged.png | Bin 0 -> 19338 bytes docs/doxygen-user_fr/images/reports_kml.png | Bin 0 -> 775450 bytes .../images/reports_result_viewer.png | Bin 0 -> 39962 bytes .../doxygen-user_fr/images/reports_select.png | Bin 0 -> 21175 bytes docs/doxygen-user_fr/images/reset_windows.png | Bin 0 -> 30476 bytes .../images/result-viewer-example-1.PNG | Bin 0 -> 38613 bytes .../images/result-viewer-example-2.PNG | Bin 0 -> 196183 bytes .../images/result-viewer-example-3.PNG | Bin 0 -> 48793 bytes .../images/result-viewer-window-example.PNG | Bin 0 -> 40400 bytes .../images/result_viewer_csv.PNG | Bin 0 -> 27358 bytes .../images/result_viewer_paging.PNG | Bin 0 -> 14867 bytes .../images/runtime_settings.PNG | Bin 0 -> 2747 bytes docs/doxygen-user_fr/images/screenshot.PNG | Bin 0 -> 149345 bytes .../images/search_all_cases_dialog.png | Bin 0 -> 12300 bytes .../images/search_all_cases_results.png | Bin 0 -> 10183 bytes .../images/select-data-source-type.PNG | Bin 0 -> 37225 bytes .../images/select-ingest-modules.PNG | Bin 0 -> 43805 bytes .../doxygen-user_fr/images/serviceinstall.PNG | Bin 0 -> 31708 bytes .../images/sharedStoragePermissions.PNG | Bin 0 -> 9235 bytes .../images/single-user-case-properties.PNG | Bin 0 -> 22694 bytes .../images/solr/solr_adding_nodes_1.png | Bin 0 -> 17340 bytes .../images/solr/solr_adding_nodes_2.png | Bin 0 -> 84990 bytes .../images/solr/solr_autopsy.png | Bin 0 -> 73967 bytes .../images/solr/solr_autopsy_zk.png | Bin 0 -> 92451 bytes .../images/solr/solr_config_case.png | Bin 0 -> 13215 bytes .../images/solr/solr_config_folder.png | Bin 0 -> 19813 bytes .../images/solr/solr_config_monitoring.png | Bin 0 -> 132922 bytes .../images/solr/solr_config_param.png | Bin 0 -> 99774 bytes .../images/solr/solr_config_todo.png | Bin 0 -> 107256 bytes .../solr/solr_disable_periodic_search.png | Bin 0 -> 31140 bytes .../images/solr/solr_install_1.png | Bin 0 -> 5293 bytes .../images/solr/solr_install_2.png | Bin 0 -> 6565 bytes .../images/solr/solr_install_3.png | Bin 0 -> 7275 bytes .../images/solr/solr_install_4.png | Bin 0 -> 6536 bytes docs/doxygen-user_fr/images/solr/solr_jvm.png | Bin 0 -> 24662 bytes .../images/solr/solr_running_in_parallel.png | Bin 0 -> 92451 bytes .../images/solr/solr_standalone_zk_1.png | Bin 0 -> 75487 bytes .../images/solr/solr_standalone_zk_2.png | Bin 0 -> 16806 bytes .../images/solr/solr_standalone_zk_3.png | Bin 0 -> 65203 bytes .../images/solr/solr_standalone_zk_4.png | Bin 0 -> 93751 bytes .../images/solr/solr_start_1.png | Bin 0 -> 74510 bytes .../images/solr/solr_start_2.png | Bin 0 -> 8207 bytes .../images/solr/solr_testing_1.png | Bin 0 -> 57993 bytes .../images/solr/solr_user_1.png | Bin 0 -> 7885 bytes .../images/solr/solr_user_2.png | Bin 0 -> 3461 bytes .../images/solr/solr_zk_migration_1.png | Bin 0 -> 102645 bytes .../images/solr/solr_zk_migration_2.png | Bin 0 -> 53505 bytes .../images/solr/solr_zk_migration_3.png | Bin 0 -> 29606 bytes .../images/solr/solr_zk_migration_4.png | Bin 0 -> 60082 bytes .../images/solr/solr_zk_migration_5.png | Bin 0 -> 71443 bytes docs/doxygen-user_fr/images/solrinstall1.PNG | Bin 0 -> 5001 bytes docs/doxygen-user_fr/images/solrinstall2.PNG | Bin 0 -> 6968 bytes docs/doxygen-user_fr/images/solrinstall3.PNG | Bin 0 -> 35056 bytes docs/doxygen-user_fr/images/splashscreen.PNG | Bin 0 -> 46356 bytes docs/doxygen-user_fr/images/symlinkjava.PNG | Bin 0 -> 1611 bytes .../images/table-result-viewer-tab.PNG | Bin 0 -> 69818 bytes docs/doxygen-user_fr/images/tagging-1.PNG | Bin 0 -> 54092 bytes docs/doxygen-user_fr/images/tagging-2.PNG | Bin 0 -> 8327 bytes docs/doxygen-user_fr/images/tagging-3.PNG | Bin 0 -> 32756 bytes docs/doxygen-user_fr/images/tagging-4.PNG | Bin 0 -> 64613 bytes docs/doxygen-user_fr/images/tagging-5.PNG | Bin 0 -> 57464 bytes docs/doxygen-user_fr/images/tagging-6.PNG | Bin 0 -> 6995 bytes .../images/tagging_comment_anno.png | Bin 0 -> 15322 bytes .../images/tagging_comment_context.png | Bin 0 -> 171949 bytes .../images/tagging_comment_icon.png | Bin 0 -> 151216 bytes .../tagging_comment_in_result_viewer.png | Bin 0 -> 78400 bytes .../images/tagging_cr_comment.png | Bin 0 -> 6743 bytes .../images/tagging_image_create_tag.png | Bin 0 -> 20531 bytes .../images/tagging_image_edit_tag.png | Bin 0 -> 257105 bytes .../images/tagging_image_menu.png | Bin 0 -> 284830 bytes .../images/tagging_image_multiple.png | Bin 0 -> 252660 bytes .../images/tagging_image_one_tag.png | Bin 0 -> 254110 bytes .../images/tagging_image_report.png | Bin 0 -> 80263 bytes .../images/tagging_image_select.png | Bin 0 -> 8336 bytes .../images/tagging_new_tag.PNG | Bin 0 -> 12877 bytes .../images/tagging_user_name.png | Bin 0 -> 7654 bytes .../images/tagging_view_options.png | Bin 0 -> 22747 bytes docs/doxygen-user_fr/images/threadcount.PNG | Bin 0 -> 31875 bytes .../images/thumbnail-result-viewer-tab.PNG | Bin 0 -> 78413 bytes .../images/timeline_counts_view.png | Bin 0 -> 121652 bytes .../images/timeline_details_view.png | Bin 0 -> 169976 bytes .../images/timeline_list_view.png | Bin 0 -> 146964 bytes .../doxygen-user_fr/images/transientcache.PNG | Bin 0 -> 12146 bytes .../images/triage/createVHD.png | Bin 0 -> 19510 bytes .../images/triage/fileFilter.png | Bin 0 -> 10985 bytes .../images/triage/fileFilterImage.png | Bin 0 -> 15534 bytes .../images/triage/ingestProfile.png | Bin 0 -> 47359 bytes .../images/triage/pipelineFolders.png | Bin 0 -> 20025 bytes .../images/triage/profileSelect.png | Bin 0 -> 10637 bytes .../images/troubleshooting_log_menu.png | Bin 0 -> 16449 bytes .../images/troubleshooting_thread.png | Bin 0 -> 31515 bytes docs/doxygen-user_fr/images/ui-layout-1.PNG | Bin 0 -> 285287 bytes .../images/ui_layout_group_tree.PNG | Bin 0 -> 33711 bytes .../images/ui_person_select.png | Bin 0 -> 24175 bytes .../doxygen-user_fr/images/ui_tree_top_ds.png | Bin 0 -> 19586 bytes .../images/ui_tree_top_persons.png | Bin 0 -> 9029 bytes .../images/unallocated_space_options.PNG | Bin 0 -> 28874 bytes .../images/updatedSolr_cmd.PNG | Bin 0 -> 9115 bytes .../images/urlInAddressbar.PNG | Bin 0 -> 80064 bytes .../images/users.properties.after.PNG | Bin 0 -> 11840 bytes .../images/users.properties.before.PNG | Bin 0 -> 9017 bytes .../images/view_options_gear.png | Bin 0 -> 22438 bytes .../images/view_options_gmt.png | Bin 0 -> 12428 bytes .../images/view_options_hide_slack.png | Bin 0 -> 18843 bytes .../images/view_options_local_time.png | Bin 0 -> 12522 bytes .../images/view_options_options_panel.png | Bin 0 -> 59070 bytes .../images/view_options_reject_account.png | Bin 0 -> 49463 bytes .../images/view_options_sco.png | Bin 0 -> 18676 bytes .../images/view_options_show_slack.png | Bin 0 -> 20858 bytes .../images/views_grouped_tree.png | Bin 0 -> 30173 bytes .../images/views_standard_tree.png | Bin 0 -> 36455 bytes .../virtual_machine_extractor_results.png | Bin 0 -> 31932 bytes .../images/volatility_dsp_config.PNG | Bin 0 -> 39473 bytes .../volatility_dsp_interesting_items.PNG | Bin 0 -> 102305 bytes .../images/volatility_dsp_module_output.PNG | Bin 0 -> 103434 bytes .../images/volatility_dsp_select.png | Bin 0 -> 37581 bytes docs/doxygen-user_fr/images/wherejava.PNG | Bin 0 -> 9711 bytes docs/doxygen-user_fr/images/xry_dsp.png | Bin 0 -> 28019 bytes docs/doxygen-user_fr/images/xry_folder.png | Bin 0 -> 33468 bytes .../images/yara_ingest_settings.png | Bin 0 -> 61772 bytes .../images/yara_new_rule_set.png | Bin 0 -> 6757 bytes docs/doxygen-user_fr/images/yara_options.png | Bin 0 -> 38307 bytes docs/doxygen-user_fr/images/yara_results.png | Bin 0 -> 43391 bytes .../images/zipped_children_1.PNG | Bin 0 -> 89932 bytes .../images/zipped_children_2.PNG | Bin 0 -> 90656 bytes .../images/zipped_context_menu.png | Bin 0 -> 38583 bytes .../images/zipped_encryption_detected.png | Bin 0 -> 9693 bytes docs/doxygen-user_fr/images/zipped_tree.png | Bin 0 -> 123222 bytes docs/doxygen-user_fr/images/zooDir.PNG | Bin 0 -> 25815 bytes docs/doxygen-user_fr/images/zooPurge.PNG | Bin 0 -> 6919 bytes docs/doxygen-user_fr/ingest.dox | 104 + docs/doxygen-user_fr/ingest_template.xod | 28 + docs/doxygen-user_fr/installation.dox | 60 + docs/doxygen-user_fr/interesting_files.dox | 119 + docs/doxygen-user_fr/keyword_search.dox | 121 + docs/doxygen-user_fr/live_triage.dox | 49 + docs/doxygen-user_fr/logical_imager.dox | 185 ++ docs/doxygen-user_fr/logs_and_output_page.dox | 11 + docs/doxygen-user_fr/machine_translation.dox | 62 + docs/doxygen-user_fr/main.dox | 115 + docs/doxygen-user_fr/manifest_tool.dox | 65 + docs/doxygen-user_fr/module_install.dox | 23 + .../multi-user/createMultiUserCase.dox | 30 + .../multi-user/installActiveMQ.dox | 145 + .../multi-user/installMultiUser.dox | 35 + .../multi-user/installMultiUserClient.dox | 21 + .../multi-user/installPostgres.dox | 119 + .../multi-user/installSharedStorage.dox | 42 + .../multi-user/installSolr.dox | 290 ++ .../multi-user/installSystems.dox | 46 + .../multi-user/installUsers.dox | 87 + .../multi-user/multiuser-security.dox | 16 + .../multi-user/upgradeSolr8.dox | 90 + docs/doxygen-user_fr/object_detection.dox | 30 + docs/doxygen-user_fr/performance.dox | 19 + docs/doxygen-user_fr/personas.dox | 109 + docs/doxygen-user_fr/photorec_carver.dox | 96 + docs/doxygen-user_fr/plaso.dox | 22 + docs/doxygen-user_fr/portable_case.dox | 81 + docs/doxygen-user_fr/quick_start_guide.dox | 150 ++ docs/doxygen-user_fr/recent_activity.dox | 43 + docs/doxygen-user_fr/reporting.dox | 120 + docs/doxygen-user_fr/result_viewer.dox | 64 + docs/doxygen-user_fr/search_all_cases.dox | 24 + docs/doxygen-user_fr/stix.dox | 104 + docs/doxygen-user_fr/tagging.dox | 141 + docs/doxygen-user_fr/timeline.dox | 179 ++ docs/doxygen-user_fr/translations.dox | 157 ++ docs/doxygen-user_fr/tree_viewer.dox | 67 + docs/doxygen-user_fr/triage.dox | 104 + docs/doxygen-user_fr/troubleshooting.dox | 136 + docs/doxygen-user_fr/ui_quick_search.dox | 27 + docs/doxygen-user_fr/uilayout.dox | 44 + .../updating_interesting_file_sets.dox | 26 + docs/doxygen-user_fr/view_options.dox | 91 + docs/doxygen-user_fr/vm_module.dox | 11 + docs/doxygen-user_fr/volatility_dsp.dox | 37 + docs/doxygen-user_fr/workflow.dox | 10 + docs/doxygen-user_fr/yara.dox | 50 + 600 files changed, 8969 insertions(+) create mode 100644 docs/doxygen-user_fr/Doxyfile create mode 100644 docs/doxygen-user_fr/EXIF_parser_page.dox create mode 100644 docs/doxygen-user_fr/README.txt create mode 100644 docs/doxygen-user_fr/adHocKeywordSearch.dox create mode 100644 docs/doxygen-user_fr/aleapp.dox create mode 100644 docs/doxygen-user_fr/android_analyzer.dox create mode 100644 docs/doxygen-user_fr/archive_extractor.dox create mode 100644 docs/doxygen-user_fr/auto_ingest.dox create mode 100644 docs/doxygen-user_fr/auto_ingest_administration.dox create mode 100644 docs/doxygen-user_fr/auto_ingest_setup.dox create mode 100644 docs/doxygen-user_fr/case_management.dox create mode 100644 docs/doxygen-user_fr/central_repo.dox create mode 100644 docs/doxygen-user_fr/command_line_ingest.dox create mode 100644 docs/doxygen-user_fr/common_files.dox create mode 100644 docs/doxygen-user_fr/communications.dox create mode 100644 docs/doxygen-user_fr/configuration.dox create mode 100644 docs/doxygen-user_fr/content_viewer.dox create mode 100644 docs/doxygen-user_fr/data_source_integrity.dox create mode 100644 docs/doxygen-user_fr/data_source_summary.dox create mode 100644 docs/doxygen-user_fr/data_sources.dox create mode 100644 docs/doxygen-user_fr/drone.dox create mode 100644 docs/doxygen-user_fr/email_parser.dox create mode 100644 docs/doxygen-user_fr/encryption_detection.dox create mode 100644 docs/doxygen-user_fr/experimental.dox create mode 100644 docs/doxygen-user_fr/extension_mismatch.dox create mode 100644 docs/doxygen-user_fr/file_discovery.dox create mode 100644 docs/doxygen-user_fr/file_export.dox create mode 100644 docs/doxygen-user_fr/file_search.dox create mode 100644 docs/doxygen-user_fr/filetype.dox create mode 100644 docs/doxygen-user_fr/footer.html create mode 100644 docs/doxygen-user_fr/geolocation.dox create mode 100644 docs/doxygen-user_fr/gpx.dox create mode 100644 docs/doxygen-user_fr/hashdb_lookup.dox create mode 100644 docs/doxygen-user_fr/hosts.dox create mode 100644 docs/doxygen-user_fr/ileapp.dox create mode 100644 docs/doxygen-user_fr/image_gallery.dox create mode 100644 docs/doxygen-user_fr/images/AutoIngest/admin_file.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/admin_jobs_cancel.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/admin_jobs_completed.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/admin_jobs_panel.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/admin_nodes_panel.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/advanced_settings.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/auto_ingest_in_progress.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/auto_ingest_mode_setup.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/case_delete_confirm.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/cases_context_menu.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/cases_panel.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/error_suppression.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/examiner_dashboard.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/file_export_dir_structure.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/file_export_encrypton.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/file_export_file_loc.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/file_export_json_loc.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/file_export_keyword.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/file_export_png.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/file_export_size.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/file_exporter_main.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/health_monitor.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/health_monitor_disabled.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/manifest_file_in_file_explorer.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/manifest_tool_root_folder.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/manifest_tool_ui.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/master_node.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/metrics.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/no_periodic_searches.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/overview_pic1.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/overview_pic2.png create mode 100644 docs/doxygen-user_fr/images/AutoIngest/test_button_failure.png create mode 100644 docs/doxygen-user_fr/images/DataSourceSummary/ds_summary_analysis.png create mode 100644 docs/doxygen-user_fr/images/DataSourceSummary/ds_summary_container.png create mode 100644 docs/doxygen-user_fr/images/DataSourceSummary/ds_summary_export.png create mode 100644 docs/doxygen-user_fr/images/DataSourceSummary/ds_summary_geo.png create mode 100644 docs/doxygen-user_fr/images/DataSourceSummary/ds_summary_ingest.png create mode 100644 docs/doxygen-user_fr/images/DataSourceSummary/ds_summary_noRA.png create mode 100644 docs/doxygen-user_fr/images/DataSourceSummary/ds_summary_past_cases.png create mode 100644 docs/doxygen-user_fr/images/DataSourceSummary/ds_summary_recent_files.png create mode 100644 docs/doxygen-user_fr/images/DataSourceSummary/ds_summary_result_viewer.png create mode 100644 docs/doxygen-user_fr/images/DataSourceSummary/ds_summary_timeline.png create mode 100644 docs/doxygen-user_fr/images/DataSourceSummary/ds_summary_types.png create mode 100644 docs/doxygen-user_fr/images/DataSourceSummary/ds_summary_user_activity.png create mode 100644 docs/doxygen-user_fr/images/DataSourceSummary/ds_summary_window.png create mode 100644 docs/doxygen-user_fr/images/EXIF-heic.png create mode 100644 docs/doxygen-user_fr/images/EXIF-tree.PNG create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_dataSourceFilter.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_dateFilter.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_documents.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_domainDetails.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_domainResultFilter.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_domains.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_dupeEx.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_fileSizeFilter.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_fileType.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_grouping.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_groupingInt.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_groupingSize.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_hashSetFilter.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_icon.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_instanceContext.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_interestingItemsFilter.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_knownAccountFilter.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_loadSettings.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_main.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_notableFilter.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_objectFilter.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_paging.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_parentEx2.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_parentFilter.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_pastOccur.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_resultGroups.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_setup.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_userContentArtifact.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_userCreatedFilter.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/fd_videos.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/file-icon-deleted.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/red-circle-exclamation.png create mode 100644 docs/doxygen-user_fr/images/FileDiscovery/yellow-circle-yield.png create mode 100644 docs/doxygen-user_fr/images/ImageGallery/application_view_tile.PNG create mode 100644 docs/doxygen-user_fr/images/ImageGallery/bisque.PNG create mode 100644 docs/doxygen-user_fr/images/ImageGallery/drawabletile.PNG create mode 100644 docs/doxygen-user_fr/images/ImageGallery/flag_gray.PNG create mode 100644 docs/doxygen-user_fr/images/ImageGallery/flag_red.PNG create mode 100644 docs/doxygen-user_fr/images/ImageGallery/folder_picture.PNG create mode 100644 docs/doxygen-user_fr/images/ImageGallery/gray.PNG create mode 100644 docs/doxygen-user_fr/images/ImageGallery/green.PNG create mode 100644 docs/doxygen-user_fr/images/ImageGallery/hashset_hits.PNG create mode 100644 docs/doxygen-user_fr/images/ImageGallery/orange.PNG create mode 100644 docs/doxygen-user_fr/images/ImageGallery/purpledash.PNG create mode 100644 docs/doxygen-user_fr/images/ImageGallery/red.PNG create mode 100644 docs/doxygen-user_fr/images/ImageGallery/slide.PNG create mode 100644 docs/doxygen-user_fr/images/ImageGallery/video-file.PNG create mode 100644 docs/doxygen-user_fr/images/ImageGallery/yellow.PNG create mode 100644 docs/doxygen-user_fr/images/InterestingFiles/bomb_png.png create mode 100644 docs/doxygen-user_fr/images/InterestingFiles/download_archive.png create mode 100644 docs/doxygen-user_fr/images/InterestingFiles/if_create_set.png create mode 100644 docs/doxygen-user_fr/images/InterestingFiles/if_export.png create mode 100644 docs/doxygen-user_fr/images/InterestingFiles/if_new_rule.png create mode 100644 docs/doxygen-user_fr/images/InterestingFiles/if_official_rule_details.png create mode 100644 docs/doxygen-user_fr/images/InterestingFiles/ingest.png create mode 100644 docs/doxygen-user_fr/images/InterestingFiles/main.png create mode 100644 docs/doxygen-user_fr/images/InterestingFiles/new_large_files.png create mode 100644 docs/doxygen-user_fr/images/InterestingFiles/new_rule.png create mode 100644 docs/doxygen-user_fr/images/InterestingFiles/new_rule_set.png create mode 100644 docs/doxygen-user_fr/images/InterestingFiles/private_folder.png create mode 100644 docs/doxygen-user_fr/images/InterestingFiles/results.png create mode 100644 docs/doxygen-user_fr/images/JRE_bitness.PNG create mode 100644 docs/doxygen-user_fr/images/LogicalImager/VHDfolder.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/command_prompt.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/config_flag.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/configure_drive.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/dsp_select.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/exe_folder.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/fileTree.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/full_path_rule.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/image_flag.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/import.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/interestingFiles.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/main_config_panel.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/new_attr_rule.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/nonVHDexport.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/nonVHDfolder.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/output_folder.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/save.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/select_folder.png create mode 100644 docs/doxygen-user_fr/images/LogicalImager/tools_menu.png create mode 100644 docs/doxygen-user_fr/images/Personas/persona_edit.png create mode 100644 docs/doxygen-user_fr/images/Personas/personas_calllog.png create mode 100644 docs/doxygen-user_fr/images/Personas/personas_contact_found.png create mode 100644 docs/doxygen-user_fr/images/Personas/personas_contact_not_found.png create mode 100644 docs/doxygen-user_fr/images/Personas/personas_create.png create mode 100644 docs/doxygen-user_fr/images/Personas/personas_create_account.png create mode 100644 docs/doxygen-user_fr/images/Personas/personas_cvt_accounts.png create mode 100644 docs/doxygen-user_fr/images/Personas/personas_cvt_hover.png create mode 100644 docs/doxygen-user_fr/images/Personas/personas_main.png create mode 100644 docs/doxygen-user_fr/images/Personas/personas_message.png create mode 100644 docs/doxygen-user_fr/images/StartActiveMQService.PNG create mode 100644 docs/doxygen-user_fr/images/StopActiveMQService.PNG create mode 100644 docs/doxygen-user_fr/images/activeMQ_node_cleanup.png create mode 100644 docs/doxygen-user_fr/images/activemq.PNG create mode 100644 docs/doxygen-user_fr/images/add-data-source.PNG create mode 100644 docs/doxygen-user_fr/images/aleapp_main.jpg create mode 100644 docs/doxygen-user_fr/images/android_analyzer_output.PNG create mode 100644 docs/doxygen-user_fr/images/apachebadmessage.PNG create mode 100644 docs/doxygen-user_fr/images/case-newcase.PNG create mode 100644 docs/doxygen-user_fr/images/case_properties.png create mode 100644 docs/doxygen-user_fr/images/central_repo_content_viewer.png create mode 100644 docs/doxygen-user_fr/images/central_repo_details.png create mode 100644 docs/doxygen-user_fr/images/central_repo_ingest_settings.png create mode 100644 docs/doxygen-user_fr/images/central_repo_interesting_items.png create mode 100644 docs/doxygen-user_fr/images/central_repo_manage_tags.png create mode 100644 docs/doxygen-user_fr/images/central_repo_new_org.png create mode 100644 docs/doxygen-user_fr/images/central_repo_options.png create mode 100644 docs/doxygen-user_fr/images/central_repo_orgs.png create mode 100644 docs/doxygen-user_fr/images/central_repo_postgres.png create mode 100644 docs/doxygen-user_fr/images/central_repo_sqlite.png create mode 100644 docs/doxygen-user_fr/images/central_repo_tag_file.png create mode 100644 docs/doxygen-user_fr/images/central_repo_types.png create mode 100644 docs/doxygen-user_fr/images/change_logical_file_set_display_name.PNG create mode 100644 docs/doxygen-user_fr/images/command_line_ingest_bin_dir.png create mode 100644 docs/doxygen-user_fr/images/command_line_ingest_case_folder.png create mode 100644 docs/doxygen-user_fr/images/command_line_ingest_command_entry.png create mode 100644 docs/doxygen-user_fr/images/command_line_ingest_console_output.png create mode 100644 docs/doxygen-user_fr/images/command_line_ingest_dialog.png create mode 100644 docs/doxygen-user_fr/images/command_line_ingest_open_case.png create mode 100644 docs/doxygen-user_fr/images/command_line_ingest_options.png create mode 100644 docs/doxygen-user_fr/images/command_line_ingest_output_folder.png create mode 100644 docs/doxygen-user_fr/images/command_line_ingest_profile.png create mode 100644 docs/doxygen-user_fr/images/command_line_ingest_report.png create mode 100644 docs/doxygen-user_fr/images/common_properties_cr.png create mode 100644 docs/doxygen-user_fr/images/common_properties_cr_case_select.png create mode 100644 docs/doxygen-user_fr/images/common_properties_cr_property.png create mode 100644 docs/doxygen-user_fr/images/common_properties_intra_case.png create mode 100644 docs/doxygen-user_fr/images/common_properties_result.png create mode 100644 docs/doxygen-user_fr/images/common_properties_result_case_sort.png create mode 100644 docs/doxygen-user_fr/images/common_properties_select_ds.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_annotations.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_app_image.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_app_plist.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_app_sqlite.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_context.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_hex.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_hex_editor_setup.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_html.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_hxd_progress.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_indexed_text.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_message.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_metadata.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_options_panel.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_os_account.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_other_occurrences.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_registry.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_results_bookmark.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_results_call.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_strings_cyrillic.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_strings_latin.png create mode 100644 docs/doxygen-user_fr/images/content_viewer_video.png create mode 100644 docs/doxygen-user_fr/images/credentialsWithDomain.PNG create mode 100644 docs/doxygen-user_fr/images/custom_web_categories.png create mode 100644 docs/doxygen-user_fr/images/custom_web_categories_results.png create mode 100644 docs/doxygen-user_fr/images/cvt_call_log.png create mode 100644 docs/doxygen-user_fr/images/cvt_contacts.png create mode 100644 docs/doxygen-user_fr/images/cvt_links.png create mode 100644 docs/doxygen-user_fr/images/cvt_main.png create mode 100644 docs/doxygen-user_fr/images/cvt_media.png create mode 100644 docs/doxygen-user_fr/images/cvt_message_attach.png create mode 100644 docs/doxygen-user_fr/images/cvt_message_email.png create mode 100644 docs/doxygen-user_fr/images/cvt_messages_threaded.png create mode 100644 docs/doxygen-user_fr/images/cvt_select_account.png create mode 100644 docs/doxygen-user_fr/images/cvt_snapshot.png create mode 100644 docs/doxygen-user_fr/images/cvt_summary_tab.png create mode 100644 docs/doxygen-user_fr/images/cvt_visualize.png create mode 100644 docs/doxygen-user_fr/images/data-source-progress-bar.PNG create mode 100644 docs/doxygen-user_fr/images/data_source_delete.png create mode 100644 docs/doxygen-user_fr/images/data_source_disk_image.png create mode 100644 docs/doxygen-user_fr/images/data_source_host_select.png create mode 100644 docs/doxygen-user_fr/images/data_source_integrity_add_ds.png create mode 100644 docs/doxygen-user_fr/images/data_source_integrity_failed_artifact.png create mode 100644 docs/doxygen-user_fr/images/data_source_integrity_failed_inbox.png create mode 100644 docs/doxygen-user_fr/images/data_source_integrity_ingest_settings.png create mode 100644 docs/doxygen-user_fr/images/data_source_integrity_metadata.png create mode 100644 docs/doxygen-user_fr/images/data_source_integrity_pass1.png create mode 100644 docs/doxygen-user_fr/images/data_source_integrity_pass2.png create mode 100644 docs/doxygen-user_fr/images/dzkrun.PNG create mode 100644 docs/doxygen-user_fr/images/email_attachments.png create mode 100644 docs/doxygen-user_fr/images/email_results.PNG create mode 100644 docs/doxygen-user_fr/images/encrypt_entropy.png create mode 100644 docs/doxygen-user_fr/images/encrypt_inbox.png create mode 100644 docs/doxygen-user_fr/images/encrypt_module.png create mode 100644 docs/doxygen-user_fr/images/encrypt_tree.png create mode 100644 docs/doxygen-user_fr/images/example-of-file-search.PNG create mode 100644 docs/doxygen-user_fr/images/experimental_plugins_menu.png create mode 100644 docs/doxygen-user_fr/images/explorer-tree.PNG create mode 100644 docs/doxygen-user_fr/images/extension-mismatch-detected-configuration.PNG create mode 100644 docs/doxygen-user_fr/images/extension-mismatch-detected-ingest-settings.PNG create mode 100644 docs/doxygen-user_fr/images/extension-mismatch-detected.PNG create mode 100644 docs/doxygen-user_fr/images/extracted_content.PNG create mode 100644 docs/doxygen-user_fr/images/extracting-unallocated-space.PNG create mode 100644 docs/doxygen-user_fr/images/filetype.PNG create mode 100644 docs/doxygen-user_fr/images/geo_add_ds.png create mode 100644 docs/doxygen-user_fr/images/geo_command_line.png create mode 100644 docs/doxygen-user_fr/images/geo_context_menu.png create mode 100644 docs/doxygen-user_fr/images/geo_details.png create mode 100644 docs/doxygen-user_fr/images/geo_details_bookmark.png create mode 100644 docs/doxygen-user_fr/images/geo_filter_datasource.png create mode 100644 docs/doxygen-user_fr/images/geo_filter_time.png create mode 100644 docs/doxygen-user_fr/images/geo_filter_type.png create mode 100644 docs/doxygen-user_fr/images/geo_gen_tiles.png create mode 100644 docs/doxygen-user_fr/images/geo_main.png create mode 100644 docs/doxygen-user_fr/images/geo_openstreetmap.png create mode 100644 docs/doxygen-user_fr/images/geo_report.png create mode 100644 docs/doxygen-user_fr/images/geo_tile_folder.png create mode 100644 docs/doxygen-user_fr/images/geo_track_points.png create mode 100644 docs/doxygen-user_fr/images/geolocation_drone_path.png create mode 100644 docs/doxygen-user_fr/images/gps_track_artifact.png create mode 100644 docs/doxygen-user_fr/images/gpx_results.png create mode 100644 docs/doxygen-user_fr/images/grantAccessToComputer.PNG create mode 100644 docs/doxygen-user_fr/images/groups.properties.after.PNG create mode 100644 docs/doxygen-user_fr/images/groups.properties.before.PNG create mode 100644 docs/doxygen-user_fr/images/hash-lookup.PNG create mode 100644 docs/doxygen-user_fr/images/hash_add.png create mode 100644 docs/doxygen-user_fr/images/hash_add_context.png create mode 100644 docs/doxygen-user_fr/images/hash_import.png create mode 100644 docs/doxygen-user_fr/images/hash_indexing.png create mode 100644 docs/doxygen-user_fr/images/hash_new_db.png create mode 100644 docs/doxygen-user_fr/images/hashset-hits.PNG create mode 100644 docs/doxygen-user_fr/images/host_merge.png create mode 100644 docs/doxygen-user_fr/images/host_merge_result.png create mode 100644 docs/doxygen-user_fr/images/host_os_accounts.png create mode 100644 docs/doxygen-user_fr/images/ileapp_main.jpg create mode 100644 docs/doxygen-user_fr/images/inbox-button.PNG create mode 100644 docs/doxygen-user_fr/images/inbox-detail-screen.PNG create mode 100644 docs/doxygen-user_fr/images/inbox-main-screen.PNG create mode 100644 docs/doxygen-user_fr/images/ingest-already-run.PNG create mode 100644 docs/doxygen-user_fr/images/ingest-file-filters.PNG create mode 100644 docs/doxygen-user_fr/images/ingest-history.PNG create mode 100644 docs/doxygen-user_fr/images/ingest-profile-create.PNG create mode 100644 docs/doxygen-user_fr/images/ingest-profiles.PNG create mode 100644 docs/doxygen-user_fr/images/ingest_pipeline.PNG create mode 100644 docs/doxygen-user_fr/images/ingest_progress_snapshot.PNG create mode 100644 docs/doxygen-user_fr/images/insertTextHere.PNG create mode 100644 docs/doxygen-user_fr/images/insertedText.PNG create mode 100644 docs/doxygen-user_fr/images/keyword-search-ad-hoc.PNG create mode 100644 docs/doxygen-user_fr/images/keyword-search-bar.PNG create mode 100644 docs/doxygen-user_fr/images/keyword-search-configuration-dialog-general.PNG create mode 100644 docs/doxygen-user_fr/images/keyword-search-configuration-dialog-string-extraction.PNG create mode 100644 docs/doxygen-user_fr/images/keyword-search-configuration-dialog.PNG create mode 100644 docs/doxygen-user_fr/images/keyword-search-configuration-new-keywords.PNG create mode 100644 docs/doxygen-user_fr/images/keyword-search-hits.PNG create mode 100644 docs/doxygen-user_fr/images/keyword-search-inbox.PNG create mode 100644 docs/doxygen-user_fr/images/keyword-search-ingest-settings.PNG create mode 100644 docs/doxygen-user_fr/images/keyword-search-list-results.PNG create mode 100644 docs/doxygen-user_fr/images/keyword-search-list.PNG create mode 100644 docs/doxygen-user_fr/images/keyword-search-ocr-image.png create mode 100644 docs/doxygen-user_fr/images/keyword-search-ocr-indexed-text.png create mode 100644 docs/doxygen-user_fr/images/keyword_results.PNG create mode 100644 docs/doxygen-user_fr/images/live_triage_case.png create mode 100644 docs/doxygen-user_fr/images/live_triage_dialog.png create mode 100644 docs/doxygen-user_fr/images/live_triage_ds.png create mode 100644 docs/doxygen-user_fr/images/live_triage_import_hash.png create mode 100644 docs/doxygen-user_fr/images/live_triage_script.png create mode 100644 docs/doxygen-user_fr/images/local-disk-data-source.PNG create mode 100644 docs/doxygen-user_fr/images/log4j.PNG create mode 100644 docs/doxygen-user_fr/images/manage_hosts.png create mode 100644 docs/doxygen-user_fr/images/maxConnections.PNG create mode 100644 docs/doxygen-user_fr/images/maxinactivityduration.PNG create mode 100644 docs/doxygen-user_fr/images/messagebubbles.PNG create mode 100644 docs/doxygen-user_fr/images/messagebubblesbigger.PNG create mode 100644 docs/doxygen-user_fr/images/mime-type-tree.PNG create mode 100644 docs/doxygen-user_fr/images/module_install_netbeans.png create mode 100644 docs/doxygen-user_fr/images/module_install_python.png create mode 100644 docs/doxygen-user_fr/images/mt_config.png create mode 100644 docs/doxygen-user_fr/images/mt_content_viewer_translated.png create mode 100644 docs/doxygen-user_fr/images/mt_content_viewer_untranslated_text.png create mode 100644 docs/doxygen-user_fr/images/mt_file_name_enable.png create mode 100644 docs/doxygen-user_fr/images/mt_file_name_original.png create mode 100644 docs/doxygen-user_fr/images/mt_file_names_translated.png create mode 100644 docs/doxygen-user_fr/images/mt_message_orig.png create mode 100644 docs/doxygen-user_fr/images/mt_message_translated.png create mode 100644 docs/doxygen-user_fr/images/mt_ocr_image.png create mode 100644 docs/doxygen-user_fr/images/mt_ocr_result.png create mode 100644 docs/doxygen-user_fr/images/multi-user-case-properties.PNG create mode 100644 docs/doxygen-user_fr/images/multi-user-network.png create mode 100644 docs/doxygen-user_fr/images/multi_user_case_select.png create mode 100644 docs/doxygen-user_fr/images/newLoginRole.PNG create mode 100644 docs/doxygen-user_fr/images/newPassword.PNG create mode 100644 docs/doxygen-user_fr/images/newRights.PNG create mode 100644 docs/doxygen-user_fr/images/newUserAndPassword.PNG create mode 100644 docs/doxygen-user_fr/images/new_case_optional_info.png create mode 100644 docs/doxygen-user_fr/images/nsrl_import_process.PNG create mode 100644 docs/doxygen-user_fr/images/objectTypesComputers.PNG create mode 100644 docs/doxygen-user_fr/images/object_detection_classifier_dir.PNG create mode 100644 docs/doxygen-user_fr/images/object_detection_results.PNG create mode 100644 docs/doxygen-user_fr/images/object_detection_warning.PNG create mode 100644 docs/doxygen-user_fr/images/open-file-search-component-1.PNG create mode 100644 docs/doxygen-user_fr/images/open-file-search-component-2.PNG create mode 100644 docs/doxygen-user_fr/images/open_log_folder.PNG create mode 100644 docs/doxygen-user_fr/images/open_output_folder.PNG create mode 100644 docs/doxygen-user_fr/images/options_application.png create mode 100644 docs/doxygen-user_fr/images/options_ext_viewer.jpg create mode 100644 docs/doxygen-user_fr/images/options_ext_viewer_context_menu.jpg create mode 100644 docs/doxygen-user_fr/images/options_logo.png create mode 100644 docs/doxygen-user_fr/images/options_logo_report.jpg create mode 100644 docs/doxygen-user_fr/images/othernodeingesting.PNG create mode 100644 docs/doxygen-user_fr/images/pgAdmin.PNG create mode 100644 docs/doxygen-user_fr/images/photo_rec_custom.png create mode 100644 docs/doxygen-user_fr/images/photo_rec_extensions.png create mode 100644 docs/doxygen-user_fr/images/photo_rec_settings.PNG create mode 100644 docs/doxygen-user_fr/images/photorec_output.PNG create mode 100644 docs/doxygen-user_fr/images/plaso_config.png create mode 100644 docs/doxygen-user_fr/images/plaso_timeline.png create mode 100644 docs/doxygen-user_fr/images/portable_case_chunks.png create mode 100644 docs/doxygen-user_fr/images/portable_case_empty_image.png create mode 100644 docs/doxygen-user_fr/images/portable_case_folder.png create mode 100644 docs/doxygen-user_fr/images/portable_case_interesting_items.png create mode 100644 docs/doxygen-user_fr/images/portable_case_open_bat.png create mode 100644 docs/doxygen-user_fr/images/portable_case_original_version.png create mode 100644 docs/doxygen-user_fr/images/portable_case_portable_version.png create mode 100644 docs/doxygen-user_fr/images/portable_case_report_panel.png create mode 100644 docs/doxygen-user_fr/images/portable_case_tags.png create mode 100644 docs/doxygen-user_fr/images/portable_case_unpackage.png create mode 100644 docs/doxygen-user_fr/images/postgresqlinstall3.PNG create mode 100644 docs/doxygen-user_fr/images/postgresqlinstall4.PNG create mode 100644 docs/doxygen-user_fr/images/postgresqlinstall5.PNG create mode 100644 docs/doxygen-user_fr/images/postgresqlinstall6.PNG create mode 100644 docs/doxygen-user_fr/images/postgresqlinstall7.PNG create mode 100644 docs/doxygen-user_fr/images/previous-version-already-run.PNG create mode 100644 docs/doxygen-user_fr/images/profile-data-source-panel.PNG create mode 100644 docs/doxygen-user_fr/images/proxySettings.PNG create mode 100644 docs/doxygen-user_fr/images/quick_search_configuration.png create mode 100644 docs/doxygen-user_fr/images/quick_search_result.png create mode 100644 docs/doxygen-user_fr/images/reports_case.png create mode 100644 docs/doxygen-user_fr/images/reports_datasource_select.png create mode 100644 docs/doxygen-user_fr/images/reports_excel.png create mode 100644 docs/doxygen-user_fr/images/reports_files_config.png create mode 100644 docs/doxygen-user_fr/images/reports_files_delimiter.png create mode 100644 docs/doxygen-user_fr/images/reports_files_results.png create mode 100644 docs/doxygen-user_fr/images/reports_folder.png create mode 100644 docs/doxygen-user_fr/images/reports_hashes_config.png create mode 100644 docs/doxygen-user_fr/images/reports_html_all_results.png create mode 100644 docs/doxygen-user_fr/images/reports_html_art_select.png create mode 100644 docs/doxygen-user_fr/images/reports_html_display.png create mode 100644 docs/doxygen-user_fr/images/reports_html_header.png create mode 100644 docs/doxygen-user_fr/images/reports_html_tagged.png create mode 100644 docs/doxygen-user_fr/images/reports_kml.png create mode 100644 docs/doxygen-user_fr/images/reports_result_viewer.png create mode 100644 docs/doxygen-user_fr/images/reports_select.png create mode 100644 docs/doxygen-user_fr/images/reset_windows.png create mode 100644 docs/doxygen-user_fr/images/result-viewer-example-1.PNG create mode 100644 docs/doxygen-user_fr/images/result-viewer-example-2.PNG create mode 100644 docs/doxygen-user_fr/images/result-viewer-example-3.PNG create mode 100644 docs/doxygen-user_fr/images/result-viewer-window-example.PNG create mode 100644 docs/doxygen-user_fr/images/result_viewer_csv.PNG create mode 100644 docs/doxygen-user_fr/images/result_viewer_paging.PNG create mode 100644 docs/doxygen-user_fr/images/runtime_settings.PNG create mode 100644 docs/doxygen-user_fr/images/screenshot.PNG create mode 100644 docs/doxygen-user_fr/images/search_all_cases_dialog.png create mode 100644 docs/doxygen-user_fr/images/search_all_cases_results.png create mode 100644 docs/doxygen-user_fr/images/select-data-source-type.PNG create mode 100644 docs/doxygen-user_fr/images/select-ingest-modules.PNG create mode 100644 docs/doxygen-user_fr/images/serviceinstall.PNG create mode 100644 docs/doxygen-user_fr/images/sharedStoragePermissions.PNG create mode 100644 docs/doxygen-user_fr/images/single-user-case-properties.PNG create mode 100644 docs/doxygen-user_fr/images/solr/solr_adding_nodes_1.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_adding_nodes_2.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_autopsy.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_autopsy_zk.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_config_case.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_config_folder.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_config_monitoring.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_config_param.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_config_todo.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_disable_periodic_search.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_install_1.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_install_2.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_install_3.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_install_4.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_jvm.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_running_in_parallel.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_standalone_zk_1.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_standalone_zk_2.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_standalone_zk_3.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_standalone_zk_4.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_start_1.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_start_2.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_testing_1.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_user_1.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_user_2.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_zk_migration_1.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_zk_migration_2.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_zk_migration_3.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_zk_migration_4.png create mode 100644 docs/doxygen-user_fr/images/solr/solr_zk_migration_5.png create mode 100644 docs/doxygen-user_fr/images/solrinstall1.PNG create mode 100644 docs/doxygen-user_fr/images/solrinstall2.PNG create mode 100644 docs/doxygen-user_fr/images/solrinstall3.PNG create mode 100644 docs/doxygen-user_fr/images/splashscreen.PNG create mode 100644 docs/doxygen-user_fr/images/symlinkjava.PNG create mode 100644 docs/doxygen-user_fr/images/table-result-viewer-tab.PNG create mode 100644 docs/doxygen-user_fr/images/tagging-1.PNG create mode 100644 docs/doxygen-user_fr/images/tagging-2.PNG create mode 100644 docs/doxygen-user_fr/images/tagging-3.PNG create mode 100644 docs/doxygen-user_fr/images/tagging-4.PNG create mode 100644 docs/doxygen-user_fr/images/tagging-5.PNG create mode 100644 docs/doxygen-user_fr/images/tagging-6.PNG create mode 100644 docs/doxygen-user_fr/images/tagging_comment_anno.png create mode 100644 docs/doxygen-user_fr/images/tagging_comment_context.png create mode 100644 docs/doxygen-user_fr/images/tagging_comment_icon.png create mode 100644 docs/doxygen-user_fr/images/tagging_comment_in_result_viewer.png create mode 100644 docs/doxygen-user_fr/images/tagging_cr_comment.png create mode 100644 docs/doxygen-user_fr/images/tagging_image_create_tag.png create mode 100644 docs/doxygen-user_fr/images/tagging_image_edit_tag.png create mode 100644 docs/doxygen-user_fr/images/tagging_image_menu.png create mode 100644 docs/doxygen-user_fr/images/tagging_image_multiple.png create mode 100644 docs/doxygen-user_fr/images/tagging_image_one_tag.png create mode 100644 docs/doxygen-user_fr/images/tagging_image_report.png create mode 100644 docs/doxygen-user_fr/images/tagging_image_select.png create mode 100644 docs/doxygen-user_fr/images/tagging_new_tag.PNG create mode 100644 docs/doxygen-user_fr/images/tagging_user_name.png create mode 100644 docs/doxygen-user_fr/images/tagging_view_options.png create mode 100644 docs/doxygen-user_fr/images/threadcount.PNG create mode 100644 docs/doxygen-user_fr/images/thumbnail-result-viewer-tab.PNG create mode 100644 docs/doxygen-user_fr/images/timeline_counts_view.png create mode 100644 docs/doxygen-user_fr/images/timeline_details_view.png create mode 100644 docs/doxygen-user_fr/images/timeline_list_view.png create mode 100644 docs/doxygen-user_fr/images/transientcache.PNG create mode 100644 docs/doxygen-user_fr/images/triage/createVHD.png create mode 100644 docs/doxygen-user_fr/images/triage/fileFilter.png create mode 100644 docs/doxygen-user_fr/images/triage/fileFilterImage.png create mode 100644 docs/doxygen-user_fr/images/triage/ingestProfile.png create mode 100644 docs/doxygen-user_fr/images/triage/pipelineFolders.png create mode 100644 docs/doxygen-user_fr/images/triage/profileSelect.png create mode 100644 docs/doxygen-user_fr/images/troubleshooting_log_menu.png create mode 100644 docs/doxygen-user_fr/images/troubleshooting_thread.png create mode 100644 docs/doxygen-user_fr/images/ui-layout-1.PNG create mode 100644 docs/doxygen-user_fr/images/ui_layout_group_tree.PNG create mode 100644 docs/doxygen-user_fr/images/ui_person_select.png create mode 100644 docs/doxygen-user_fr/images/ui_tree_top_ds.png create mode 100644 docs/doxygen-user_fr/images/ui_tree_top_persons.png create mode 100644 docs/doxygen-user_fr/images/unallocated_space_options.PNG create mode 100644 docs/doxygen-user_fr/images/updatedSolr_cmd.PNG create mode 100644 docs/doxygen-user_fr/images/urlInAddressbar.PNG create mode 100644 docs/doxygen-user_fr/images/users.properties.after.PNG create mode 100644 docs/doxygen-user_fr/images/users.properties.before.PNG create mode 100644 docs/doxygen-user_fr/images/view_options_gear.png create mode 100644 docs/doxygen-user_fr/images/view_options_gmt.png create mode 100644 docs/doxygen-user_fr/images/view_options_hide_slack.png create mode 100644 docs/doxygen-user_fr/images/view_options_local_time.png create mode 100644 docs/doxygen-user_fr/images/view_options_options_panel.png create mode 100644 docs/doxygen-user_fr/images/view_options_reject_account.png create mode 100644 docs/doxygen-user_fr/images/view_options_sco.png create mode 100644 docs/doxygen-user_fr/images/view_options_show_slack.png create mode 100644 docs/doxygen-user_fr/images/views_grouped_tree.png create mode 100644 docs/doxygen-user_fr/images/views_standard_tree.png create mode 100644 docs/doxygen-user_fr/images/virtual_machine_extractor_results.png create mode 100644 docs/doxygen-user_fr/images/volatility_dsp_config.PNG create mode 100644 docs/doxygen-user_fr/images/volatility_dsp_interesting_items.PNG create mode 100644 docs/doxygen-user_fr/images/volatility_dsp_module_output.PNG create mode 100644 docs/doxygen-user_fr/images/volatility_dsp_select.png create mode 100644 docs/doxygen-user_fr/images/wherejava.PNG create mode 100644 docs/doxygen-user_fr/images/xry_dsp.png create mode 100644 docs/doxygen-user_fr/images/xry_folder.png create mode 100644 docs/doxygen-user_fr/images/yara_ingest_settings.png create mode 100644 docs/doxygen-user_fr/images/yara_new_rule_set.png create mode 100644 docs/doxygen-user_fr/images/yara_options.png create mode 100644 docs/doxygen-user_fr/images/yara_results.png create mode 100644 docs/doxygen-user_fr/images/zipped_children_1.PNG create mode 100644 docs/doxygen-user_fr/images/zipped_children_2.PNG create mode 100644 docs/doxygen-user_fr/images/zipped_context_menu.png create mode 100644 docs/doxygen-user_fr/images/zipped_encryption_detected.png create mode 100644 docs/doxygen-user_fr/images/zipped_tree.png create mode 100644 docs/doxygen-user_fr/images/zooDir.PNG create mode 100644 docs/doxygen-user_fr/images/zooPurge.PNG create mode 100644 docs/doxygen-user_fr/ingest.dox create mode 100644 docs/doxygen-user_fr/ingest_template.xod create mode 100644 docs/doxygen-user_fr/installation.dox create mode 100644 docs/doxygen-user_fr/interesting_files.dox create mode 100644 docs/doxygen-user_fr/keyword_search.dox create mode 100644 docs/doxygen-user_fr/live_triage.dox create mode 100644 docs/doxygen-user_fr/logical_imager.dox create mode 100644 docs/doxygen-user_fr/logs_and_output_page.dox create mode 100644 docs/doxygen-user_fr/machine_translation.dox create mode 100644 docs/doxygen-user_fr/main.dox create mode 100644 docs/doxygen-user_fr/manifest_tool.dox create mode 100644 docs/doxygen-user_fr/module_install.dox create mode 100644 docs/doxygen-user_fr/multi-user/createMultiUserCase.dox create mode 100644 docs/doxygen-user_fr/multi-user/installActiveMQ.dox create mode 100644 docs/doxygen-user_fr/multi-user/installMultiUser.dox create mode 100644 docs/doxygen-user_fr/multi-user/installMultiUserClient.dox create mode 100644 docs/doxygen-user_fr/multi-user/installPostgres.dox create mode 100644 docs/doxygen-user_fr/multi-user/installSharedStorage.dox create mode 100644 docs/doxygen-user_fr/multi-user/installSolr.dox create mode 100644 docs/doxygen-user_fr/multi-user/installSystems.dox create mode 100644 docs/doxygen-user_fr/multi-user/installUsers.dox create mode 100644 docs/doxygen-user_fr/multi-user/multiuser-security.dox create mode 100644 docs/doxygen-user_fr/multi-user/upgradeSolr8.dox create mode 100644 docs/doxygen-user_fr/object_detection.dox create mode 100644 docs/doxygen-user_fr/performance.dox create mode 100644 docs/doxygen-user_fr/personas.dox create mode 100644 docs/doxygen-user_fr/photorec_carver.dox create mode 100644 docs/doxygen-user_fr/plaso.dox create mode 100644 docs/doxygen-user_fr/portable_case.dox create mode 100644 docs/doxygen-user_fr/quick_start_guide.dox create mode 100644 docs/doxygen-user_fr/recent_activity.dox create mode 100644 docs/doxygen-user_fr/reporting.dox create mode 100644 docs/doxygen-user_fr/result_viewer.dox create mode 100644 docs/doxygen-user_fr/search_all_cases.dox create mode 100644 docs/doxygen-user_fr/stix.dox create mode 100644 docs/doxygen-user_fr/tagging.dox create mode 100644 docs/doxygen-user_fr/timeline.dox create mode 100644 docs/doxygen-user_fr/translations.dox create mode 100644 docs/doxygen-user_fr/tree_viewer.dox create mode 100644 docs/doxygen-user_fr/triage.dox create mode 100644 docs/doxygen-user_fr/troubleshooting.dox create mode 100644 docs/doxygen-user_fr/ui_quick_search.dox create mode 100644 docs/doxygen-user_fr/uilayout.dox create mode 100644 docs/doxygen-user_fr/updating_interesting_file_sets.dox create mode 100644 docs/doxygen-user_fr/view_options.dox create mode 100644 docs/doxygen-user_fr/vm_module.dox create mode 100644 docs/doxygen-user_fr/volatility_dsp.dox create mode 100644 docs/doxygen-user_fr/workflow.dox create mode 100644 docs/doxygen-user_fr/yara.dox diff --git a/docs/doxygen-user_fr/Doxyfile b/docs/doxygen-user_fr/Doxyfile new file mode 100644 index 0000000000..d00e28635a --- /dev/null +++ b/docs/doxygen-user_fr/Doxyfile @@ -0,0 +1,2366 @@ +# Doxyfile 1.8.9.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Autopsy User Documentation" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = 4.18.0 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Graphical digital forensics platform for The Sleuth Kit and other tools." + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = user-docs + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = YES + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text " + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + + +INPUT = . + + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.dox + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = images/ + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = 4.18.0 + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = footer.html + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = YES + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = YES + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Doxygen + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = YES + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = YES + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /