wamblee.org Git - utils/blob - crawler/kiss/src/org/wamblee/crawler/kiss/KissCrawler.java

   1 /*
   2  * Copyright 2005 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.wamblee.crawler.kiss;
  18
  19 import java.io.ByteArrayOutputStream;
  20 import java.io.File;
  21 import java.io.FileInputStream;
  22 import java.io.FileNotFoundException;
  23 import java.io.FileOutputStream;
  24 import java.io.IOException;
  25 import java.io.InputStream;
  26 import java.io.PrintStream;
  27 import java.util.ArrayList;
  28 import java.util.Arrays;
  29 import java.util.Date;
  30 import java.util.List;
  31 import java.util.Properties;
  32 import java.util.regex.Matcher;
  33 import java.util.regex.Pattern;
  34
  35 import javax.mail.MessagingException;
  36 import javax.mail.Session;
  37 import javax.mail.internet.InternetAddress;
  38 import javax.xml.transform.TransformerException;
  39
  40 import org.apache.commons.httpclient.HttpClient;
  41 import org.apache.commons.logging.Log;
  42 import org.apache.commons.logging.LogFactory;
  43 import org.apache.commons.mail.EmailException;
  44 import org.apache.commons.mail.HtmlEmail;
  45 import org.apache.xml.serialize.OutputFormat;
  46 import org.apache.xml.serialize.XMLSerializer;
  47 import org.w3c.dom.Document;
  48 import org.wamblee.crawler.Action;
  49 import org.wamblee.crawler.Configuration;
  50 import org.wamblee.crawler.Crawler;
  51 import org.wamblee.crawler.Page;
  52 import org.wamblee.crawler.PageException;
  53 import org.wamblee.crawler.impl.ConfigurationParser;
  54 import org.wamblee.crawler.impl.CrawlerImpl;
  55 import org.wamblee.io.FileResource;
  56 import org.wamblee.xml.XSLT;
  57
  58 /**
  59  * The KiSS crawler for automatic recording of interesting TV shows.
  60  *
  61  */
  62 public class KissCrawler {
  63
  64     private static final Log LOG = LogFactory.getLog(KissCrawler.class);
  65
  66     /**
  67      * Log file name for the crawler.
  68      */
  69     private static final String LOG_FILE = "kiss.log";
  70
  71     /**
  72      * Start URL of the electronic programme guide.
  73      */
  74     private static final String START_URL = "http://epg.kml.kiss-technology.com/login_core.php";
  75
  76     /**
  77      * Crawler configuration file.
  78      */
  79     private static final String CRAWLER_CONFIG = "config.xml";
  80
  81     /**
  82      * Configuration file describing interesting programs.
  83      */
  84     private static final String PROGRAM_CONFIG = "programs.xml";
  85
  86     /**
  87      * Regular expression for matching time interval strings in the retrieved
  88      * pages.
  89      */
  90     private static final String TIME_REGEX = "([0-9]{2}):([0-9]{2})[^0-9]*([0-9]{2}):([0-9]{2}).*";
  91
  92     /**
  93      * Compiled pattern for the time regular expression.
  94      */
  95     private Pattern _pattern;
  96
  97     /**
  98      * Runs the KiSS crawler.
  99      *
 100      * @param aArgs
 101      *            Arguments, currently all ignored because they are hardcoded.
 102      * @throws Exception
 103      *             In case of problems.
 104      */
 105     public static void main(String[] aArgs) throws Exception {
 106         new KissCrawler(START_URL, CRAWLER_CONFIG, PROGRAM_CONFIG);
 107     }
 108
 109     /**
 110      * Constructs the crawler. This retrieves the TV guide by crawling the KiSS
 111      * EPG guide, filters the guide for interesting programs, tries to record
 112      * them, and sends a summary mail to the user.
 113      *
 114      * @param aStartUrl
 115      *            Start URL of the electronic programme guide.
 116      * @param aCrawlerConfig
 117      *            Configuration file for the crawler.
 118      * @param aProgramConfig
 119      *            Configuration file describing interesting shows.
 120      * @throws IOException
 121      *             In case of problems reading files.
 122      * @throws MessagingException
 123      *             In case of problems sending a mail notification.
 124      */
 125     public KissCrawler(String aStartUrl, String aCrawlerConfig,
 126             String aProgramConfig) throws IOException, MessagingException {
 127
 128         _pattern = Pattern.compile(TIME_REGEX);
 129
 130         FileOutputStream fos = new FileOutputStream(new File(LOG_FILE));
 131         PrintStream os = new PrintStream(fos);
 132
 133         try {
 134             HttpClient client = new HttpClient();
 135             //client.getHostConfiguration().setProxy("127.0.0.1", 3128);
 136
 137             Crawler crawler = createCrawler(aCrawlerConfig, os, client);
 138             InputStream programConfigFile = new FileInputStream(new File(
 139                     aProgramConfig));
 140             ProgramConfigurationParser parser = new ProgramConfigurationParser();
 141             parser.parse(programConfigFile);
 142             List<ProgramFilter> programFilters = parser.getFilters();
 143
 144             Page page = getStartPage(aStartUrl, crawler);
 145             TVGuide guide = createGuide(page);
 146             PrintVisitor printer = new PrintVisitor(System.out);
 147             guide.accept(printer);
 148             processResults(programFilters, guide, parser.getNotifier());
 149         } finally {
 150             os.flush();
 151             os.close();
 152             System.out.println("Output written on '" + LOG_FILE + "'");
 153         }
 154     }
 155
 156     /**
 157      * Records interesting shows.
 158      *
 159      * @param aProgramCondition
 160      *            Condition determining which shows are interesting.
 161      * @param aGuide
 162      *            Television guide.
 163      * @throws MessagingException
 164      *             In case of problems sending a summary mail.
 165      */
 166     private void processResults(List<ProgramFilter> aProgramCondition,
 167             TVGuide aGuide, Notifier aNotifier) throws MessagingException {
 168         ProgramActionExecutor executor = new ProgramActionExecutor();
 169         for (ProgramFilter filter : aProgramCondition) {
 170             List<Program> programs = filter.apply(aGuide);
 171             ProgramAction action = filter.getAction();
 172             for (Program program : programs) {
 173                 action.execute(program, executor);
 174             }
 175         }
 176         executor.commit();
 177         try {
 178             aNotifier.send(executor.getXmlReport());
 179         } catch (NotificationException e) {
 180             throw new RuntimeException(e);
 181         }
 182     }
 183
 184     /**
 185      * Creates the crawler.
 186      *
 187      * @param aCrawlerConfig
 188      *            Crawler configuration file.
 189      * @param aOs
 190      *            Logging output stream for the crawler.
 191      * @param aClient
 192      *            HTTP Client to use.
 193      * @return Crawler.
 194      * @throws FileNotFoundException
 195      *             In case configuration files cannot be found.
 196      */
 197     private Crawler createCrawler(String aCrawlerConfig, PrintStream aOs,
 198             HttpClient aClient) throws FileNotFoundException {
 199         ConfigurationParser parser = new ConfigurationParser(aOs);
 200         InputStream crawlerConfigFile = new FileInputStream(new File(
 201                 aCrawlerConfig));
 202         Configuration config = parser.parse(crawlerConfigFile);
 203         Crawler crawler = new CrawlerImpl(aClient, config);
 204         return crawler;
 205     }
 206
 207     /**
 208      * Gets the start page of the electronic programme guide. This involves
 209      * login and navigation to a suitable start page after logging in.
 210      *
 211      * @param aStartUrl
 212      *            URL of the electronic programme guide.
 213      * @param aCrawler
 214      *            Crawler to use.
 215      * @return Starting page.
 216      */
 217     private Page getStartPage(String aStartUrl, Crawler aCrawler) {
 218         try {
 219             Page page = aCrawler.getPage(aStartUrl);
 220             return page.getAction("channels-favorites").execute();
 221         } catch (PageException e) {
 222             throw new RuntimeException(
 223                     "Could not login to electronic program guide", e);
 224         }
 225     }
 226
 227     /**
 228      * Creates the TV guide by web crawling.
 229      *
 230      * @param aPage
 231      *            Starting page.
 232      * @return TV guide.
 233      */
 234     private TVGuide createGuide(Page aPage) {
 235         LOG.info("Obtaining full TV guide");
 236         Action[] actions = aPage.getActions();
 237         List<Channel> channels = new ArrayList<Channel>();
 238         for (Action action : actions) {
 239             try {
 240                 LOG.info("Getting channel info for '" + action.getName() + "'");
 241                 Channel channel = createChannel(action.getName(), action
 242                         .execute().getAction("right-now").execute());
 243                 channels.add(channel);
 244                 if (SystemProperties.isDebugMode()) {
 245                     break; // Only one channel is crawled.
 246                 }
 247             } catch (PageException e) {
 248                 LOG.error("Could not create channel information for '"
 249                         + action.getName() + "'", e);
 250             }
 251         }
 252         return new TVGuide(channels);
 253     }
 254
 255     /**
 256      * Create channel information for a specific channel.
 257      *
 258      * @param aChannel
 259      *            Channel name.
 260      * @param aPage
 261      *            Starting page for the channel.
 262      * @return Channel.
 263      */
 264     private Channel createChannel(String aChannel, Page aPage) {
 265         LOG.info("Obtaining program for " + aChannel);
 266         Action[] programActions = aPage.getActions();
 267         List<Program> programs = new ArrayList<Program>();
 268         for (Action action : programActions) {
 269             String time = action.getContent().element("time").getText().trim();
 270             Matcher matcher = _pattern.matcher(time);
 271             if (matcher.matches()) {
 272                 Time begin = new Time(Integer.parseInt(matcher.group(1)),
 273                         Integer.parseInt(matcher.group(2)));
 274                 Time end = new Time(Integer.parseInt(matcher.group(3)), Integer
 275                         .parseInt(matcher.group(4)));
 276                 TimeInterval interval = new TimeInterval(begin, end);
 277                 String description = "";
 278                 String keywords = "";
 279                 if (!SystemProperties.isNoProgramDetailsRequired()) {
 280                     try {
 281                         Page programInfo = action.execute();
 282                         description = programInfo.getContent().element(
 283                                 "description").getText().trim();
 284                         keywords = programInfo.getContent().element("keywords")
 285                                 .getText().trim();
 286                     } catch (PageException e) {
 287                         LOG.warn(
 288                                 "Program details could not be determined for '"
 289                                         + action.getName() + "'", e);
 290                     }
 291                 }
 292                 Program program = new Program(aChannel, action.getName(),
 293                         description, keywords, interval, action);
 294
 295                 LOG.info("Got program " + program);
 296                 programs.add(program);
 297             }
 298         }
 299         return new Channel(aChannel, programs);
 300     }
 301
 302     /**
 303      * Sends a summary mail to the user.
 304      *
 305      * @param aText
 306      *            Text of the mail.
 307      * @throws MessagingException
 308      *             In case of problems sending mail.
 309      */
 310     private void sendMail(ProgramActionExecutor aExecutor) throws MessagingException {
 311         String textReport = aExecutor.getReport();
 312         System.out.println("Text report: \n" + textReport);
 313         System.out.println("XML report:\n" + aExecutor.getXmlReport().asXML());
 314
 315
 316         Properties props = new Properties();
 317         props.put("mail.transport.protocol", "smtp");
 318         props.put("mail.smtp.host", "falcon");
 319         props.put("mail.smtp.port", "25");
 320
 321         Session mailSession = Session.getInstance(props);
 322         InternetAddress from = new InternetAddress("erik@brakkee.org");
 323
 324         HtmlEmail mail = new HtmlEmail();
 325         mail.setMailSession(mailSession);
 326         try {
 327             mail.setFrom("erik@brakkee.org");
 328             mail.setTo(Arrays.asList(new InternetAddress[] { from }));
 329             mail.setSentDate(new Date());
 330             mail.setSubject("KiSS Crawler Update");
 331             String html = aExecutor.getXmlReport().asXML();
 332             Document document = new XSLT().transform(html.getBytes(), new FileResource(new File("reportToHtml.xsl")));
 333             ByteArrayOutputStream xhtml = new ByteArrayOutputStream();
 334             XMLSerializer serializer = new XMLSerializer(xhtml, new OutputFormat());
 335             serializer.serialize(document);
 336             mail.setHtmlMsg(xhtml.toString());
 337             mail.setTextMsg(textReport);
 338             mail.send();
 339         } catch (EmailException e) {
 340             throw new RuntimeException(e);
 341         } catch (TransformerException e) {
 342             throw new RuntimeException(e);
 343         } catch (IOException e) {
 344             throw new RuntimeException(e);
 345         }
 346     }
 347
 348 }