[927] | 1 | // Copyright 2012 Georg-August-Universität Göttingen, Germany
|
---|
| 2 | //
|
---|
| 3 | // Licensed under the Apache License, Version 2.0 (the "License");
|
---|
| 4 | // you may not use this file except in compliance with the License.
|
---|
| 5 | // You may obtain a copy of the License at
|
---|
| 6 | //
|
---|
| 7 | // http://www.apache.org/licenses/LICENSE-2.0
|
---|
| 8 | //
|
---|
| 9 | // Unless required by applicable law or agreed to in writing, software
|
---|
| 10 | // distributed under the License is distributed on an "AS IS" BASIS,
|
---|
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
---|
| 12 | // See the License for the specific language governing permissions and
|
---|
| 13 | // limitations under the License.
|
---|
| 14 |
|
---|
[922] | 15 | package de.ugoe.cs.autoquest.commands.sequences;
|
---|
[1] | 16 |
|
---|
[706] | 17 | import java.io.File;
|
---|
| 18 | import java.io.FileOutputStream;
|
---|
| 19 | import java.io.IOException;
|
---|
| 20 | import java.io.OutputStreamWriter;
|
---|
[203] | 21 | import java.util.Collection;
|
---|
[1] | 22 | import java.util.List;
|
---|
[706] | 23 | import java.util.logging.Level;
|
---|
[1] | 24 |
|
---|
[922] | 25 | import de.ugoe.cs.autoquest.CommandHelpers;
|
---|
| 26 | import de.ugoe.cs.autoquest.IReplayDecorator;
|
---|
| 27 | import de.ugoe.cs.autoquest.SequenceInstanceOf;
|
---|
| 28 | import de.ugoe.cs.autoquest.eventcore.Event;
|
---|
| 29 | import de.ugoe.cs.autoquest.eventcore.IReplayable;
|
---|
[706] | 30 | import de.ugoe.cs.util.StringTools;
|
---|
[1] | 31 | import de.ugoe.cs.util.console.Command;
|
---|
[706] | 32 | import de.ugoe.cs.util.console.Console;
|
---|
[667] | 33 | import de.ugoe.cs.util.console.GlobalDataContainer;
|
---|
[1] | 34 |
|
---|
[171] | 35 | /**
|
---|
[209] | 36 | * <p>
|
---|
| 37 | * Command to create a replay file from stored sessions.
|
---|
| 38 | * </p>
|
---|
| 39 | *
|
---|
[706] | 40 | * TODO: Add appropriate checks if Events are replayable
|
---|
| 41 | *
|
---|
[171] | 42 | * @author Steffen Herbold
|
---|
| 43 | * @version 1.0
|
---|
| 44 | */
|
---|
[1] | 45 | public class CMDgenerateReplayfile implements Command {
|
---|
| 46 |
|
---|
[1663] | 47 | /*
|
---|
| 48 | * (non-Javadoc)
|
---|
| 49 | *
|
---|
| 50 | * @see de.ugoe.cs.util.console.Command#help()
|
---|
| 51 | */
|
---|
| 52 | @Override
|
---|
| 53 | public String help() {
|
---|
| 54 | return "generateReplayfile <filename> <sequences>";
|
---|
| 55 | }
|
---|
[1] | 56 |
|
---|
[1663] | 57 | /*
|
---|
| 58 | * (non-Javadoc)
|
---|
| 59 | *
|
---|
| 60 | * @see de.ugoe.cs.util.console.Command#run(java.util.List)
|
---|
| 61 | */
|
---|
| 62 | @SuppressWarnings("unchecked")
|
---|
| 63 | @Override
|
---|
| 64 | public void run(List<Object> parameters) {
|
---|
| 65 | String filename;
|
---|
| 66 | String sequencesName;
|
---|
| 67 | try {
|
---|
| 68 | filename = (String) parameters.get(0);
|
---|
| 69 | sequencesName = (String) parameters.get(1);
|
---|
| 70 | }
|
---|
| 71 | catch (Exception e) {
|
---|
| 72 | throw new IllegalArgumentException();
|
---|
| 73 | }
|
---|
[209] | 74 |
|
---|
[1663] | 75 | Collection<List<Event>> sequences = null;
|
---|
| 76 | Object dataObject = GlobalDataContainer.getInstance().getData(sequencesName);
|
---|
| 77 | if (dataObject == null) {
|
---|
| 78 | CommandHelpers.objectNotFoundMessage(sequencesName);
|
---|
| 79 | return;
|
---|
| 80 | }
|
---|
| 81 | if (!SequenceInstanceOf.isCollectionOfSequences(dataObject)) {
|
---|
| 82 | CommandHelpers.objectNotType(sequencesName, "Collection<List<Event<?>>>");
|
---|
| 83 | return;
|
---|
| 84 | }
|
---|
[209] | 85 |
|
---|
[1663] | 86 | sequences = (Collection<List<Event>>) dataObject;
|
---|
| 87 | createLogfileMultipleSessions(sequences, filename);
|
---|
| 88 | }
|
---|
[706] | 89 |
|
---|
[1663] | 90 | /**
|
---|
| 91 | * <p>
|
---|
| 92 | * {@link IReplayDecorator} to be used. If this field is {@code null}, no decorator is used.
|
---|
| 93 | * Default: {@code null}
|
---|
| 94 | * </p>
|
---|
| 95 | */
|
---|
| 96 | private IReplayDecorator decorator = null;
|
---|
| 97 |
|
---|
| 98 | /**
|
---|
| 99 | * <p>
|
---|
| 100 | * Id of the current session. The starting id is 1.
|
---|
| 101 | * </p>
|
---|
| 102 | */
|
---|
| 103 | int sessionId = 1;
|
---|
| 104 |
|
---|
| 105 | /**
|
---|
| 106 | * <p>
|
---|
| 107 | * Creates a replay file that contains multiple event sequences.
|
---|
| 108 | * </p>
|
---|
| 109 | *
|
---|
| 110 | * @param sequences
|
---|
| 111 | * collection of event sequences from which the sessions are generated
|
---|
| 112 | * @param filename
|
---|
| 113 | * name and path of the replay file
|
---|
| 114 | */
|
---|
| 115 | private void createLogfileMultipleSessions(Collection<List<Event>> sequences, String filename) {
|
---|
| 116 | OutputStreamWriter writer = openReplayFile(filename);
|
---|
| 117 | if (writer != null) {
|
---|
| 118 | try {
|
---|
| 119 | try {
|
---|
| 120 | decorator =
|
---|
| 121 | sequences.iterator().next().get(0).getReplayables().get(0).getDecorator();
|
---|
| 122 | }
|
---|
| 123 | catch (Exception e) {
|
---|
| 124 | // in the above line, many things can go wrong: emtpy sequences, null
|
---|
| 125 | // references, etc. However, all failures just indicate that no replay decorator
|
---|
| 126 | // should be used, hence, we ignore the exception
|
---|
| 127 | Console.traceln(Level.FINEST, "no decorator used for " + filename);
|
---|
| 128 | }
|
---|
| 129 | if (decorator != null) {
|
---|
| 130 | writer.write(decorator.getHeader());
|
---|
| 131 | }
|
---|
| 132 | for (List<Event> actions : sequences) {
|
---|
| 133 | writeSession(actions, writer);
|
---|
| 134 | }
|
---|
| 135 | if (decorator != null) {
|
---|
| 136 | writer.write(decorator.getFooter());
|
---|
| 137 | }
|
---|
| 138 | decorator = null;
|
---|
| 139 | writer.close();
|
---|
| 140 | }
|
---|
| 141 | catch (IOException e) {
|
---|
| 142 | Console.printerrln("Unable to write replay file " + filename);
|
---|
| 143 | }
|
---|
| 144 | }
|
---|
| 145 | }
|
---|
| 146 |
|
---|
| 147 | /**
|
---|
| 148 | * <p>
|
---|
| 149 | * Helper function that opens the replay file for writing.
|
---|
| 150 | * </p>
|
---|
| 151 | *
|
---|
| 152 | * @param filename
|
---|
| 153 | * name and path of the replay file
|
---|
| 154 | * @param encoding
|
---|
| 155 | * file encoding, empty string for platform default
|
---|
| 156 | * @return {@link OutputStreamWriter} that writes to the replay file
|
---|
| 157 | */
|
---|
[1670] | 158 | protected OutputStreamWriter openReplayFile(String filename, String encoding) {
|
---|
[1663] | 159 | File file = new File(filename);
|
---|
| 160 | boolean fileCreated;
|
---|
| 161 | try {
|
---|
| 162 | fileCreated = file.createNewFile();
|
---|
| 163 | if (!fileCreated) {
|
---|
| 164 | Console.traceln(Level.INFO, "Created logfile " + filename);
|
---|
| 165 | }
|
---|
| 166 | else {
|
---|
| 167 | Console.traceln(Level.INFO, "Overwrote existing logfile " + filename);
|
---|
| 168 | }
|
---|
| 169 | }
|
---|
| 170 | catch (IOException e) {
|
---|
| 171 | Console.printerrln("Unable to create file " + filename);
|
---|
| 172 | Console.logException(e);
|
---|
| 173 | }
|
---|
| 174 | OutputStreamWriter writer = null;
|
---|
| 175 | try {
|
---|
| 176 | if (encoding.isEmpty()) {
|
---|
| 177 | writer = new OutputStreamWriter(new FileOutputStream(file));
|
---|
| 178 | }
|
---|
| 179 | else {
|
---|
| 180 | writer = new OutputStreamWriter(new FileOutputStream(file), encoding);
|
---|
| 181 | }
|
---|
| 182 | }
|
---|
| 183 | catch (IOException e) {
|
---|
| 184 | Console.printerrln("Unable to open file for writing (read-only file):" + filename);
|
---|
| 185 | Console.logException(e);
|
---|
| 186 | }
|
---|
| 187 | return writer;
|
---|
| 188 | }
|
---|
| 189 |
|
---|
[1670] | 190 | /**
|
---|
| 191 | * <p>
|
---|
| 192 | * Helper function that opens the replay file for writing.
|
---|
| 193 | * </p>
|
---|
| 194 | *
|
---|
| 195 | * @param filename
|
---|
| 196 | * name and path of the replay file
|
---|
| 197 | * @return {@link OutputStreamWriter} that writes to the replay file
|
---|
| 198 | */
|
---|
| 199 | protected OutputStreamWriter openReplayFile(String filename) {
|
---|
[1663] | 200 | return openReplayFile(filename, "");
|
---|
| 201 | }
|
---|
| 202 |
|
---|
| 203 | /**
|
---|
| 204 | * <p>
|
---|
| 205 | * Helper function that adds an event sequence to the replay.
|
---|
| 206 | * </p>
|
---|
| 207 | *
|
---|
| 208 | * @param actions
|
---|
| 209 | * event sequences to be added
|
---|
| 210 | * @param writer
|
---|
| 211 | * {@link OutputStreamWriter} to which the replay is added
|
---|
| 212 | * @throws IOException
|
---|
| 213 | * thrown if there is a problem writing to writer
|
---|
| 214 | */
|
---|
| 215 | private void writeSession(List<Event> actions, OutputStreamWriter writer) throws IOException {
|
---|
| 216 | if (decorator != null) {
|
---|
| 217 | writer.write(decorator.getSessionHeader(sessionId));
|
---|
| 218 | }
|
---|
| 219 | for (Event currentAction : actions) {
|
---|
| 220 |
|
---|
| 221 | List<? extends IReplayable> replayables = currentAction.getReplayables();
|
---|
| 222 | for (IReplayable replayble : replayables) {
|
---|
| 223 | writer.write(replayble.getReplay() + StringTools.ENDLINE);
|
---|
| 224 | writer.flush();
|
---|
| 225 | }
|
---|
| 226 | }
|
---|
| 227 | if (decorator != null) {
|
---|
| 228 | writer.write(decorator.getSessionFooter(sessionId));
|
---|
| 229 | }
|
---|
| 230 | sessionId++;
|
---|
| 231 | }
|
---|
[1] | 232 | }
|
---|