(no commit message)
[utils] / crawler / src / org / wamblee / crawler / impl / ConfigurationParser.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.impl;
18
19 import java.io.InputStream;
20 import java.io.PrintStream;
21 import java.util.ArrayList;
22 import java.util.Iterator;
23 import java.util.List;
24
25 import org.apache.commons.httpclient.NameValuePair;
26 import org.dom4j.Document;
27 import org.dom4j.DocumentException;
28 import org.dom4j.Element;
29 import org.dom4j.io.SAXReader;
30 import org.wamblee.crawler.Configuration;
31 import org.wamblee.crawler.GetPageRequest;
32 import org.wamblee.crawler.PageRequest;
33 import org.wamblee.crawler.PostPageRequest;
34
35 /**
36  * Parsing of the configuration from an XML file.
37  */
38 public class ConfigurationParser {
39     
40     private static final String ELEM_URL = "url"; 
41     private static final String ELEM_TYPE = "type";
42     private static final String ELEM_PATTERN = "pattern"; 
43     private static final String ELEM_METHOD= "method"; 
44     private static final String ELEM_XSLT = "xslt"; 
45     private static final String ELEM_PARAM = "param"; 
46     private static final String AT_NAME = "name";
47     private static final String AT_VALUE = "value";
48     
49     private static final String METHOD_POST = "post";
50     private static final String METHOD_GET = "get";
51     
52     private PrintStream _os; 
53     
54     public ConfigurationParser(PrintStream aOs) {
55         _os = aOs;
56     }
57
58     public Configuration parse(InputStream aStream) {
59         try {
60             SAXReader reader = new SAXReader();
61             Document document = reader.read(aStream);
62             
63             Element root = document.getRootElement(); 
64             List<UrlConfig> urlConfigs = parseUrlConfigs(root);
65             List<PageTypeConfig> pageTypeConfigs = parsePageTypeConfigs(root); 
66             return new ConfigurationImpl(urlConfigs, pageTypeConfigs);
67         } catch (DocumentException e) {
68             throw new RuntimeException("Problem parsing config file", e);
69         }
70     }
71
72     /**
73      * @param root
74      * @return
75      */
76     private List<UrlConfig> parseUrlConfigs(Element root) {
77         List<UrlConfig> configs = new ArrayList<UrlConfig>();
78         for (Iterator i = root.elementIterator(ELEM_URL); i.hasNext(); ) { 
79             Element url = (Element)i.next();
80             UrlConfig config = parseUrlConfig(url);
81             configs.add(config);
82         }
83         return configs;
84     }
85     
86     private List<PageTypeConfig> parsePageTypeConfigs(Element root) {
87         List<PageTypeConfig> configs = new ArrayList<PageTypeConfig>();
88         for (Iterator i = root.elementIterator(ELEM_TYPE); i.hasNext(); ) { 
89             Element url = (Element)i.next();
90             PageTypeConfig config = parsePageTypeConfig(url);
91             configs.add(config);
92         }
93         return configs;
94     }
95     
96     private UrlConfig parseUrlConfig(Element aUrlElem) { 
97         String pattern = aUrlElem.elementText(ELEM_PATTERN);
98         PageRequest request = parseRequestConfig(aUrlElem);
99         return new UrlConfig(pattern, request);
100     }
101     
102     private PageTypeConfig parsePageTypeConfig(Element aTypeElem) { 
103         String pattern = aTypeElem.elementText(ELEM_PATTERN);
104         PageRequest request = parseRequestConfig(aTypeElem);
105         return new PageTypeConfig(pattern, request);
106     }
107
108     /**
109      * @param aUrlElem
110      * @return
111      */
112     private PageRequest parseRequestConfig(Element aUrlElem) {
113         String method = aUrlElem.elementText(ELEM_METHOD); 
114         String xslt = aUrlElem.elementText(ELEM_XSLT);
115         List<NameValuePair> params = new ArrayList<NameValuePair>();
116         for (Iterator i = aUrlElem.elementIterator(ELEM_PARAM); i.hasNext(); ) { 
117             Element paramElem = (Element)i.next();
118             NameValuePair param = parseParameter(paramElem);
119             params.add(param);
120         }
121     
122         NameValuePair[] paramsArray = params.toArray(new NameValuePair[0]);
123         PageRequest request; 
124         if ( METHOD_POST.equals(method)) { 
125             request = new PostPageRequest(paramsArray, xslt, _os);
126         }
127         else if ( METHOD_GET.equals(method) || method == null ){
128             request = new GetPageRequest(paramsArray, xslt, _os);
129         } else { 
130             throw new RuntimeException("Unknown request method '" + method + "'. Only " + 
131                     METHOD_GET + " and " + METHOD_POST + " are supported");
132         }
133         return request;
134     }
135     
136     private NameValuePair parseParameter(Element aParam) { 
137         String name = aParam.attributeValue(AT_NAME);
138         String value = aParam.attributeValue(AT_VALUE);
139         return new NameValuePair(name, value);
140     }
141 }