src/main/java/net/pterodactylus/sone/core/SoneInserter.java

   1 /*
   2  * FreenetSone - SoneInserter.java - Copyright © 2010 David Roden
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17
  18 package net.pterodactylus.sone.core;
  19
  20 import java.io.InputStreamReader;
  21 import java.io.StringWriter;
  22 import java.nio.charset.Charset;
  23 import java.util.ArrayList;
  24 import java.util.Collection;
  25 import java.util.HashMap;
  26 import java.util.HashSet;
  27 import java.util.Map;
  28 import java.util.Set;
  29 import java.util.logging.Level;
  30 import java.util.logging.Logger;
  31
  32 import net.pterodactylus.sone.core.Core.SoneStatus;
  33 import net.pterodactylus.sone.data.Post;
  34 import net.pterodactylus.sone.data.Reply;
  35 import net.pterodactylus.sone.data.Sone;
  36 import net.pterodactylus.sone.freenet.StringBucket;
  37 import net.pterodactylus.util.filter.Filter;
  38 import net.pterodactylus.util.filter.Filters;
  39 import net.pterodactylus.util.io.Closer;
  40 import net.pterodactylus.util.logging.Logging;
  41 import net.pterodactylus.util.service.AbstractService;
  42 import net.pterodactylus.util.template.DefaultTemplateFactory;
  43 import net.pterodactylus.util.template.ReflectionAccessor;
  44 import net.pterodactylus.util.template.Template;
  45 import net.pterodactylus.util.template.TemplateException;
  46 import net.pterodactylus.util.template.XmlFilter;
  47 import freenet.client.async.ManifestElement;
  48 import freenet.keys.FreenetURI;
  49
  50 /**
  51  * A Sone inserter is responsible for inserting a Sone if it has changed.
  52  *
  53  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  54  */
  55 public class SoneInserter extends AbstractService {
  56
  57         /** The logger. */
  58         private static final Logger logger = Logging.getLogger(SoneInserter.class);
  59
  60         /** The template factory used to create the templates. */
  61         private static final DefaultTemplateFactory templateFactory = new DefaultTemplateFactory();
  62
  63         static {
  64                 templateFactory.addAccessor(Object.class, new ReflectionAccessor());
  65                 templateFactory.addFilter("xml", new XmlFilter());
  66         }
  67
  68         /** The UTF-8 charset. */
  69         private static final Charset utf8Charset = Charset.forName("UTF-8");
  70
  71         /** The core. */
  72         private final Core core;
  73
  74         /** The Freenet interface. */
  75         private final FreenetInterface freenetInterface;
  76
  77         /** The Sone to insert. */
  78         private final Sone sone;
  79
  80         /**
  81          * Creates a new Sone inserter.
  82          *
  83          * @param core
  84          *            The core
  85          * @param freenetInterface
  86          *            The freenet interface
  87          * @param sone
  88          *            The Sone to insert
  89          */
  90         public SoneInserter(Core core, FreenetInterface freenetInterface, Sone sone) {
  91                 super("Sone Inserter for “" + sone.getName() + "”", false);
  92                 this.core = core;
  93                 this.freenetInterface = freenetInterface;
  94                 this.sone = sone;
  95         }
  96
  97         //
  98         // SERVICE METHODS
  99         //
 100
 101         /**
 102          * {@inheritDoc}
 103          */
 104         @Override
 105         protected void serviceRun() {
 106                 long modificationCounter = 0;
 107                 long lastModificationTime = 0;
 108                 while (!shouldStop()) {
 109                         /* check every seconds. */
 110                         sleep(1000);
 111
 112                         InsertInformation insertInformation = null;
 113                         synchronized (sone) {
 114                                 if (sone.getModificationCounter() > modificationCounter) {
 115                                         modificationCounter = sone.getModificationCounter();
 116                                         lastModificationTime = System.currentTimeMillis();
 117                                         sone.setTime(lastModificationTime);
 118                                         logger.log(Level.FINE, "Sone %s has been modified, waiting 60 seconds before inserting.", new Object[] { sone.getName() });
 119                                         if ((System.currentTimeMillis() - lastModificationTime) > (60 * 1000)) {
 120                                                 insertInformation = new InsertInformation(sone);
 121                                         }
 122                                 }
 123                         }
 124
 125                         if (insertInformation != null) {
 126                                 logger.log(Level.INFO, "Inserting Sone “%s”…", new Object[] { sone.getName() });
 127
 128                                 boolean success = false;
 129                                 try {
 130                                         core.setSoneStatus(sone, SoneStatus.inserting);
 131                                         FreenetURI finalUri = freenetInterface.insertDirectory(insertInformation.getInsertUri().setKeyType("USK").setDocName("Sone-" + sone.getName()).setSuggestedEdition(0), insertInformation.generateManifestEntries(), "index.html");
 132                                         sone.updateUris(finalUri);
 133                                         success = true;
 134                                         logger.log(Level.INFO, "Inserted Sone “%s” at %s.", new Object[] { sone.getName(), finalUri });
 135                                 } catch (SoneException se1) {
 136                                         logger.log(Level.WARNING, "Could not insert Sone “" + sone.getName() + "”!", se1);
 137                                 } finally {
 138                                         core.setSoneStatus(sone, SoneStatus.idle);
 139                                 }
 140
 141                                 /*
 142                                  * reset modification counter if Sone has not been modified
 143                                  * while it was inserted.
 144                                  */
 145                                 if (success) {
 146                                         synchronized (sone) {
 147                                                 if (sone.getModificationCounter() == modificationCounter) {
 148                                                         logger.log(Level.FINE, "Sone “%s” was not modified further, resetting counter…", new Object[] { sone });
 149                                                         sone.setModificationCounter(0);
 150                                                         modificationCounter = 0;
 151                                                 }
 152                                         }
 153                                 }
 154                         }
 155                 }
 156         }
 157
 158         /**
 159          * Container for information that are required to insert a Sone. This
 160          * container merely exists to copy all relevant data without holding a lock
 161          * on the {@link Sone} object for too long.
 162          *
 163          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 164          */
 165         private class InsertInformation {
 166
 167                 /** All properties of the Sone, copied for thread safety. */
 168                 private final Map<String, Object> soneProperties = new HashMap<String, Object>();
 169
 170                 /**
 171                  * Creates a new insert information container.
 172                  *
 173                  * @param sone
 174                  *            The sone to insert
 175                  */
 176                 public InsertInformation(Sone sone) {
 177                         soneProperties.put("id", sone.getId());
 178                         soneProperties.put("name", sone.getName());
 179                         soneProperties.put("time", sone.getTime());
 180                         soneProperties.put("requestUri", sone.getRequestUri());
 181                         soneProperties.put("insertUri", sone.getInsertUri());
 182                         soneProperties.put("profile", sone.getProfile());
 183                         soneProperties.put("posts", new ArrayList<Post>(sone.getPosts()));
 184                         soneProperties.put("replies", new HashSet<Reply>(sone.getReplies()));
 185                         soneProperties.put("blockedSoneIds", new HashSet<String>(sone.getBlockedSoneIds()));
 186                         soneProperties.put("likedPostIds", new HashSet<String>(sone.getLikedPostIds()));
 187                         soneProperties.put("likeReplyIds", new HashSet<String>(sone.getLikedReplyIds()));
 188                 }
 189
 190                 //
 191                 // ACCESSORS
 192                 //
 193
 194                 /**
 195                  * Returns the insert URI of the Sone.
 196                  *
 197                  * @return The insert URI of the Sone
 198                  */
 199                 public FreenetURI getInsertUri() {
 200                         return (FreenetURI) soneProperties.get("insertUri");
 201                 }
 202
 203                 //
 204                 // ACTIONS
 205                 //
 206
 207                 /**
 208                  * Generates all manifest entries required to insert this Sone.
 209                  *
 210                  * @return The manifest entries for the Sone insert
 211                  */
 212                 public HashMap<String, Object> generateManifestEntries() {
 213                         HashMap<String, Object> manifestEntries = new HashMap<String, Object>();
 214
 215                         /* first, create an index.html. */
 216                         manifestEntries.put("index.html", createManifestElement("index.html", "text/html; charset=utf-8", "/templates/insert/index.html"));
 217
 218                         /* now, store the sone. */
 219                         manifestEntries.put("sone.xml", createManifestElement("sone.xml", "text/xml; charset=utf-8", "/templates/insert/sone.xml"));
 220
 221                         return manifestEntries;
 222                 }
 223
 224                 //
 225                 // PRIVATE METHODS
 226                 //
 227
 228                 /**
 229                  * Creates a new manifest element.
 230                  *
 231                  * @param name
 232                  *            The name of the file
 233                  * @param contentType
 234                  *            The content type of the file
 235                  * @param templateName
 236                  *            The name of the template to render
 237                  * @return The manifest element
 238                  */
 239                 @SuppressWarnings("synthetic-access")
 240                 private ManifestElement createManifestElement(String name, String contentType, String templateName) {
 241                         InputStreamReader templateInputStreamReader;
 242                         Template template = templateFactory.createTemplate(templateInputStreamReader = new InputStreamReader(getClass().getResourceAsStream(templateName), utf8Charset));
 243                         try {
 244                                 template.parse();
 245                         } catch (TemplateException te1) {
 246                                 logger.log(Level.SEVERE, "Could not parse template “" + templateName + "”!", te1);
 247                                 return null;
 248                         } finally {
 249                                 Closer.close(templateInputStreamReader);
 250                         }
 251                         @SuppressWarnings("unchecked")
 252                         final Set<String> blockedSoneIds = (Set<String>) soneProperties.get("blockedSoneIds");
 253                         Collection<Sone> knownSones = Filters.filteredCollection(core.getKnownSones(), new Filter<Sone>() {
 254
 255                                 /**
 256                                  * {@inheritDoc}
 257                                  */
 258                                 @Override
 259                                 public boolean filterObject(Sone object) {
 260                                         return !blockedSoneIds.contains(object.getId()) && !object.getId().equals(soneProperties.get("id"));
 261                                 }
 262                         });
 263
 264                         template.set("currentSone", soneProperties);
 265                         template.set("knownSones", knownSones);
 266                         StringWriter writer = new StringWriter();
 267                         StringBucket bucket = null;
 268                         try {
 269                                 template.render(writer);
 270                                 bucket = new StringBucket(writer.toString(), utf8Charset);
 271                                 return new ManifestElement(name, bucket, contentType, bucket.size());
 272                         } catch (TemplateException te1) {
 273                                 logger.log(Level.SEVERE, "Could not render template “" + templateName + "”!", te1);
 274                                 return null;
 275                         } finally {
 276                                 Closer.close(writer);
 277                                 if (bucket != null) {
 278                                         bucket.free();
 279                                 }
 280                         }
 281                 }
 282
 283         }
 284
 285 }