1 package net.pterodactylus.sone.core;
3 import static java.util.logging.Logger.getLogger;
4 import static net.pterodactylus.sone.utils.NumberParsers.parseInt;
5 import static net.pterodactylus.sone.utils.NumberParsers.parseLong;
7 import java.io.InputStream;
8 import java.util.ArrayList;
9 import java.util.HashMap;
10 import java.util.HashSet;
11 import java.util.List;
14 import java.util.logging.Level;
15 import java.util.logging.Logger;
17 import net.pterodactylus.sone.data.Album;
18 import net.pterodactylus.sone.data.Client;
19 import net.pterodactylus.sone.data.Image;
20 import net.pterodactylus.sone.data.Post;
21 import net.pterodactylus.sone.data.PostReply;
22 import net.pterodactylus.sone.data.Profile;
23 import net.pterodactylus.sone.data.Sone;
24 import net.pterodactylus.sone.database.PostBuilder;
25 import net.pterodactylus.sone.database.PostReplyBuilder;
26 import net.pterodactylus.sone.database.SoneBuilder;
27 import net.pterodactylus.util.xml.SimpleXML;
28 import net.pterodactylus.util.xml.XML;
30 import org.w3c.dom.Document;
33 * Parses a {@link Sone} from an XML {@link InputStream}.
35 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
37 public class SoneParser {
39 private static final Logger logger = getLogger("Sone.Parser");
40 private static final int MAX_PROTOCOL_VERSION = 0;
41 private final Core core;
43 public SoneParser(Core core) {
47 public Sone parseSone(Sone originalSone, InputStream soneInputStream) throws SoneException {
48 /* TODO - impose a size limit? */
51 /* XML parsing is not thread-safe. */
53 document = XML.transformToDocument(soneInputStream);
55 if (document == null) {
56 /* TODO - mark Sone as bad. */
57 logger.log(Level.WARNING, String.format("Could not parse XML for Sone %s!", originalSone));
61 SoneBuilder soneBuilder = core.soneBuilder().from(originalSone.getIdentity());
62 if (originalSone.isLocal()) {
63 soneBuilder = soneBuilder.local();
68 soneXml = SimpleXML.fromDocument(document);
69 } catch (NullPointerException npe1) {
70 /* for some reason, invalid XML can cause NPEs. */
71 logger.log(Level.WARNING, String.format("XML for Sone %s can not be parsed!", originalSone), npe1);
75 Integer protocolVersion = null;
76 String soneProtocolVersion = soneXml.getValue("protocol-version", null);
77 if (soneProtocolVersion != null) {
78 protocolVersion = parseInt(soneProtocolVersion, null);
80 if (protocolVersion == null) {
81 logger.log(Level.INFO, "No protocol version found, assuming 0.");
85 if (protocolVersion < 0) {
86 logger.log(Level.WARNING, String.format("Invalid protocol version: %d! Not parsing Sone.", protocolVersion));
90 /* check for valid versions. */
91 if (protocolVersion > MAX_PROTOCOL_VERSION) {
92 logger.log(Level.WARNING, String.format("Unknown protocol version: %d! Not parsing Sone.", protocolVersion));
96 String soneTime = soneXml.getValue("time", null);
97 if (soneTime == null) {
98 /* TODO - mark Sone as bad. */
99 logger.log(Level.WARNING, String.format("Downloaded time for Sone %s was null!", originalSone));
103 soneBuilder.lastUpdated(Long.parseLong(soneTime));
104 } catch (NumberFormatException nfe1) {
105 /* TODO - mark Sone as bad. */
106 logger.log(Level.WARNING, String.format("Downloaded Sone %s with invalid time: %s", originalSone, soneTime));
110 SimpleXML clientXml = soneXml.getNode("client");
111 if (clientXml != null) {
112 String clientName = clientXml.getValue("name", null);
113 String clientVersion = clientXml.getValue("version", null);
114 if ((clientName == null) || (clientVersion == null)) {
115 logger.log(Level.WARNING, String.format("Download Sone %s with client XML but missing name or version!", originalSone));
118 soneBuilder.using(new Client(clientName, clientVersion));
120 soneBuilder.using(new Client("Unknown Client", "0.0"));
123 SimpleXML profileXml = soneXml.getNode("profile");
124 if (profileXml == null) {
125 /* TODO - mark Sone as bad. */
126 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no profile!", originalSone));
131 String profileFirstName = profileXml.getValue("first-name", null);
132 String profileMiddleName = profileXml.getValue("middle-name", null);
133 String profileLastName = profileXml.getValue("last-name", null);
134 Integer profileBirthDay = parseInt(profileXml.getValue("birth-day", ""), null);
135 Integer profileBirthMonth = parseInt(profileXml.getValue("birth-month", ""), null);
136 Integer profileBirthYear = parseInt(profileXml.getValue("birth-year", ""), null);
137 Profile profile = new Profile(originalSone).setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName);
138 profile.setBirthDay(profileBirthDay).setBirthMonth(profileBirthMonth).setBirthYear(profileBirthYear);
139 /* avatar is processed after images are loaded. */
140 String avatarId = profileXml.getValue("avatar", null);
142 /* parse profile fields. */
143 SimpleXML profileFieldsXml = profileXml.getNode("fields");
144 if (profileFieldsXml != null) {
145 for (SimpleXML fieldXml : profileFieldsXml.getNodes("field")) {
146 String fieldName = fieldXml.getValue("field-name", null);
147 String fieldValue = fieldXml.getValue("field-value", "");
148 if (fieldName == null) {
149 logger.log(Level.WARNING, String.format("Downloaded profile field for Sone %s with missing data! Name: %s, Value: %s", originalSone, fieldName, fieldValue));
153 profile.addField(fieldName.trim()).setValue(fieldValue);
154 } catch (IllegalArgumentException iae1) {
155 logger.log(Level.WARNING, String.format("Duplicate field: %s", fieldName), iae1);
162 SimpleXML postsXml = soneXml.getNode("posts");
163 if (postsXml == null) {
164 /* TODO - mark Sone as bad. */
165 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no posts!", originalSone));
167 Set<Post> posts = new HashSet<Post>();
168 for (SimpleXML postXml : postsXml.getNodes("post")) {
169 String postId = postXml.getValue("id", null);
170 String postRecipientId = postXml.getValue("recipient", null);
171 String postTime = postXml.getValue("time", null);
172 String postText = postXml.getValue("text", null);
173 if ((postId == null) || (postTime == null) || (postText == null)) {
174 /* TODO - mark Sone as bad. */
175 logger.log(Level.WARNING, String.format("Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", originalSone, postId, postTime, postText));
179 PostBuilder postBuilder = core.postBuilder();
180 /* TODO - parse time correctly. */
181 postBuilder.withId(postId).from(originalSone.getId()).withTime(Long.parseLong(postTime)).withText(postText);
182 if ((postRecipientId != null) && (postRecipientId.length() == 43)) {
183 postBuilder.to(postRecipientId);
185 posts.add(postBuilder.build());
186 } catch (NumberFormatException nfe1) {
187 /* TODO - mark Sone as bad. */
188 logger.log(Level.WARNING, String.format("Downloaded post for Sone %s with invalid time: %s", originalSone, postTime));
192 soneBuilder.withPosts(posts);
194 Sone sone = soneBuilder.build();
197 SimpleXML repliesXml = soneXml.getNode("replies");
198 Set<PostReply> replies = new HashSet<PostReply>();
199 if (repliesXml == null) {
200 /* TODO - mark Sone as bad. */
201 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no replies!", sone));
203 for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
204 String replyId = replyXml.getValue("id", null);
205 String replyPostId = replyXml.getValue("post-id", null);
206 String replyTime = replyXml.getValue("time", null);
207 String replyText = replyXml.getValue("text", null);
208 if ((replyId == null) || (replyPostId == null) || (replyTime == null) || (replyText == null)) {
209 /* TODO - mark Sone as bad. */
210 logger.log(Level.WARNING, String.format("Downloaded reply for Sone %s with missing data! ID: %s, Post: %s, Time: %s, Text: %s", sone, replyId, replyPostId, replyTime, replyText));
214 PostReplyBuilder postReplyBuilder = core.postReplyBuilder();
215 /* TODO - parse time correctly. */
216 postReplyBuilder.withId(replyId).from(sone.getId()).to(replyPostId).withTime(Long.parseLong(replyTime)).withText(replyText);
217 replies.add(postReplyBuilder.build());
218 } catch (NumberFormatException nfe1) {
219 /* TODO - mark Sone as bad. */
220 logger.log(Level.WARNING, String.format("Downloaded reply for Sone %s with invalid time: %s", sone, replyTime));
226 /* parse liked post IDs. */
227 SimpleXML likePostIdsXml = soneXml.getNode("post-likes");
228 Set<String> likedPostIds = new HashSet<String>();
229 if (likePostIdsXml == null) {
230 /* TODO - mark Sone as bad. */
231 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no post likes!", sone));
233 for (SimpleXML likedPostIdXml : likePostIdsXml.getNodes("post-like")) {
234 String postId = likedPostIdXml.getValue();
235 likedPostIds.add(postId);
239 /* parse liked reply IDs. */
240 SimpleXML likeReplyIdsXml = soneXml.getNode("reply-likes");
241 Set<String> likedReplyIds = new HashSet<String>();
242 if (likeReplyIdsXml == null) {
243 /* TODO - mark Sone as bad. */
244 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no reply likes!", sone));
246 for (SimpleXML likedReplyIdXml : likeReplyIdsXml.getNodes("reply-like")) {
247 String replyId = likedReplyIdXml.getValue();
248 likedReplyIds.add(replyId);
253 SimpleXML albumsXml = soneXml.getNode("albums");
254 Map<String, Image> allImages = new HashMap<String, Image>();
255 List<Album> topLevelAlbums = new ArrayList<Album>();
256 if (albumsXml != null) {
257 for (SimpleXML albumXml : albumsXml.getNodes("album")) {
258 String id = albumXml.getValue("id", null);
259 String parentId = albumXml.getValue("parent", null);
260 String title = albumXml.getValue("title", null);
261 String description = albumXml.getValue("description", "");
262 String albumImageId = albumXml.getValue("album-image", null);
263 if ((id == null) || (title == null)) {
264 logger.log(Level.WARNING, String.format("Downloaded Sone %s contains invalid album!", sone));
268 if (parentId != null) {
269 parent = core.getAlbum(parentId);
270 if (parent == null) {
271 logger.log(Level.WARNING, String.format("Downloaded Sone %s has album with invalid parent!", sone));
275 Album album = core.albumBuilder()
281 .setDescription(description)
283 if (parent != null) {
284 parent.addAlbum(album);
286 topLevelAlbums.add(album);
288 SimpleXML imagesXml = albumXml.getNode("images");
289 if (imagesXml != null) {
290 for (SimpleXML imageXml : imagesXml.getNodes("image")) {
291 String imageId = imageXml.getValue("id", null);
292 String imageCreationTimeString = imageXml.getValue("creation-time", null);
293 String imageKey = imageXml.getValue("key", null);
294 String imageTitle = imageXml.getValue("title", null);
295 String imageDescription = imageXml.getValue("description", "");
296 String imageWidthString = imageXml.getValue("width", null);
297 String imageHeightString = imageXml.getValue("height", null);
298 if ((imageId == null) || (imageCreationTimeString == null) || (imageKey == null) || (imageTitle == null) || (imageWidthString == null) || (imageHeightString == null)) {
299 logger.log(Level.WARNING, String.format("Downloaded Sone %s contains invalid images!", sone));
302 long creationTime = parseLong(imageCreationTimeString, 0L);
303 int imageWidth = parseInt(imageWidthString, 0);
304 int imageHeight = parseInt(imageHeightString, 0);
305 if ((imageWidth < 1) || (imageHeight < 1)) {
306 logger.log(Level.WARNING, String.format("Downloaded Sone %s contains image %s with invalid dimensions (%s, %s)!", sone, imageId, imageWidthString, imageHeightString));
309 Image image = core.imageBuilder().withId(imageId).build().modify().setSone(sone).setKey(imageKey).setCreationTime(creationTime).update();
310 image = image.modify().setTitle(imageTitle).setDescription(imageDescription).update();
311 image = image.modify().setWidth(imageWidth).setHeight(imageHeight).update();
312 album.addImage(image);
313 allImages.put(imageId, image);
316 album.modify().setAlbumImage(albumImageId).update();
320 /* process avatar. */
321 if (avatarId != null) {
322 profile.setAvatar(allImages.get(avatarId));
325 /* okay, apparently everything was parsed correctly. Now import. */
326 /* atomic setter operation on the Sone. */
327 synchronized (sone) {
328 sone.setProfile(profile);
329 sone.setReplies(replies);
330 sone.setLikePostIds(likedPostIds);
331 sone.setLikeReplyIds(likedReplyIds);
332 for (Album album : topLevelAlbums) {
333 sone.getRootAlbum().addAlbum(album);