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
|
/*******************************************************************************
* Copyright (c) 2004, 2007 Boeing.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Boeing - initial API and implementation
*******************************************************************************/
package org.eclipse.osee.define.report.internal.wordupdate;
import com.google.common.collect.Lists;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import javax.xml.parsers.ParserConfigurationException;
import org.eclipse.osee.define.report.api.WordArtifactChange;
import org.eclipse.osee.define.report.api.WordUpdateChange;
import org.eclipse.osee.define.report.api.WordUpdateData;
import org.eclipse.osee.framework.core.data.ArtifactId;
import org.eclipse.osee.framework.core.data.BranchId;
import org.eclipse.osee.framework.core.data.IAttributeType;
import org.eclipse.osee.framework.core.enums.CoreAttributeTypes;
import org.eclipse.osee.framework.core.util.WordCoreUtil;
import org.eclipse.osee.framework.jdk.core.type.OseeCoreException;
import org.eclipse.osee.framework.jdk.core.type.OseeStateException;
import org.eclipse.osee.framework.jdk.core.util.Collections;
import org.eclipse.osee.framework.jdk.core.util.Lib;
import org.eclipse.osee.framework.jdk.core.util.xml.Jaxp;
import org.eclipse.osee.logger.Log;
import org.eclipse.osee.orcs.OrcsApi;
import org.eclipse.osee.orcs.data.ArtifactReadable;
import org.eclipse.osee.orcs.data.TransactionReadable;
import org.eclipse.osee.orcs.search.QueryFactory;
import org.eclipse.osee.orcs.transaction.TransactionBuilder;
import org.eclipse.osee.orcs.transaction.TransactionFactory;
import org.osgi.service.event.Event;
import org.osgi.service.event.EventAdmin;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.xml.sax.SAXException;
/**
* @author Ryan D. Brooks
* @author David W. Miller
*/
public class WordUpdateArtifact {
private final OrcsApi orcsApi;
private final QueryFactory queryFactory;
private final Log logger;
private final EventAdmin eventAdmin;
public WordUpdateArtifact(Log logger, OrcsApi orcsApi, EventAdmin eventAdmin) {
this.orcsApi = orcsApi;
this.queryFactory = orcsApi.getQueryFactory();
this.logger = logger;
this.eventAdmin = eventAdmin;
}
public WordUpdateChange updateArtifacts(WordUpdateData data) {
Collection<WordExtractorData> extractorDatas;
Element oleDataElement;
try {
IElementExtractor elementExtractor;
Document document = extractJaxpDocument(data);
if (data.isThreeWayMerge()) {
String guid = orcsApi.getQueryFactory().fromBranch(data.getBranch()).andUuid(
data.getArtifacts().iterator().next()).getResults().getAtMostOneOrNull().getGuid();
elementExtractor = new MergeEditArtifactElementExtractor(guid, document);
} else {
elementExtractor = new WordImageArtifactElementExtractor(document);
}
extractorDatas = elementExtractor.extractElements();
oleDataElement = elementExtractor.getOleDataElement();
} catch (Exception ex) {
throw OseeCoreException.wrap(ex);
}
return wordArtifactUpdate(data, extractorDatas, oleDataElement);
}
public ArtifactReadable getArtifact(BranchId branch, String guid) {
return queryFactory.fromBranch(branch).andGuid(guid).getResults().getExactlyOne();
}
private Document extractJaxpDocument(WordUpdateData data) throws ParserConfigurationException, SAXException, IOException {
Document document;
InputStream stream = new ByteArrayInputStream(data.getWordData());
try {
document = Jaxp.nonDeferredReadXmlDocument(stream, "UTF-8");
} finally {
stream.close();
}
return document;
}
private WordUpdateChange wordArtifactUpdate(WordUpdateData data, Collection<WordExtractorData> extractorDatas, Element oleDataElement) {
List<String> deletedArtifacts = Lists.newArrayList();
WordUpdateChange updateChange = new WordUpdateChange();
try {
TransactionFactory txFactory = orcsApi.getTransactionFactory();
boolean singleArtifact = extractorDatas.size() == 1;
boolean containsOleData = false;
boolean containsWordData = false;
ArtifactId account = ArtifactId.valueOf(data.getUserArtId());
TransactionBuilder txBuilder = txFactory.createTransaction(data.getBranch(), account, data.getComment());
for (WordExtractorData extractorData : extractorDatas) {
ArtifactReadable artifact = getArtifact(data.getBranch(), extractorData.getGuid());
WordArtifactChange artChange = new WordArtifactChange();
artChange.setArtId(artifact.getLocalId());
if (artifact.isDeleted()) {
deletedArtifacts.add(artifact.getName());
} else {
containsOleData = artifact.getAttributeCount(CoreAttributeTypes.WordOleData) > 0;
containsWordData = artifact.getAttributeCount(CoreAttributeTypes.WordTemplateContent) > 0;
if (oleDataElement == null && containsOleData) {
txBuilder.setSoleAttributeFromString(artifact, CoreAttributeTypes.WordOleData, "");
artChange.setChanged(true);
artChange.addChangedAttributeType(CoreAttributeTypes.WordOleData);
} else if (oleDataElement != null && singleArtifact) {
txBuilder.setSoleAttributeFromStream(artifact, CoreAttributeTypes.WordOleData,
new ByteArrayInputStream(WordUtilities.getFormattedContent(oleDataElement)));
artChange.setChanged(true);
if (!containsOleData) {
artChange.setCreated(true);
}
artChange.addChangedAttributeType(CoreAttributeTypes.WordOleData);
}
String content = Lib.inputStreamToString(
new ByteArrayInputStream(WordUtilities.getFormattedContent(extractorData.getParentEelement())));
boolean hasTrackedChanges = WordCoreUtil.containsWordAnnotations(content);
/**
* Only update if: a. editing a single artifact or b. in multi-edit mode only update if the artifact has
* at least one textual change (if the MUTI_EDIT_SAVE_ALL_CHANGES preference is not set).
*/
boolean multiSave = data.isMultiEdit() || hasChangedContent(artifact, content);
if (singleArtifact || multiSave) {
if (!hasTrackedChanges) {
if (extractorData.getParentEelement().getNodeName().endsWith("body")) {
/*
* This code pulls out all of the stuff after the inserted listnum reordering stuff. This needs
* to be here so that we remove unwanted template information from single editing
*/
content = content.replace(WordUtilities.LISTNUM_FIELD_HEAD, "");
}
LinkType linkType = LinkType.OSEE_SERVER_LINK;
content = WordMlLinkHandler.unlink(queryFactory, linkType, artifact, content);
txBuilder.setSoleAttributeValue(artifact, CoreAttributeTypes.WordTemplateContent, content);
artChange.setChanged(true);
if (!containsWordData) {
artChange.setCreated(true);
}
artChange.addChangedAttributeType(CoreAttributeTypes.WordTemplateContent);
} else {
updateChange.setTrackedChangeArts(artifact.getId(), artifact.getName());
}
}
if (artChange.isChanged()) {
artChange.setSafetyRelated(checkIfSafetyRelated(artifact,
CoreAttributeTypes.LegacyDAL) || checkIfSafetyRelated(artifact, CoreAttributeTypes.ItemDAL));
updateChange.addChangedArt(artChange);
artChange.addChangedAttributeType(CoreAttributeTypes.WordTemplateContent);
}
}
}
TransactionReadable tx = txBuilder.commit();
if (tx != null) {
postProcessChange(tx, updateChange, account);
}
} catch (Exception ex) {
throw OseeCoreException.wrap(ex);
} finally {
if (!deletedArtifacts.isEmpty()) {
throw new OseeStateException("The following deleted artifacts could not be saved [%s]",
Collections.toString(",", deletedArtifacts));
}
}
return updateChange;
}
private void postProcessChange(TransactionReadable tx, WordUpdateChange updateChange, ArtifactId account) {
updateChange.setTx(tx);
updateChange.setBranch(tx.getBranch());
if (updateChange.hasSafetyRelatedArtifactChange()) {
try {
HashMap<String, Object> properties = new HashMap<String, Object>();
properties.put(SafetyWorkflowEventHandler.SAFETY_EVENT_BRANCH_ID, tx.getBranch());
properties.put(SafetyWorkflowEventHandler.SAFETY_EVENT_USER_ART, account);
Event event = new Event(SafetyWorkflowEventHandler.SAFETY_EVENT_TOPIC, properties);
eventAdmin.postEvent(event);
} catch (Exception ex) {
logger.error(ex, "Could not create safety workflow");
}
}
}
private boolean hasChangedContent(ArtifactReadable artifact, String content) {
String originalContent = artifact.getSoleAttributeAsString(CoreAttributeTypes.WordTemplateContent, "");
return !WordUtilities.textOnly(originalContent).equals(
WordUtilities.textOnly(content)) || !WordUtilities.referencesOnly(originalContent).equals(
WordUtilities.referencesOnly(content));
}
private boolean checkIfSafetyRelated(ArtifactReadable artifact, IAttributeType dalAttrType) {
String dal = artifact.getSoleAttributeAsString(dalAttrType, "");
return "A".equals(dal) || "B".equals(dal) || "C".equals(dal);
}
}
|
