SONAR-1663 include the dbcleaner plugin + move all purges in this plugin

3 files changed, 212 insertions, 0 deletions

diff --git a/sonar-deprecated/src/main/java/org/sonar/api/batch/Purge.java b/sonar-deprecated/src/main/java/org/sonar/api/batch/Purge.java
new file mode 100644
index 00000000000..d08323bb23a
--- /dev/null
+++ b/sonar-deprecated/src/main/java/org/sonar/api/batch/Purge.java
@@ -0,0 +1,42 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2009 SonarSource SA
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * Sonar is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.api.batch;
+
+import org.sonar.api.BatchExtension;
+
+/**
+ * Extension point to purge data.
+ * <p/>
+ * <p>It is executed when the batch finishes.
+ *
+ * @since 1.10
+ * @deprecated since 2.5. The DBCleaner plugin implements all required purge taks.
+ */
+@Deprecated
+public interface Purge extends BatchExtension {
+
+  /**
+   * Snapshots include the current snapshot (flagged as last) and optionally the penultimate one.
+   *
+   * @snapshots never null.
+   */
+  void purge(PurgeContext context);
+
+}
diff --git a/sonar-deprecated/src/main/java/org/sonar/api/batch/PurgeContext.java b/sonar-deprecated/src/main/java/org/sonar/api/batch/PurgeContext.java
new file mode 100644
index 00000000000..92a1f1f2e8e
--- /dev/null
+++ b/sonar-deprecated/src/main/java/org/sonar/api/batch/PurgeContext.java
@@ -0,0 +1,33 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2009 SonarSource SA
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * Sonar is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.api.batch;
+
+/**
+ * 
+ * @since 1.10
+ * @deprecated since 2.5
+ */
+@Deprecated
+public interface PurgeContext {
+
+  Integer getPreviousSnapshotId();
+
+  Integer getLastSnapshotId();
+}
diff --git a/sonar-deprecated/src/main/java/org/sonar/core/purge/AbstractPurge.java b/sonar-deprecated/src/main/java/org/sonar/core/purge/AbstractPurge.java
new file mode 100644
index 00000000000..a0f46d286d1
--- /dev/null
+++ b/sonar-deprecated/src/main/java/org/sonar/core/purge/AbstractPurge.java
@@ -0,0 +1,137 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2009 SonarSource SA
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * Sonar is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.core.purge;
+
+import org.sonar.api.batch.Purge;
+import org.sonar.api.database.DatabaseSession;
+import org.sonar.api.database.model.*;
+import org.sonar.api.design.DependencyDto;
+import org.sonar.api.utils.TimeProfiler;
+
+import javax.persistence.Query;
+import java.util.List;
+
+public abstract class AbstractPurge implements Purge {
+
+  private static final int MAX_IN_ELEMENTS = 950;
+
+  private int sqlInPageSize = MAX_IN_ELEMENTS;
+  private DatabaseSession session;
+  private TimeProfiler profiler = new TimeProfiler().setLevelToDebug();
+
+  public AbstractPurge(DatabaseSession session) {
+    this.session = session;
+  }
+
+  protected DatabaseSession getSession() {
+    return session;
+  }
+
+  /**
+   * Delete SNAPSHOTS and all dependent tables (MEASURES, ...)
+   */
+  protected void deleteSnapshotData(List<Integer> snapshotIds) {
+    deleteMeasuresBySnapshotId(snapshotIds);
+    deleteSources(snapshotIds);
+    deleteViolations(snapshotIds);
+    deleteDependencies(snapshotIds);
+    deleteSnapshots(snapshotIds);
+  }
+
+  protected void deleteDependencies(List<Integer> snapshotIds) {
+    executeQuery("delete dependencies", snapshotIds, "delete from " + DependencyDto.class.getSimpleName() + " d where d.fromSnapshotId in (:ids)");
+    executeQuery("delete dependencies", snapshotIds, "delete from " + DependencyDto.class.getSimpleName() + " d where d.toSnapshotId in (:ids)");
+  }
+
+  /**
+   * Delete all measures, including MEASURE_DATA
+   */
+  protected void deleteMeasuresBySnapshotId(List<Integer> snapshotIds) {
+    executeQuery("delete measures by snapshot id", snapshotIds, "delete from " + MeasureData.class.getSimpleName() + " m where m.snapshotId in (:ids)");
+    executeQuery("delete measures by snapshot id", snapshotIds, "delete from " + MeasureModel.class.getSimpleName() + " m where m.snapshotId in (:ids)");
+  }
+
+  /**
+   * Delete all measures, including MEASURE_DATA
+   */
+  protected void deleteMeasuresById(List<Integer> measureIds) {
+    executeQuery("delete measures by id", measureIds, "delete from " + MeasureData.class.getSimpleName() + " m where m.measure.id in (:ids)");
+    executeQuery("delete measures by id", measureIds, "delete from " + MeasureModel.class.getSimpleName() + " m where m.id in (:ids)");
+  }
+
+  /**
+   * Delete SNAPSHOT_SOURCES table
+   */
+  protected void deleteSources(List<Integer> snapshotIds) {
+    executeQuery("delete sources", snapshotIds, "delete from " + SnapshotSource.class.getSimpleName() + " e where e.snapshotId in (:ids)");
+  }
+
+  /**
+   * Delete violations (RULE_FAILURES table)
+   */
+  protected void deleteViolations(List<Integer> snapshotIds) {
+    executeQuery("delete violations", snapshotIds, "delete from " + RuleFailureModel.class.getSimpleName() + " e where e.snapshotId in (:ids)");
+  }
+
+  /**
+   * Delete SNAPSHOTS table
+   */
+  protected void deleteSnapshots(List<Integer> snapshotIds) {
+    executeQuery("delete snapshots", snapshotIds, "delete from " + Snapshot.class.getSimpleName() + " s where s.id in (:ids)");
+  }
+
+  /**
+   * Paginate execution of SQL requests to avoid exceeding size of rollback segment
+   */
+  private void executeQuery(String name, List<Integer> ids, String hql) {
+    if (ids == null || ids.isEmpty()) {
+      return;
+    }
+
+    TimeProfiler profiler = new TimeProfiler().setLevelToDebug().start("Execute " + name);
+
+    int page = 1;
+    int index = 0;
+    while (index < ids.size()) {
+      TimeProfiler pageProfiler = new TimeProfiler().setLevelToDebug().start("Execute " + name + " " + page + " page");
+      Query query = session.createQuery(hql);
+      List<Integer> paginedSids = ids.subList(index, Math.min(ids.size(), index + sqlInPageSize));
+      query.setParameter("ids", paginedSids);
+      query.executeUpdate();
+      index += sqlInPageSize;
+      page++;
+      session.commit();
+      pageProfiler.stop();
+    }
+
+    profiler.stop();
+  }
+
+  protected void executeQuery(List<Integer> ids, String hql) {
+    executeQuery("delete for " + getClass().getSimpleName(), ids, hql);
+  }
+
+  protected List<Integer> selectIds(Query query) {
+    profiler.start("Select IDs for " + getClass().getSimpleName());
+    List<Integer> result = query.getResultList();
+    profiler.stop();
+    return result;
+  }
+}