001 /*
002 * Sonar, open source software quality management tool.
003 * Copyright (C) 2008-2012 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * Sonar is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * Sonar is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public
017 * License along with Sonar; if not, write to the Free Software
018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
019 */
020 package org.sonar.batch.index;
021
022 import com.google.common.collect.Maps;
023 import org.apache.commons.lang.ObjectUtils;
024 import org.apache.commons.lang.StringUtils;
025 import org.sonar.api.database.DatabaseSession;
026 import org.sonar.api.database.model.ResourceModel;
027 import org.sonar.api.database.model.Snapshot;
028 import org.sonar.api.resources.*;
029 import org.sonar.api.utils.SonarException;
030
031 import javax.persistence.NonUniqueResultException;
032 import javax.persistence.Query;
033 import java.util.Date;
034 import java.util.Iterator;
035 import java.util.List;
036 import java.util.Map;
037
038 public final class DefaultResourcePersister implements ResourcePersister {
039
040 private DatabaseSession session;
041
042 private Map<Resource, Snapshot> snapshotsByResource = Maps.newHashMap();
043
044 public DefaultResourcePersister(DatabaseSession session) {
045 this.session = session;
046 }
047
048 public Snapshot saveProject(Project project, Project parent) {
049 Snapshot snapshot = snapshotsByResource.get(project);
050 if (snapshot == null) {
051 snapshot = persistProject(project, parent);
052 addToCache(project, snapshot);
053 }
054 return snapshot;
055 }
056
057 private void addToCache(Resource resource, Snapshot snapshot) {
058 if (snapshot != null) {
059 snapshotsByResource.put(resource, snapshot);
060 }
061 }
062
063 private Snapshot persistProject(Project project, Project parent) {
064 // temporary hack
065 project.setEffectiveKey(project.getKey());
066
067 ResourceModel model = findOrCreateModel(project);
068 model.setLanguageKey(project.getLanguageKey());// ugly, only for projects
069
070 Snapshot parentSnapshot = null;
071 if (parent != null) {
072 // assume that the parent project has already been saved
073 parentSnapshot = snapshotsByResource.get(project.getParent());
074 model.setRootId((Integer) ObjectUtils.defaultIfNull(parentSnapshot.getRootProjectId(), parentSnapshot.getResourceId()));
075 }
076 model = session.save(model);
077 project.setId(model.getId());
078
079 Snapshot snapshot = new Snapshot(model, parentSnapshot);
080 snapshot.setVersion(project.getAnalysisVersion());
081 snapshot.setCreatedAt(project.getAnalysisDate());
082 snapshot.setBuildDate(new Date());
083 snapshot = session.save(snapshot);
084 session.commit();
085 return snapshot;
086 }
087
088 public Snapshot getSnapshot(Resource reference) {
089 return snapshotsByResource.get(reference);
090 }
091
092 public Snapshot getSnapshotOrFail(Resource resource) {
093 Snapshot snapshot = getSnapshot(resource);
094 if (snapshot == null) {
095 throw new ResourceNotPersistedException(resource);
096 }
097 return snapshot;
098 }
099
100 /**
101 * just for unit tests
102 */
103 Map<Resource, Snapshot> getSnapshotsByResource() {
104 return snapshotsByResource;
105 }
106
107
108 public Snapshot saveResource(Project project, Resource resource) {
109 return saveResource(project, resource, null);
110 }
111
112 public Snapshot saveResource(Project project, Resource resource, Resource parent) {
113 Snapshot snapshot = snapshotsByResource.get(resource);
114 if (snapshot == null) {
115 snapshot = persist(project, resource, parent);
116 addToCache(resource, snapshot);
117 }
118 return snapshot;
119 }
120
121
122 private Snapshot persist(Project project, Resource resource, Resource parent) {
123 Snapshot snapshot;
124 if (resource instanceof Project) {
125 // should not occur, please use the method saveProject()
126 snapshot = persistProject((Project) resource, project);
127
128 } else if (resource instanceof Library) {
129 snapshot = persistLibrary(project, (Library) resource);
130
131 } else {
132 snapshot = persistFileOrDirectory(project, resource, parent);
133 }
134
135 return snapshot;
136 }
137
138
139 private Snapshot persistLibrary(Project project, Library library) {
140 ResourceModel model = findOrCreateModel(library);
141 model = session.save(model);
142 library.setId(model.getId()); // TODO to be removed
143 library.setEffectiveKey(library.getKey());
144
145 Snapshot snapshot = findLibrarySnapshot(model.getId(), library.getVersion());
146 if (snapshot == null) {
147 snapshot = new Snapshot(model, null);
148 snapshot.setCreatedAt(project.getAnalysisDate());
149 snapshot.setBuildDate(new Date());
150 snapshot.setVersion(library.getVersion());
151 snapshot.setStatus(Snapshot.STATUS_PROCESSED);
152
153 // see http://jira.codehaus.org/browse/SONAR-1850
154 // The qualifier must be LIB, even if the resource is TRK, because this snapshot has no measures.
155 snapshot.setQualifier(Qualifiers.LIBRARY);
156 snapshot = session.save(snapshot);
157 }
158 session.commit();
159 return snapshot;
160 }
161
162 private Snapshot findLibrarySnapshot(Integer resourceId, String version) {
163 Query query = session.createQuery("from " + Snapshot.class.getSimpleName() +
164 " s WHERE s.resourceId=:resourceId AND s.version=:version AND s.scope=:scope AND s.qualifier<>:qualifier AND s.last=:last");
165 query.setParameter("resourceId", resourceId);
166 query.setParameter("version", version);
167 query.setParameter("scope", Scopes.PROJECT);
168 query.setParameter("qualifier", Qualifiers.LIBRARY);
169 query.setParameter("last", Boolean.TRUE);
170 List<Snapshot> snapshots = query.getResultList();
171 if (snapshots.isEmpty()) {
172 snapshots = session.getResults(Snapshot.class, "resourceId", resourceId, "version", version, "scope", Scopes.PROJECT, "qualifier", Qualifiers.LIBRARY);
173 }
174 return (snapshots.isEmpty() ? null : snapshots.get(0));
175 }
176
177 /**
178 * Everything except project and library
179 */
180 private Snapshot persistFileOrDirectory(Project project, Resource resource, Resource parentReference) {
181 ResourceModel model = findOrCreateModel(resource);
182 Snapshot projectSnapshot = snapshotsByResource.get(project);
183 model.setRootId(projectSnapshot.getResourceId());
184 model = session.save(model);
185 resource.setId(model.getId());
186
187 Snapshot parentSnapshot = (Snapshot) ObjectUtils.defaultIfNull(getSnapshot(parentReference), projectSnapshot);
188 Snapshot snapshot = new Snapshot(model, parentSnapshot);
189 snapshot.setBuildDate(new Date());
190 snapshot = session.save(snapshot);
191 session.commit();
192 return snapshot;
193 }
194
195 public Snapshot getLastSnapshot(Snapshot snapshot, boolean onlyOlder) {
196 String hql = "SELECT s FROM " + Snapshot.class.getSimpleName() + " s WHERE s.last=:last AND s.resourceId=:resourceId";
197 if (onlyOlder) {
198 hql += " AND s.createdAt<:date";
199 }
200 Query query = session.createQuery(hql);
201 query.setParameter("last", true);
202 query.setParameter("resourceId", snapshot.getResourceId());
203 if (onlyOlder) {
204 query.setParameter("date", snapshot.getCreatedAt());
205 }
206 return session.getSingleResult(query, null);
207 }
208
209 public void clear() {
210 // we keep cache of projects
211 for (Iterator<Map.Entry<Resource, Snapshot>> it = snapshotsByResource.entrySet().iterator(); it.hasNext(); ) {
212 Map.Entry<Resource, Snapshot> entry = it.next();
213 if (!ResourceUtils.isSet(entry.getKey())) {
214 it.remove();
215 }
216 }
217 }
218
219 private ResourceModel findOrCreateModel(Resource resource) {
220 ResourceModel model;
221 try {
222 model = session.getSingleResult(ResourceModel.class, "key", resource.getEffectiveKey());
223 if (model == null) {
224 model = createModel(resource);
225
226 } else {
227 mergeModel(model, resource);
228 }
229 return model;
230
231 } catch (NonUniqueResultException e) {
232 throw new SonarException("The resource '" + resource.getEffectiveKey() + "' is duplicated in database.", e);
233 }
234 }
235
236 static ResourceModel createModel(Resource resource) {
237 ResourceModel model = new ResourceModel();
238 model.setEnabled(Boolean.TRUE);
239 model.setDescription(resource.getDescription());
240 model.setKey(resource.getEffectiveKey());
241 if (resource.getLanguage() != null) {
242 model.setLanguageKey(resource.getLanguage().getKey());
243 }
244 if (StringUtils.isNotBlank(resource.getName())) {
245 model.setName(resource.getName());
246 } else {
247 model.setName(resource.getKey());
248 }
249 model.setLongName(resource.getLongName());
250 model.setScope(resource.getScope());
251 model.setQualifier(resource.getQualifier());
252 return model;
253 }
254
255 static void mergeModel(ResourceModel model, Resource resource) {
256 model.setEnabled(true);
257 if (StringUtils.isNotBlank(resource.getName())) {
258 model.setName(resource.getName());
259 }
260 if (StringUtils.isNotBlank(resource.getLongName())) {
261 model.setLongName(resource.getLongName());
262 }
263 if (StringUtils.isNotBlank(resource.getDescription())) {
264 model.setDescription(resource.getDescription());
265 }
266 if (!ResourceUtils.isLibrary(resource)) {
267 model.setScope(resource.getScope());
268 model.setQualifier(resource.getQualifier());
269 }
270 if (resource.getLanguage() != null) {
271 model.setLanguageKey(resource.getLanguage().getKey());
272 }
273 }
274 }