Skip to content

Commit b701e79

Browse files
ctruedenctrueden
committed
Add service to track anonymous usage statistics
1 parent dcff0c7 commit b701e79

File tree

4 files changed

+226
-0
lines changed

4 files changed

+226
-0
lines changed

‎src/main/java/org/scijava/usage/DefaultUsageService.java‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
/*
2+
* #%L
3+
* SciJava Common shared library for SciJava software.
4+
* %%
5+
* Copyright (C) 2009 - 2014 Board of Regents of the University of
6+
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
7+
* Institute of Molecular Cell Biology and Genetics.
8+
* %%
9+
* Redistribution and use in source and binary forms, with or without
10+
* modification, are permitted provided that the following conditions are met:
11+
*
12+
* 1. Redistributions of source code must retain the above copyright notice,
13+
* this list of conditions and the following disclaimer.
14+
* 2. Redistributions in binary form must reproduce the above copyright notice,
15+
* this list of conditions and the following disclaimer in the documentation
16+
* and/or other materials provided with the distribution.
17+
*
18+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19+
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20+
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21+
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
22+
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23+
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24+
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25+
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26+
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27+
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28+
* POSSIBILITY OF SUCH DAMAGE.
29+
* #L%
30+
*/
31+
32+
package org.scijava.usage;
33+
34+
import java.util.HashMap;
35+
import java.util.Map;
36+
37+
import org.scijava.Identifiable;
38+
import org.scijava.event.EventHandler;
39+
import org.scijava.module.ModuleInfo;
40+
import org.scijava.module.event.ModuleExecutedEvent;
41+
import org.scijava.plugin.Plugin;
42+
import org.scijava.service.AbstractService;
43+
import org.scijava.service.Service;
44+
45+
/**
46+
* Default service for tracking anonymous usage statistics.
47+
*
48+
* @author Curtis Rueden
49+
*/
50+
@Plugin(type = Service.class)
51+
public class DefaultUsageService extends AbstractService
52+
implements UsageService
53+
{
54+
55+
/** Table of usage statistics. */
56+
private HashMap<String, UsageStats> stats = new HashMap<String, UsageStats>();
57+
58+
// -- UsageService methods --
59+
60+
@Override
61+
public Map<String, UsageStats> getStats() {
62+
return stats;
63+
}
64+
65+
@Override
66+
public void clearStats() {
67+
// NB: Rather than calling stats.clear(), we allocate a new object
68+
// so that references to the old table are not modified.
69+
stats = new HashMap<String, UsageStats>();
70+
}
71+
72+
@Override
73+
public UsageStats getUsage(final Object o) {
74+
if (!(o instanceof Identifiable)) {
75+
// only track objects with an identifier
76+
return null;
77+
}
78+
final String id = ((Identifiable) o).getIdentifier();
79+
if (!stats.containsKey(id)) stats.put(id, new UsageStats(id));
80+
return stats.get(id);
81+
}
82+
83+
@Override
84+
public void increment(final Object o) {
85+
final UsageStats usageStats = getUsage(o);
86+
if (usageStats == null) return;
87+
usageStats.increment();
88+
}
89+
90+
// -- Event handlers --
91+
92+
@EventHandler
93+
private void onEvent(final ModuleExecutedEvent evt) {
94+
final ModuleInfo info = evt.getModule().getInfo();
95+
increment(info);
96+
}
97+
98+
}

‎src/main/java/org/scijava/usage/UsageService.java‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
/*
2+
* #%L
3+
* SciJava Common shared library for SciJava software.
4+
* %%
5+
* Copyright (C) 2009 - 2014 Board of Regents of the University of
6+
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
7+
* Institute of Molecular Cell Biology and Genetics.
8+
* %%
9+
* Redistribution and use in source and binary forms, with or without
10+
* modification, are permitted provided that the following conditions are met:
11+
*
12+
* 1. Redistributions of source code must retain the above copyright notice,
13+
* this list of conditions and the following disclaimer.
14+
* 2. Redistributions in binary form must reproduce the above copyright notice,
15+
* this list of conditions and the following disclaimer in the documentation
16+
* and/or other materials provided with the distribution.
17+
*
18+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19+
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20+
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21+
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
22+
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23+
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24+
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25+
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26+
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27+
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28+
* POSSIBILITY OF SUCH DAMAGE.
29+
* #L%
30+
*/
31+
32+
package org.scijava.usage;
33+
34+
import java.util.Map;
35+
36+
import org.scijava.service.SciJavaService;
37+
38+
/**
39+
* Interface for service that tracks anonymous usage statistics.
40+
*
41+
* @author Curtis Rueden
42+
*/
43+
public interface UsageService extends SciJavaService {
44+
45+
/** Gets the table of usage statistics. */
46+
Map<String, UsageStats> getStats();
47+
48+
/** Clears the table of usage statistics. */
49+
void clearStats();
50+
51+
/** Gets the given object's usage statistics. */
52+
UsageStats getUsage(Object o);
53+
54+
/** Increments the given object's usage count. */
55+
void increment(Object o);
56+
57+
}

‎src/main/java/org/scijava/usage/UsageStats.java‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
/*
2+
* #%L
3+
* SciJava Common shared library for SciJava software.
4+
* %%
5+
* Copyright (C) 2009 - 2014 Board of Regents of the University of
6+
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
7+
* Institute of Molecular Cell Biology and Genetics.
8+
* %%
9+
* Redistribution and use in source and binary forms, with or without
10+
* modification, are permitted provided that the following conditions are met:
11+
*
12+
* 1. Redistributions of source code must retain the above copyright notice,
13+
* this list of conditions and the following disclaimer.
14+
* 2. Redistributions in binary form must reproduce the above copyright notice,
15+
* this list of conditions and the following disclaimer in the documentation
16+
* and/or other materials provided with the distribution.
17+
*
18+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19+
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20+
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21+
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
22+
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23+
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24+
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25+
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26+
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27+
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28+
* POSSIBILITY OF SUCH DAMAGE.
29+
* #L%
30+
*/
31+
32+
package org.scijava.usage;
33+
34+
import org.scijava.Identifiable;
35+
36+
/**
37+
* Data structure storing usage statistics for a particular identifier.
38+
*
39+
* @author Curtis Rueden
40+
*/
41+
public class UsageStats implements Identifiable {
42+
43+
/** The object's unique identifier. */
44+
private String id;
45+
46+
/** Number of times the object was used. */
47+
private long count;
48+
49+
public UsageStats(final String id) {
50+
this.id = id;
51+
}
52+
53+
/** Gets the number of times the object has been used. */
54+
public long getCount() {
55+
return count;
56+
}
57+
58+
/** Increment the object's usage count. */
59+
public void increment() {
60+
count++;
61+
}
62+
63+
// -- Identifiable methods --
64+
65+
@Override
66+
public String getIdentifier() {
67+
return id;
68+
}
69+
70+
}

‎src/test/java/org/scijava/ContextCreationTest.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ public void testFull() {
9393
org.scijava.tool.DefaultToolService.class,
9494
org.scijava.ui.DefaultUIService.class,
9595
org.scijava.ui.dnd.DefaultDragAndDropService.class,
96+
org.scijava.usage.DefaultUsageService.class,
9697
org.scijava.welcome.DefaultWelcomeService.class,
9798
org.scijava.widget.DefaultWidgetService.class,
9899
org.scijava.log.StderrLogService.class,

0 commit comments

Comments
 (0)