2 * Sone - SoneParser.java - Copyright © 2010–2013 David Roden
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package net.pterodactylus.sone.core;
20 import java.io.InputStream;
21 import java.net.MalformedURLException;
22 import java.util.HashSet;
25 import java.util.logging.Level;
26 import java.util.logging.Logger;
28 import net.pterodactylus.sone.data.Album;
29 import net.pterodactylus.sone.data.Client;
30 import net.pterodactylus.sone.data.Image;
31 import net.pterodactylus.sone.data.Post;
32 import net.pterodactylus.sone.data.PostReply;
33 import net.pterodactylus.sone.data.Profile;
34 import net.pterodactylus.sone.data.Sone;
35 import net.pterodactylus.sone.data.impl.DefaultSone;
36 import net.pterodactylus.sone.database.ImageBuilder.ImageCreated;
37 import net.pterodactylus.sone.database.PostBuilder;
38 import net.pterodactylus.sone.database.PostBuilder.PostCreated;
39 import net.pterodactylus.sone.database.PostReplyBuilder;
40 import net.pterodactylus.sone.database.PostReplyBuilder.PostReplyCreated;
41 import net.pterodactylus.sone.database.memory.MemoryDatabase;
42 import net.pterodactylus.util.number.Numbers;
43 import net.pterodactylus.util.xml.SimpleXML;
44 import net.pterodactylus.util.xml.XML;
46 import freenet.keys.FreenetURI;
48 import com.google.common.base.Optional;
49 import com.google.common.collect.Maps;
50 import org.w3c.dom.Document;
53 * Parses the inserted XML representation of a {@link Sone} into a Sone.
55 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
57 public class SoneParser {
59 private static final Logger logger = Logger.getLogger(SoneParser.class.getName());
60 private static final int MAX_PROTOCOL_VERSION = 0;
61 private final Core core;
63 public SoneParser(Core core) {
68 * Parses a Sone from the given input stream and creates a new Sone from the
73 * @param soneInputStream
74 * The input stream to parse the Sone from
75 * @return The parsed Sone
76 * @throws SoneException
77 * if a parse error occurs, or the protocol is invalid
79 public Sone parseSone(Sone originalSone, InputStream soneInputStream) throws SoneException {
80 /* TODO - impose a size limit? */
83 /* XML parsing is not thread-safe. */
85 document = XML.transformToDocument(soneInputStream);
87 if (document == null) {
88 /* TODO - mark Sone as bad. */
89 logger.log(Level.WARNING, String.format("Could not parse XML for Sone %s!", originalSone));
95 soneXml = SimpleXML.fromDocument(document);
96 } catch (NullPointerException npe1) {
97 /* for some reason, invalid XML can cause NPEs. */
98 logger.log(Level.WARNING, String.format("XML for Sone %s can not be parsed!", originalSone), npe1);
102 SimpleXML clientXml = soneXml.getNode("client");
103 Client soneClient = originalSone.getClient();
104 if (clientXml != null) {
105 String clientName = clientXml.getValue("name", null);
106 String clientVersion = clientXml.getValue("version", null);
107 if ((clientName == null) || (clientVersion == null)) {
108 logger.log(Level.WARNING, String.format("Download Sone %s with client XML but missing name or version!", originalSone));
111 soneClient = new Client(clientName, clientVersion);
114 Sone sone = new DefaultSone(new MemoryDatabase(null), originalSone.getId(), originalSone.isLocal(), soneClient);
116 Integer protocolVersion = null;
117 String soneProtocolVersion = soneXml.getValue("protocol-version", null);
118 if (soneProtocolVersion != null) {
119 protocolVersion = Numbers.safeParseInteger(soneProtocolVersion);
121 if (protocolVersion == null) {
122 logger.log(Level.INFO, "No protocol version found, assuming 0.");
126 if (protocolVersion < 0) {
127 logger.log(Level.WARNING, String.format("Invalid protocol version: %d! Not parsing Sone.", protocolVersion));
131 /* check for valid versions. */
132 if (protocolVersion > MAX_PROTOCOL_VERSION) {
133 logger.log(Level.WARNING, String.format("Unknown protocol version: %d! Not parsing Sone.", protocolVersion));
137 String soneTime = soneXml.getValue("time", null);
138 if (soneTime == null) {
139 /* TODO - mark Sone as bad. */
140 logger.log(Level.WARNING, String.format("Downloaded time for Sone %s was null!", sone));
144 sone.setTime(Long.parseLong(soneTime));
145 } catch (NumberFormatException nfe1) {
146 /* TODO - mark Sone as bad. */
147 logger.log(Level.WARNING, String.format("Downloaded Sone %s with invalid time: %s", sone, soneTime));
151 SimpleXML profileXml = soneXml.getNode("profile");
152 if (profileXml == null) {
153 /* TODO - mark Sone as bad. */
154 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no profile!", sone));
159 String profileFirstName = profileXml.getValue("first-name", null);
160 String profileMiddleName = profileXml.getValue("middle-name", null);
161 String profileLastName = profileXml.getValue("last-name", null);
162 Integer profileBirthDay = Numbers.safeParseInteger(profileXml.getValue("birth-day", null));
163 Integer profileBirthMonth = Numbers.safeParseInteger(profileXml.getValue("birth-month", null));
164 Integer profileBirthYear = Numbers.safeParseInteger(profileXml.getValue("birth-year", null));
165 Profile profile = new Profile(sone).modify().setFirstName(profileFirstName).setMiddleName(profileMiddleName).setLastName(profileLastName).update();
166 profile.modify().setBirthDay(profileBirthDay).setBirthMonth(profileBirthMonth).setBirthYear(profileBirthYear).update();
167 /* avatar is processed after images are loaded. */
168 String avatarId = profileXml.getValue("avatar", null);
170 /* parse profile fields. */
171 SimpleXML profileFieldsXml = profileXml.getNode("fields");
172 if (profileFieldsXml != null) {
173 for (SimpleXML fieldXml : profileFieldsXml.getNodes("field")) {
174 String fieldName = fieldXml.getValue("field-name", null);
175 String fieldValue = fieldXml.getValue("field-value", "");
176 if (fieldName == null) {
177 logger.log(Level.WARNING, String.format("Downloaded profile field for Sone %s with missing data! Name: %s, Value: %s", sone, fieldName, fieldValue));
181 profile.addField(fieldName).setValue(fieldValue);
182 } catch (IllegalArgumentException iae1) {
183 logger.log(Level.WARNING, String.format("Duplicate field: %s", fieldName), iae1);
190 SimpleXML postsXml = soneXml.getNode("posts");
191 Set<Post> posts = new HashSet<Post>();
192 if (postsXml == null) {
193 /* TODO - mark Sone as bad. */
194 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no posts!", sone));
196 for (SimpleXML postXml : postsXml.getNodes("post")) {
197 String postId = postXml.getValue("id", null);
198 String postRecipientId = postXml.getValue("recipient", null);
199 String postTime = postXml.getValue("time", null);
200 String postText = postXml.getValue("text", null);
201 if ((postId == null) || (postTime == null) || (postText == null)) {
202 /* TODO - mark Sone as bad. */
203 logger.log(Level.WARNING, String.format("Downloaded post for Sone %s with missing data! ID: %s, Time: %s, Text: %s", sone, postId, postTime, postText));
207 PostBuilder postBuilder = sone.newPostBuilder();
208 /* TODO - parse time correctly. */
209 postBuilder.withId(postId).withTime(Long.parseLong(postTime)).withText(postText);
210 if ((postRecipientId != null) && (postRecipientId.length() == 43)) {
211 postBuilder.to(Optional.of(postRecipientId));
213 posts.add(postBuilder.build(Optional.<PostCreated>absent()));
214 } catch (NumberFormatException nfe1) {
215 /* TODO - mark Sone as bad. */
216 logger.log(Level.WARNING, String.format("Downloaded post for Sone %s with invalid time: %s", sone, postTime));
223 SimpleXML repliesXml = soneXml.getNode("replies");
224 Set<PostReply> replies = new HashSet<PostReply>();
225 if (repliesXml == null) {
226 /* TODO - mark Sone as bad. */
227 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no replies!", sone));
229 for (SimpleXML replyXml : repliesXml.getNodes("reply")) {
230 String replyId = replyXml.getValue("id", null);
231 String replyPostId = replyXml.getValue("post-id", null);
232 String replyTime = replyXml.getValue("time", null);
233 String replyText = replyXml.getValue("text", null);
234 if ((replyId == null) || (replyPostId == null) || (replyTime == null) || (replyText == null)) {
235 /* TODO - mark Sone as bad. */
236 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));
240 /* TODO - parse time correctly. */
241 PostReplyBuilder postReplyBuilder = sone.newPostReplyBuilder(replyPostId).withId(replyId).withTime(Long.parseLong(replyTime)).withText(replyText);
242 replies.add(postReplyBuilder.build(Optional.<PostReplyCreated>absent()));
243 } catch (NumberFormatException nfe1) {
244 /* TODO - mark Sone as bad. */
245 logger.log(Level.WARNING, String.format("Downloaded reply for Sone %s with invalid time: %s", sone, replyTime));
251 /* parse liked post IDs. */
252 SimpleXML likePostIdsXml = soneXml.getNode("post-likes");
253 Set<String> likedPostIds = new HashSet<String>();
254 if (likePostIdsXml == null) {
255 /* TODO - mark Sone as bad. */
256 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no post likes!", sone));
258 for (SimpleXML likedPostIdXml : likePostIdsXml.getNodes("post-like")) {
259 String postId = likedPostIdXml.getValue();
260 likedPostIds.add(postId);
264 /* parse liked reply IDs. */
265 SimpleXML likeReplyIdsXml = soneXml.getNode("reply-likes");
266 Set<String> likedReplyIds = new HashSet<String>();
267 if (likeReplyIdsXml == null) {
268 /* TODO - mark Sone as bad. */
269 logger.log(Level.WARNING, String.format("Downloaded Sone %s has no reply likes!", sone));
271 for (SimpleXML likedReplyIdXml : likeReplyIdsXml.getNodes("reply-like")) {
272 String replyId = likedReplyIdXml.getValue();
273 likedReplyIds.add(replyId);
278 SimpleXML albumsXml = soneXml.getNode("albums");
279 Map<String, Album> albums = Maps.newHashMap();
280 if (albumsXml != null) {
281 for (SimpleXML albumXml : albumsXml.getNodes("album")) {
282 String id = albumXml.getValue("id", null);
283 String parentId = albumXml.getValue("parent", null);
284 String title = albumXml.getValue("title", null);
285 String description = albumXml.getValue("description", "");
286 String albumImageId = albumXml.getValue("album-image", null);
287 if ((id == null) || (title == null) || (description == null)) {
288 logger.log(Level.WARNING, String.format("Downloaded Sone %s contains invalid album!", sone));
291 Album parent = sone.getRootAlbum();
292 if (parentId != null) {
293 parent = albums.get(parentId);
294 if (parent == null) {
295 logger.log(Level.WARNING, String.format("Downloaded Sone %s has album with invalid parent!", sone));
299 Album album = parent.newAlbumBuilder().withId(id).build().modify().setTitle(title).setDescription(description).update();
300 albums.put(album.getId(), album);
301 SimpleXML imagesXml = albumXml.getNode("images");
302 if (imagesXml != null) {
303 for (SimpleXML imageXml : imagesXml.getNodes("image")) {
304 String imageId = imageXml.getValue("id", null);
305 String imageCreationTimeString = imageXml.getValue("creation-time", null);
306 String imageKey = imageXml.getValue("key", null);
307 String imageTitle = imageXml.getValue("title", null);
308 String imageDescription = imageXml.getValue("description", "");
309 String imageWidthString = imageXml.getValue("width", null);
310 String imageHeightString = imageXml.getValue("height", null);
311 if ((imageId == null) || (imageCreationTimeString == null) || (imageKey == null) || (imageTitle == null) || (imageWidthString == null) || (imageHeightString == null)) {
312 logger.log(Level.WARNING, String.format("Downloaded Sone %s contains invalid images!", sone));
315 long creationTime = Numbers.safeParseLong(imageCreationTimeString, 0L);
316 int imageWidth = Numbers.safeParseInteger(imageWidthString, 0);
317 int imageHeight = Numbers.safeParseInteger(imageHeightString, 0);
318 if ((imageWidth < 1) || (imageHeight < 1)) {
319 logger.log(Level.WARNING, String.format("Downloaded Sone %s contains image %s with invalid dimensions (%s, %s)!", sone, imageId, imageWidthString, imageHeightString));
322 Image image = album.newImageBuilder().withId(imageId).at(imageKey).created(creationTime).sized(imageWidth, imageHeight).build(Optional.<ImageCreated>absent());
323 image = image.modify().setTitle(imageTitle).setDescription(imageDescription).update();
326 album.modify().setAlbumImage(albumImageId).update();
330 /* process avatar. */
331 if (avatarId != null) {
332 profile.setAvatar(core.getImage(avatarId).orNull());
335 /* okay, apparently everything was parsed correctly. Now import. */
336 sone.setProfile(profile);
337 sone.setPosts(posts);
338 sone.setReplies(replies);
339 sone.setLikePostIds(likedPostIds);
340 sone.setLikeReplyIds(likedReplyIds);