1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/*
* Copyright 2000-2012 JetBrains s.r.o.
*
* 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 com.intellij.featureStatistics;
import com.intellij.openapi.components.*;
import com.intellij.openapi.project.Project;
import com.intellij.util.xmlb.XmlSerializer;
import org.jdom.Element;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import java.util.List;
import java.util.Set;
@SuppressWarnings({"NonPrivateFieldAccessedInSynchronizedContext"})
@State(
name = "FeatureUsageStatistics",
storages = {@Storage(file = StoragePathMacros.APP_CONFIG + "/feature.usage.statistics.xml", roamingType = RoamingType.DISABLED)}
)
public class FeatureUsageTrackerImpl extends FeatureUsageTracker implements PersistentStateComponent<Element> {
private static final int HOUR = 1000 * 60 * 60;
private static final long DAY = HOUR * 24;
private long FIRST_RUN_TIME = 0;
private CompletionStatistics myCompletionStats = new CompletionStatistics();
private CumulativeStatistics myFixesStats = new CumulativeStatistics();
boolean HAVE_BEEN_SHOWN = false;
private final ProductivityFeaturesRegistry myRegistry;
@NonNls private static final String FEATURE_TAG = "feature";
@NonNls private static final String ATT_SHOW_IN_OTHER = "show-in-other";
@NonNls private static final String ATT_SHOW_IN_COMPILATION = "show-in-compilation";
@NonNls private static final String ATT_ID = "id";
@NonNls private static final String ATT_FIRST_RUN = "first-run";
@NonNls private static final String COMPLETION_STATS_TAG = "completionStatsTag";
@NonNls private static final String FIXES_STATS_TAG = "fixesStatsTag";
@NonNls private static final String ATT_HAVE_BEEN_SHOWN = "have-been-shown";
public FeatureUsageTrackerImpl(ProductivityFeaturesRegistry productivityFeaturesRegistry) {
myRegistry = productivityFeaturesRegistry;
}
public boolean isToBeShown(String featureId, Project project) {
return isToBeShown(featureId, project, DAY);
}
private boolean isToBeShown(String featureId, Project project, final long timeUnit) {
ProductivityFeaturesRegistry registry = ProductivityFeaturesRegistry.getInstance();
FeatureDescriptor descriptor = registry.getFeatureDescriptor(featureId);
if (descriptor == null || !descriptor.isUnused()) return false;
String[] dependencyFeatures = descriptor.getDependencyFeatures();
boolean locked = dependencyFeatures.length > 0;
for (int i = 0; locked && i < dependencyFeatures.length; i++) {
if (!registry.getFeatureDescriptor(dependencyFeatures[i]).isUnused()) {
locked = false;
}
}
if (locked) return false;
ApplicabilityFilter[] filters = registry.getMatchingFilters(featureId);
for (ApplicabilityFilter filter: filters) {
if (!filter.isApplicable(featureId, project)) return false;
}
long current = System.currentTimeMillis();
long succesive_interval = descriptor.getDaysBetweenSuccesiveShowUps() * timeUnit + descriptor.getShownCount() * 2;
long firstShowUpInterval = descriptor.getDaysBeforeFirstShowUp() * timeUnit;
long lastTimeUsed = descriptor.getLastTimeUsed();
long lastTimeShown = descriptor.getLastTimeShown();
return lastTimeShown == 0 && firstShowUpInterval + getFirstRunTime() < current ||
lastTimeShown > 0 && current - lastTimeShown > succesive_interval && current - lastTimeUsed > succesive_interval;
}
@Override
public boolean isToBeAdvertisedInLookup(@NonNls String featureId, Project project) {
FeatureDescriptor descriptor = ProductivityFeaturesRegistry.getInstance().getFeatureDescriptor(featureId);
if (descriptor != null && System.currentTimeMillis() - descriptor.getLastTimeUsed() > 10 * DAY) {
return true;
}
return isToBeShown(featureId, project, HOUR);
}
@NotNull
public CompletionStatistics getCompletionStatistics() {
return myCompletionStats;
}
public CumulativeStatistics getFixesStats() {
return myFixesStats;
}
public long getFirstRunTime() {
if (FIRST_RUN_TIME == 0) {
FIRST_RUN_TIME = System.currentTimeMillis();
}
return FIRST_RUN_TIME;
}
public void loadState(final Element element) {
List featuresList = element.getChildren(FEATURE_TAG);
for (Object aFeaturesList : featuresList) {
Element featureElement = (Element)aFeaturesList;
FeatureDescriptor descriptor =
((ProductivityFeaturesRegistryImpl)myRegistry).getFeatureDescriptorEx(featureElement.getAttributeValue(ATT_ID));
if (descriptor != null) {
descriptor.readStatistics(featureElement);
}
}
try {
FIRST_RUN_TIME = Long.parseLong(element.getAttributeValue(ATT_FIRST_RUN));
}
catch (NumberFormatException e) {
FIRST_RUN_TIME = 0;
}
Element stats = element.getChild(COMPLETION_STATS_TAG);
if (stats != null) {
myCompletionStats = XmlSerializer.deserialize(stats, CompletionStatistics.class);
}
Element fStats = element.getChild(FIXES_STATS_TAG);
if (fStats != null) {
myFixesStats = XmlSerializer.deserialize(fStats, CumulativeStatistics.class);
}
HAVE_BEEN_SHOWN = Boolean.valueOf(element.getAttributeValue(ATT_HAVE_BEEN_SHOWN)).booleanValue();
SHOW_IN_OTHER_PROGRESS = Boolean.valueOf(element.getAttributeValue(ATT_SHOW_IN_OTHER, Boolean.toString(true))).booleanValue();
SHOW_IN_COMPILATION_PROGRESS = Boolean.valueOf(element.getAttributeValue(ATT_SHOW_IN_COMPILATION, Boolean.toString(true))).booleanValue();
}
public Element getState() {
Element element = new Element("state");
ProductivityFeaturesRegistry registry = ProductivityFeaturesRegistry.getInstance();
Set<String> ids = registry.getFeatureIds();
for (String id: ids) {
Element featureElement = new Element(FEATURE_TAG);
featureElement.setAttribute(ATT_ID, id);
FeatureDescriptor descriptor = registry.getFeatureDescriptor(id);
descriptor.writeStatistics(featureElement);
element.addContent(featureElement);
}
Element statsTag = new Element(COMPLETION_STATS_TAG);
XmlSerializer.serializeInto(myCompletionStats, statsTag);
element.addContent(statsTag);
Element fstatsTag = new Element(FIXES_STATS_TAG);
XmlSerializer.serializeInto(myFixesStats, fstatsTag);
element.addContent(fstatsTag);
element.setAttribute(ATT_FIRST_RUN, String.valueOf(getFirstRunTime()));
element.setAttribute(ATT_HAVE_BEEN_SHOWN, String.valueOf(HAVE_BEEN_SHOWN));
element.setAttribute(ATT_SHOW_IN_OTHER, String.valueOf(SHOW_IN_OTHER_PROGRESS));
element.setAttribute(ATT_SHOW_IN_COMPILATION, String.valueOf(SHOW_IN_COMPILATION_PROGRESS));
return element;
}
public void triggerFeatureUsed(String featureId) {
ProductivityFeaturesRegistry registry = ProductivityFeaturesRegistry.getInstance();
FeatureDescriptor descriptor = registry.getFeatureDescriptor(featureId);
if (descriptor == null) {
// TODO: LOG.error("Feature '" + featureId +"' must be registered prior triggerFeatureUsed() is called");
}
else {
descriptor.triggerUsed();
}
}
public void triggerFeatureShown(String featureId) {
FeatureDescriptor descriptor = ProductivityFeaturesRegistry.getInstance().getFeatureDescriptor(featureId);
if (descriptor != null) {
descriptor.triggerShown();
}
}
}
|
