import javax.mail.MessagingException;
import javax.mail.Session;
import javax.mail.Transport;
-import javax.mail.internet.AddressException;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
-import org.dom4j.Element;
-import org.wamblee.conditions.Condition;
import org.wamblee.crawler.Action;
import org.wamblee.crawler.Configuration;
import org.wamblee.crawler.Crawler;
import org.wamblee.crawler.impl.CrawlerImpl;
/**
+ * The KiSS crawler for automatic recording of interesting TV shows.
*
*/
public class KissCrawler {
private static final Log LOG = LogFactory.getLog(KissCrawler.class);
+ /**
+ * Log file name for the crawler.
+ */
private static final String LOG_FILE = "kiss.log";
+ /**
+ * Start URL of the electronic programme guide.
+ */
private static final String START_URL = "http://epg.kml.kiss-technology.com/login_core.php";
+ /**
+ * Crawler configuration file.
+ */
private static final String CRAWLER_CONFIG = "config.xml";
+ /**
+ * Configuration file describing interesting programs.
+ */
private static final String PROGRAM_CONFIG = "programs.xml";
+ /**
+ * Regular expression for matching time interval strings in the retrieved
+ * pages.
+ */
private static final String TIME_REGEX = "([0-9]{2}):([0-9]{2})[^0-9]*([0-9]{2}):([0-9]{2}).*";
+ /**
+ * Compiled pattern for the time regular expression.
+ */
private Pattern _pattern;
+ /**
+ * Runs the KiSS crawler.
+ *
+ * @param aArgs
+ * Arguments, currently all ignored because they are hardcoded.
+ * @throws Exception
+ * In case of problems.
+ */
+ public static void main(String[] aArgs) throws Exception {
+ new KissCrawler(START_URL, CRAWLER_CONFIG, PROGRAM_CONFIG);
+ }
+
+ /**
+ * Constructs the crawler. This retrieves the TV guide by crawling the KiSS
+ * EPG guide, filters the guide for interesting programs, tries to record
+ * them, and sends a summary mail to the user.
+ *
+ * @param aStartUrl
+ * Start URL of the electronic programme guide.
+ * @param aCrawlerConfig
+ * Configuration file for the crawler.
+ * @param aProgramConfig
+ * Configuration file describing interesting shows.
+ * @throws IOException
+ * In case of problems reading files.
+ * @throws MessagingException
+ * In case of problems sending a mail notification.
+ */
public KissCrawler(String aStartUrl, String aCrawlerConfig,
- String aProgramConfig) throws IOException, AddressException,
- MessagingException {
+ String aProgramConfig) throws IOException, MessagingException {
_pattern = Pattern.compile(TIME_REGEX);
try {
HttpClient client = new HttpClient();
- // client.getHostConfiguration().setProxy("localhost", 3128);
+ // client.getHostConfiguration().setProxy("127.0.0.1", 3128);
Crawler crawler = createCrawler(aCrawlerConfig, os, client);
+ InputStream programConfigFile = new FileInputStream(new File(
+ aProgramConfig));
+ List<ProgramFilter> programFilters = new ProgramConfigurationParser()
+ .parse(programConfigFile);
Page page = getStartPage(aStartUrl, crawler);
TVGuide guide = createGuide(page);
PrintVisitor printer = new PrintVisitor(System.out);
guide.accept(printer);
-
- InputStream programConfigFile = new FileInputStream(new File(
- aProgramConfig));
- Condition<Program> programCondition = new ProgramConfigurationParser()
- .parse(programConfigFile);
- recordInterestingShows(programCondition, guide);
+ processResults(programFilters, guide);
} finally {
os.flush();
os.close();
}
/**
- * @param programCondition
- * @param guide
- * @throws AddressException
+ * Records interesting shows.
+ *
+ * @param aProgramCondition
+ * Condition determining which shows are interesting.
+ * @param aGuide
+ * Television guide.
* @throws MessagingException
+ * In case of problems sending a summary mail.
*/
- private void recordInterestingShows(Condition<Program> programCondition,
- TVGuide guide) throws AddressException, MessagingException {
- MatchVisitor matcher = new MatchVisitor(programCondition);
- guide.accept(matcher);
- List<Program> programs = matcher.getMatches();
- String recorded = "";
- String notRecorded = "";
- String failures = "";
- for (Program program : programs) {
- try {
- boolean result = program.record();
- if (result) {
- recorded += "\n" + program;
- } else {
- notRecorded += "\n" + program;
- }
- } catch (PageException e) {
- LOG.info("Attempt to record " + program + " failed.");
- failures += "\n" + program.toString() + ": " + e.getMessage();
+ private void processResults(List<ProgramFilter> aProgramCondition,
+ TVGuide aGuide) throws MessagingException {
+ ProgramActionExecutor executor = new ProgramActionExecutor();
+ for (ProgramFilter filter : aProgramCondition) {
+ List<Program> programs = filter.apply(aGuide);
+ ProgramAction action = filter.getAction();
+ for (Program program: programs) {
+ action.execute(program, executor);
}
}
- String msg = "Summary of KiSS crawler: \n\n\n";
-
- if (recorded.length() > 0) {
- msg += "Recorded programs:\n\n" + recorded + "\n\n";
- }
- if (notRecorded.length() > 0) {
- msg += "Not recorded programs:\n\n" + notRecorded + "\n\n";
- }
- if (recorded.length() == 0 && notRecorded.length() == 0) {
- msg += "No suitable programs found";
- }
- if (failures.length() > 0) {
- msg += "Failures:\n\n" + failures;
- }
+ executor.commit();
+ String msg = executor.getReport();
System.out.println(msg);
sendMail(msg);
}
/**
+ * Creates the crawler.
+ *
* @param aCrawlerConfig
- * @param os
- * @param client
- * @return
+ * Crawler configuration file.
+ * @param aOs
+ * Logging output stream for the crawler.
+ * @param aClient
+ * HTTP Client to use.
+ * @return Crawler.
* @throws FileNotFoundException
+ * In case configuration files cannot be found.
*/
- private Crawler createCrawler(String aCrawlerConfig, PrintStream os,
- HttpClient client) throws FileNotFoundException {
- ConfigurationParser parser = new ConfigurationParser(os);
+ private Crawler createCrawler(String aCrawlerConfig, PrintStream aOs,
+ HttpClient aClient) throws FileNotFoundException {
+ ConfigurationParser parser = new ConfigurationParser(aOs);
InputStream crawlerConfigFile = new FileInputStream(new File(
aCrawlerConfig));
Configuration config = parser.parse(crawlerConfigFile);
- Crawler crawler = new CrawlerImpl(client, config);
+ Crawler crawler = new CrawlerImpl(aClient, config);
return crawler;
}
/**
+ * Gets the start page of the electronic programme guide. This involves
+ * login and navigation to a suitable start page after logging in.
+ *
* @param aStartUrl
- * @param crawler
- * @return
+ * URL of the electronic programme guide.
+ * @param aCrawler
+ * Crawler to use.
+ * @return Starting page.
*/
- private Page getStartPage(String aStartUrl, Crawler crawler) {
+ private Page getStartPage(String aStartUrl, Crawler aCrawler) {
try {
- Page page = crawler.getPage(aStartUrl);
+ Page page = aCrawler.getPage(aStartUrl);
return page.getAction("channels-favorites").execute();
} catch (PageException e) {
throw new RuntimeException(
}
}
- public static void main(String[] args) throws Exception {
- new KissCrawler(START_URL, CRAWLER_CONFIG, PROGRAM_CONFIG);
- }
-
- private void showPage(Page aPage) {
- Action[] links = aPage.getActions();
- for (Action link : links) {
- System.out.println("Link found '" + link.getName() + "'");
- }
- Element element = aPage.getContent();
- System.out.println("Retrieved content: " + element.asXML());
- }
-
- private TVGuide createGuide(Page page) {
+ /**
+ * Creates the TV guide by web crawling.
+ *
+ * @param aPage
+ * Starting page.
+ * @return TV guide.
+ */
+ private TVGuide createGuide(Page aPage) {
LOG.info("Obtaining full TV guide");
- Action[] actions = page.getActions();
+ Action[] actions = aPage.getActions();
List<Channel> channels = new ArrayList<Channel>();
for (Action action : actions) {
try {
Channel channel = createChannel(action.getName(), action
.execute().getAction("right-now").execute());
channels.add(channel);
+ if (SystemProperties.isDebugMode()) {
+ break; // Only one channel is crawled.
+ }
} catch (PageException e) {
LOG.error("Could not create channel information for '"
+ action.getName() + "'", e);
return new TVGuide(channels);
}
+ /**
+ * Create channel information for a specific channel.
+ *
+ * @param aChannel
+ * Channel name.
+ * @param aPage
+ * Starting page for the channel.
+ * @return Channel.
+ */
private Channel createChannel(String aChannel, Page aPage) {
LOG.info("Obtaining program for " + aChannel);
Action[] programActions = aPage.getActions();
Time end = new Time(Integer.parseInt(matcher.group(3)), Integer
.parseInt(matcher.group(4)));
TimeInterval interval = new TimeInterval(begin, end);
- // Page programInfo = action.execute();
- // String description =
- // programInfo.getContent().element("description").getText().trim();
- // String keywords =
- // programInfo.getContent().element("keywords").getText().trim();
String description = "";
String keywords = "";
+ if (!SystemProperties.isNoProgramDetailsRequired()) {
+ try {
+ Page programInfo = action.execute();
+ description = programInfo.getContent().element(
+ "description").getText().trim();
+ keywords = programInfo.getContent().element("keywords")
+ .getText().trim();
+ } catch (PageException e) {
+ LOG
+ .warn("Program details could not be determined for '"
+ + action.getName() + "'", e);
+ }
+ }
Program program = new Program(aChannel, action.getName(),
description, keywords, interval, action);
- LOG.debug("Got program " + program);
+ LOG.info("Got program " + program);
programs.add(program);
}
}
return new Channel(aChannel, programs);
}
- private void sendMail(String aText) throws AddressException,
- MessagingException {
+ /**
+ * Sends a summary mail to the user.
+ *
+ * @param aText
+ * Text of the mail.
+ * @throws MessagingException
+ * In case of problems sending mail.
+ */
+ private void sendMail(String aText) throws MessagingException {
Properties props = new Properties();
props.put("mail.transport.protocol", "smtp");
props.put("mail.smtp.host", "falcon");
message.setText(aText);
Transport.send(message);
}
+
}
git://wamblee.org / utils / blobdiff