-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
DBDocVisitor.java
225 lines (186 loc) · 8.83 KB
/
DBDocVisitor.java
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
package liquibase.changelog.visitor;
import liquibase.change.Change;
import liquibase.changelog.ChangeSet;
import liquibase.changelog.DatabaseChangeLog;
import liquibase.changelog.filter.ChangeSetFilterResult;
import liquibase.database.Database;
import liquibase.dbdoc.*;
import liquibase.exception.LiquibaseException;
import liquibase.resource.OpenOptions;
import liquibase.resource.Resource;
import liquibase.resource.ResourceAccessor;
import liquibase.snapshot.DatabaseSnapshot;
import liquibase.snapshot.SnapshotControl;
import liquibase.snapshot.SnapshotGeneratorFactory;
import liquibase.structure.DatabaseObject;
import liquibase.structure.core.Column;
import liquibase.structure.core.Table;
import liquibase.util.StreamUtil;
import java.io.*;
import java.util.*;
public class DBDocVisitor implements ChangeSetVisitor {
private static final int MAX_RECENT_CHANGE = 50;
private Database database;
private SortedSet<ChangeLogInfo> changeLogs;
private Map<DatabaseObject, List<Change>> changesByObject;
private Map<String, List<Change>> changesByAuthor;
private Map<DatabaseObject, List<Change>> changesToRunByObject;
private Map<String, List<Change>> changesToRunByAuthor;
private List<Change> changesToRun;
private List<Change> recentChanges;
private String rootChangeLogName;
private DatabaseChangeLog rootChangeLog;
public DBDocVisitor(Database database) {
this.database = database;
changesByObject = new HashMap<>();
changesByAuthor = new HashMap<>();
changeLogs = new TreeSet<>();
changesToRunByObject = new HashMap<>();
changesToRunByAuthor = new HashMap<>();
changesToRun = new ArrayList<>();
recentChanges = new ArrayList<>();
}
@Override
public ChangeSetVisitor.Direction getDirection() {
return ChangeSetVisitor.Direction.FORWARD;
}
@Override
public void visit(ChangeSet changeSet, DatabaseChangeLog databaseChangeLog, Database database, Set<ChangeSetFilterResult> filterResults) throws LiquibaseException {
ChangeSet.RunStatus runStatus = this.database.getRunStatus(changeSet);
if (rootChangeLogName == null) {
rootChangeLogName = changeSet.getFilePath();
}
if (rootChangeLog == null) {
this.rootChangeLog = databaseChangeLog;
}
if (!changesByAuthor.containsKey(changeSet.getAuthor())) {
changesByAuthor.put(changeSet.getAuthor(), new ArrayList<Change>());
}
if (!changesToRunByAuthor.containsKey(changeSet.getAuthor())) {
changesToRunByAuthor.put(changeSet.getAuthor(), new ArrayList<Change>());
}
boolean toRun = runStatus.equals(ChangeSet.RunStatus.NOT_RAN) || runStatus.equals(ChangeSet.RunStatus.RUN_AGAIN);
for (Change change : changeSet.getChanges()) {
if (toRun) {
changesToRunByAuthor.get(changeSet.getAuthor()).add(change);
changesToRun.add(change);
} else {
changesByAuthor.get(changeSet.getAuthor()).add(change);
recentChanges.add(0, change);
}
}
ChangeLogInfo changeLogInfo = new ChangeLogInfo(changeSet.getChangeLog().getLogicalFilePath(), changeSet.getChangeLog().getPhysicalFilePath());
if (!changeLogs.contains(changeLogInfo)) {
changeLogs.add(changeLogInfo);
}
for (Change change : changeSet.getChanges()) {
Set<DatabaseObject> affectedDatabaseObjects = change.getAffectedDatabaseObjects(database);
if (affectedDatabaseObjects != null) {
for (DatabaseObject dbObject : affectedDatabaseObjects) {
if (toRun) {
if (!changesToRunByObject.containsKey(dbObject)) {
changesToRunByObject.put(dbObject, new ArrayList<Change>());
}
changesToRunByObject.get(dbObject).add(change);
} else {
if (!changesByObject.containsKey(dbObject)) {
changesByObject.put(dbObject, new ArrayList<Change>());
}
changesByObject.get(dbObject).add(change);
}
}
}
}
}
public void writeHTML(Resource rootOutputDir, ResourceAccessor resourceAccessor) throws IOException,
LiquibaseException {
ChangeLogWriter changeLogWriter = new ChangeLogWriter(resourceAccessor, rootOutputDir);
HTMLWriter authorWriter = new AuthorWriter(rootOutputDir, database);
HTMLWriter tableWriter = new TableWriter(rootOutputDir, database);
HTMLWriter columnWriter = new ColumnWriter(rootOutputDir, database);
HTMLWriter pendingChangesWriter = new PendingChangesWriter(rootOutputDir, database);
HTMLWriter recentChangesWriter = new RecentChangesWriter(rootOutputDir, database);
HTMLWriter pendingSQLWriter = new PendingSQLWriter(rootOutputDir, database, rootChangeLog);
copyFile("liquibase/dbdoc/stylesheet.css", rootOutputDir);
copyFile("liquibase/dbdoc/index.html", rootOutputDir);
copyFile("liquibase/dbdoc/globalnav.html", rootOutputDir);
copyFile("liquibase/dbdoc/overview-summary.html", rootOutputDir);
DatabaseSnapshot snapshot = SnapshotGeneratorFactory.getInstance().createSnapshot(database.getDefaultSchema(), database, new SnapshotControl(database));
new ChangeLogListWriter(rootOutputDir).writeHTML(changeLogs);
SortedSet<Table> tables = new TreeSet<>(snapshot.get(Table.class));
Iterator<Table> tableIterator = tables.iterator();
while (tableIterator.hasNext()) {
if (database.isLiquibaseObject(tableIterator.next())) {
tableIterator.remove();
}
}
new TableListWriter(rootOutputDir).writeHTML(tables);
new AuthorListWriter(rootOutputDir).writeHTML(new TreeSet<Object>(changesByAuthor.keySet()));
for (String author : changesByAuthor.keySet()) {
authorWriter.writeHTML(author, changesByAuthor.get(author), changesToRunByAuthor.get(author), rootChangeLogName);
}
for (Table table : tables) {
if (database.isLiquibaseObject(table)) {
continue;
}
tableWriter.writeHTML(table, changesByObject.get(table), changesToRunByObject.get(table), rootChangeLogName);
}
for (Column column : snapshot.get(Column.class)) {
if (database.isLiquibaseObject(column.getRelation())) {
continue;
}
columnWriter.writeHTML(column, changesByObject.get(column), changesToRunByObject.get(column), rootChangeLogName);
}
for (ChangeLogInfo changeLog : changeLogs) {
changeLogWriter.writeChangeLog(changeLog.logicalPath, changeLog.physicalPath);
}
pendingChangesWriter.writeHTML("index", null, changesToRun, rootChangeLogName);
pendingSQLWriter.writeHTML("sql", null, changesToRun, rootChangeLogName);
if (recentChanges.size() > MAX_RECENT_CHANGE) {
recentChanges = recentChanges.subList(0, MAX_RECENT_CHANGE);
}
recentChangesWriter.writeHTML("index", recentChanges, null, rootChangeLogName);
}
private void copyFile(String fileToCopy, Resource rootOutputDir) throws IOException {
InputStream inputStream = getClass().getClassLoader().getResourceAsStream(fileToCopy);
OutputStream outputStream = null;
try {
if (inputStream == null) {
throw new IOException("Can not find " + fileToCopy);
}
outputStream = rootOutputDir.resolve(fileToCopy.replaceFirst(".*\\/", "")).openOutputStream(new OpenOptions());
StreamUtil.copy(inputStream, outputStream);
} finally {
if (outputStream != null) {
outputStream.close();
}
}
}
private static class ChangeLogInfo implements Comparable<ChangeLogInfo> {
public String logicalPath;
public String physicalPath;
private ChangeLogInfo(String logicalPath, String physicalPath) {
this.logicalPath = logicalPath;
this.physicalPath = physicalPath;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if ((o == null) || (getClass() != o.getClass())) return false;
ChangeLogInfo that = (ChangeLogInfo) o;
return logicalPath.equals(that.logicalPath);
}
@Override
public int hashCode() {
return logicalPath.hashCode();
}
@Override
public int compareTo(ChangeLogInfo o) {
return this.logicalPath.compareTo(o.logicalPath);
}
@Override
public String toString() {
return logicalPath;
}
}
}