Updated 'core'.
[hub.git] / application / hub / main / filter / task / crawler / class_CrawlerTaskHandlerInitializerFilter.php
1 <?php
2 /**
3  * A TaskHandlerInitializer filter for crawler
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2014 Crawler Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 class CrawlerTaskHandlerInitializerFilter extends BaseCrawlerFilter implements Filterable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates an instance of this filter class
37          *
38          * @return      $filterInstance         An instance of this filter class
39          */
40         public static final function createCrawlerTaskHandlerInitializerFilter () {
41                 // Get a new instance
42                 $filterInstance = new CrawlerTaskHandlerInitializerFilter();
43
44                 // Return the instance
45                 return $filterInstance;
46         }
47
48         /**
49          * Executes the filter with given request and response objects
50          *
51          * @param       $requestInstance        An instance of a class with an Requestable interface
52          * @param       $responseInstance       An instance of a class with an Responseable interface
53          * @return      void
54          * @throws      FilterChainException    If the filter chain needs to be interrupted
55          * @todo        10% done
56          */
57         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
58                 // Get crawler instance
59                 //$crawlerInstance = Registry::getRegistry()->getInstance('crawler');
60
61                 // Get a new task handler instance
62                 $handlerInstance = ObjectFactory::createObjectByConfiguredName('task_handler_class');
63
64                 // Put the task handler in registry
65                 Registry::getRegistry()->addInstance('task_handler', $handlerInstance);
66
67                 /*
68                  * Register all tasks:
69                  *
70                  * 1) "Communicator" for crawler->node communication
71                  */
72                 $taskInstance = ObjectFactory::createObjectByConfiguredName('crawler_node_communicator_task_class');
73                 $handlerInstance->registerTask('crawler_node_communicator', $taskInstance);
74
75                 // 2) Local URL crawler (gets URLs locally and adds them to the analyzer's input stack)
76                 $taskInstance = ObjectFactory::createObjectByConfiguredName('crawler_local_url_crawler_task_class');
77                 $handlerInstance->registerTask('crawler_local_url_crawler', $taskInstance);
78
79                 // 3) Remote URL crawler (gets URLs locally for other nodes, also includes the crawled URL in local index)
80                 $taskInstance = ObjectFactory::createObjectByConfiguredName('crawler_remote_url_crawler_task_class');
81                 $handlerInstance->registerTask('crawler_remote_url_crawler', $taskInstance);
82
83                 // 4) Remote-crawl publisher (publishes crawl jobs for remote retrieval)
84                 $taskInstance = ObjectFactory::createObjectByConfiguredName('crawler_remote_job_publisher_task_class');
85                 $handlerInstance->registerTask('crawler_remote_job_publisher', $taskInstance);
86
87                 // 5) MIME sniffer
88                 $taskInstance = ObjectFactory::createObjectByConfiguredName('crawler_mime_sniffer_task_class');
89                 $handlerInstance->registerTask('crawler_mime_sniffer', $taskInstance);
90
91                 // 6) Document parser (converts document to meta format)
92                 $taskInstance = ObjectFactory::createObjectByConfiguredName('crawler_document_parser_task_class');
93                 $handlerInstance->registerTask('crawler_document_parser', $taskInstance);
94
95                 // 7) Document structure analyzer
96                 $taskInstance = ObjectFactory::createObjectByConfiguredName('crawler_structure_analyzer_task_class');
97                 $handlerInstance->registerTask('crawler_structure_analyzer', $taskInstance);
98
99                 // 8) Snippet extractor
100                 $taskInstance = ObjectFactory::createObjectByConfiguredName('crawler_snippet_extractor_task_class');
101                 $handlerInstance->registerTask('crawler_snippet_extractor', $taskInstance);
102
103                 // 9) Node ping
104                 $taskInstance = ObjectFactory::createObjectByConfiguredName('crawler_ping_task_class');
105                 $handlerInstance->registerTask('crawler_ping', $taskInstance);
106
107                 // 10) URL sources
108                 foreach (explode(':', $this->getConfigInstance()->getConfigEntry('crawler_url_stacks')) as $stack) {
109                         // Init task instance
110                         $taskInstance = ObjectFactory::createObjectByConfiguredName('crawler_url_source_' . $stack . '_task_class');
111
112                         // And register it
113                         $handlerInstance->registerTask('crawler_url_source_' . $stack, $taskInstance);
114                 } // END - foreach
115
116                 // 11) Uploaded list scanner (checks for wanted files)
117                 $taskInstance = ObjectFactory::createObjectByConfiguredName('crawler_uploaded_list_scanner_task_class');
118                 $handlerInstance->registerTask('crawler_uploaded_list_scanner', $taskInstance);
119         }
120 }
121
122 // [EOF]
123 ?>