Fixed bug #12838: Deactivated fields of $TYPO3_USER_SETTINGS are changed by the modul...
[Packages/TYPO3.CMS.git] / typo3 / sysext / indexed_search / class.indexer.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2001-2009 Kasper Skaarhoj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * This class is a search indexer for TYPO3
29 *
30 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
31 * Originally Christian Jul Jensen <christian@jul.net> helped as well.
32 */
33 /**
34 * [CLASS/FUNCTION INDEX of SCRIPT]
35 *
36 *
37 *
38 * 141: class tx_indexedsearch_indexer
39 * 207: function hook_indexContent(&$pObj)
40 *
41 * SECTION: Backend API
42 * 308: function backend_initIndexer($id, $type, $sys_language_uid, $MP, $uidRL, $cHash_array=array(), $createCHash=FALSE)
43 * 347: function backend_setFreeIndexUid($freeIndexUid, $freeIndexSetId=0)
44 * 365: function backend_indexAsTYPO3Page($title, $keywords, $description, $content, $charset, $mtime, $crdate=0, $recordUid=0)
45 *
46 * SECTION: Initialization
47 * 416: function init()
48 * 468: function initializeExternalParsers()
49 *
50 * SECTION: Indexing; TYPO3 pages (HTML content)
51 * 509: function indexTypo3PageContent()
52 * 596: function splitHTMLContent($content)
53 * 642: function getHTMLcharset($content)
54 * 657: function convertHTMLToUtf8($content,$charset='')
55 * 685: function embracingTags($string,$tagName,&$tagContent,&$stringAfter,&$paramList)
56 * 712: function typoSearchTags(&$body)
57 * 741: function extractLinks($content)
58 * 812: function extractHyperLinks($string)
59 *
60 * SECTION: Indexing; external URL
61 * 871: function indexExternalUrl($externalUrl)
62 * 902: function getUrlHeaders($url)
63 *
64 * SECTION: Indexing; external files (PDF, DOC, etc)
65 * 948: function indexRegularDocument($file, $force=FALSE, $contentTmpFile='', $altExtension='')
66 * 1054: function readFileContent($ext,$absFile,$cPKey)
67 * 1071: function fileContentParts($ext,$absFile)
68 * 1089: function splitRegularContent($content)
69 *
70 * SECTION: Analysing content, Extracting words
71 * 1122: function charsetEntity2utf8(&$contentArr, $charset)
72 * 1145: function processWordsInArrays($contentArr)
73 * 1170: function procesWordsInArrays($contentArr)
74 * 1180: function bodyDescription($contentArr)
75 * 1202: function indexAnalyze($content)
76 * 1223: function analyzeHeaderinfo(&$retArr,$content,$key,$offset)
77 * 1242: function analyzeBody(&$retArr,$content)
78 * 1262: function metaphone($word,$retRaw=FALSE)
79 *
80 * SECTION: SQL; TYPO3 Pages
81 * 1304: function submitPage()
82 * 1378: function submit_grlist($hash,$phash_x)
83 * 1398: function submit_section($hash,$hash_t3)
84 * 1416: function removeOldIndexedPages($phash)
85 *
86 * SECTION: SQL; External media
87 * 1459: function submitFilePage($hash,$file,$subinfo,$ext,$mtime,$ctime,$size,$content_md5h,$contentParts)
88 * 1525: function submitFile_grlist($hash)
89 * 1539: function submitFile_section($hash)
90 * 1553: function removeOldIndexedFiles($phash)
91 *
92 * SECTION: SQL Helper functions
93 * 1589: function checkMtimeTstamp($mtime,$phash)
94 * 1625: function checkContentHash()
95 * 1642: function checkExternalDocContentHash($hashGr,$content_md5h)
96 * 1656: function is_grlist_set($phash_x)
97 * 1669: function update_grlist($phash,$phash_x)
98 * 1684: function updateTstamp($phash,$mtime=0)
99 * 1699: function updateSetId($phash)
100 * 1714: function updateParsetime($phash,$parsetime)
101 * 1727: function updateRootline()
102 * 1742: function getRootLineFields(&$fieldArr)
103 * 1761: function removeLoginpagesWithContentHash()
104 * 1778: function includeCrawlerClass()
105 *
106 * SECTION: SQL; Submitting words
107 * 1805: function checkWordList($wl)
108 * 1842: function submitWords($wl,$phash)
109 * 1866: function freqMap($freq)
110 *
111 * SECTION: Hashing
112 * 1899: function setT3Hashes()
113 * 1925: function setExtHashes($file,$subinfo=array())
114 * 1949: function md5inthash($str)
115 * 1959: function makeCHash($paramArray)
116 *
117 * SECTION: Internal logging functions
118 * 1991: function log_push($msg,$key)
119 * 2000: function log_pull()
120 * 2011: function log_setTSlogMessage($msg, $errorNum=0)
121 *
122 * SECTION: tslib_fe hooks:
123 * 2036: function fe_headerNoCache(&$params, $ref)
124 *
125 * TOTAL FUNCTIONS: 59
126 * (This index is automatically created/updated by the extension "extdeveval")
127 *
128 */
129 /**
130 * Indexing class for TYPO3 frontend
131 *
132 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
133 * @package TYPO3
134 * @subpackage tx_indexedsearch
135 */
136 class tx_indexedsearch_indexer {
137
138 // Messages:
139 var $reasons = array(
140 -1 => 'mtime matched the document, so no changes detected and no content updated',
141 -2 => 'The minimum age was not exceeded',
142 1 => "The configured max-age was exceeded for the document and thus it's indexed.",
143 2 => 'The minimum age was exceed and mtime was set and the mtime was different, so the page was indexed.',
144 3 => 'The minimum age was exceed, but mtime was not set, so the page was indexed.',
145 4 => 'Page has never been indexed (is not represented in the index_phash table).'
146 );
147
148 // HTML code blocks to exclude from indexing:
149 var $excludeSections = 'script,style';
150
151 // Supported Extensions for external files:
152 var $external_parsers = array(); // External parser objects, keys are file extension names. Values are objects with certain methods.
153
154 // Fe-group list (pages might be indexed separately for each usergroup combination to support search in access limited pages!)
155 var $defaultGrList = '0,-1';
156
157 // Min/Max times:
158 var $tstamp_maxAge = 0; // If set, this tells a number of seconds that is the maximum age of an indexed document. Regardless of mtime the document will be re-indexed if this limit is exceeded.
159 var $tstamp_minAge = 0; // If set, this tells a minimum limit before a document can be indexed again. This is regardless of mtime.
160 var $maxExternalFiles = 0; // Max number of external files to index.
161
162 var $forceIndexing = FALSE; // If true, indexing is forced despite of hashes etc.
163 var $crawlerActive = FALSE; // Set when crawler is detected (internal)
164
165 // INTERNALS:
166 var $defaultContentArray=array(
167 'title' => '',
168 'description' => '',
169 'keywords' => '',
170 'body' => '',
171 );
172 var $wordcount = 0;
173 var $externalFileCounter = 0;
174
175 var $conf = array(); // Configuration set internally (see init functions for required keys and their meaning)
176 var $indexerConfig = array(); // Indexer configuration, coming from $GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf']['indexed_search']
177 var $hash = array(); // Hash array, contains phash and phash_grouping
178 var $file_phash_arr = array(); // Hash array for files
179 var $contentParts = array(); // Content of TYPO3 page
180 var $content_md5h = '';
181 var $internal_log = array(); // Internal log
182 var $indexExternalUrl_content = '';
183
184 var $cHashParams = array(); // cHashparams array
185
186 var $freqRange = 32000;
187 var $freqMax = 0.1;
188
189 // Objects:
190 /**
191 * Charset class object
192 *
193 * @var t3lib_cs
194 */
195 var $csObj;
196
197 /**
198 * Metaphone object, if any
199 *
200 * @var user_DoubleMetaPhone
201 */
202 var $metaphoneObj;
203
204 /**
205 * Lexer object for word splitting
206 *
207 * @var tx_indexedsearch_lexer
208 */
209 var $lexerObj;
210
211
212
213 /**
214 * Parent Object (TSFE) Initialization
215 *
216 * @param object Parent Object (frontend TSFE object), passed by reference
217 * @return void
218 */
219 function hook_indexContent(&$pObj) {
220
221 // Indexer configuration from Extension Manager interface:
222 $indexerConfig = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf']['indexed_search']);
223
224 // Crawler activation:
225 // Requirements are that the crawler is loaded, a crawler session is running and re-indexing requested as processing instruction:
226 if (t3lib_extMgm::isLoaded('crawler')
227 && $pObj->applicationData['tx_crawler']['running']
228 && in_array('tx_indexedsearch_reindex', $pObj->applicationData['tx_crawler']['parameters']['procInstructions'])) {
229
230 // Setting simple log message:
231 $pObj->applicationData['tx_crawler']['log'][] = 'Forced Re-indexing enabled';
232
233 // Setting variables:
234 $this->crawlerActive = TRUE; // Crawler active flag
235 $this->forceIndexing = TRUE; // Force indexing despite timestamps etc.
236 }
237
238 // Determine if page should be indexed, and if so, configure and initialize indexer
239 if ($pObj->config['config']['index_enable']) {
240 $this->log_push('Index page','');
241
242 if (!$indexerConfig['disableFrontendIndexing'] || $this->crawlerActive) {
243 if (!$pObj->page['no_search']) {
244 if (!$pObj->no_cache) {
245 if (!strcmp($pObj->sys_language_uid,$pObj->sys_language_content)) {
246
247 // Setting up internal configuration from config array:
248 $this->conf = array();
249
250 // Information about page for which the indexing takes place
251 $this->conf['id'] = $pObj->id; // Page id
252 $this->conf['type'] = $pObj->type; // Page type
253 $this->conf['sys_language_uid'] = $pObj->sys_language_uid; // sys_language UID of the language of the indexing.
254 $this->conf['MP'] = $pObj->MP; // MP variable, if any (Mount Points)
255 $this->conf['gr_list'] = $pObj->gr_list; // Group list
256
257 $this->conf['cHash'] = $pObj->cHash; // cHash string for additional parameters
258 $this->conf['cHash_array'] = $pObj->cHash_array; // Array of the additional parameters
259
260 $this->conf['crdate'] = $pObj->page['crdate']; // The creation date of the TYPO3 page
261 $this->conf['page_cache_reg1'] = $pObj->page_cache_reg1; // reg1 of the caching table. Not known what practical use this has.
262
263 // Root line uids
264 $this->conf['rootline_uids'] = array();
265 foreach($pObj->config['rootLine'] as $rlkey => $rldat) {
266 $this->conf['rootline_uids'][$rlkey] = $rldat['uid'];
267 }
268
269 // Content of page:
270 $this->conf['content'] = $pObj->content; // Content string (HTML of TYPO3 page)
271 $this->conf['indexedDocTitle'] = $pObj->convOutputCharset($pObj->indexedDocTitle); // Alternative title for indexing
272 $this->conf['metaCharset'] = $pObj->metaCharset; // Character set of content (will be converted to utf-8 during indexing)
273 $this->conf['mtime'] = $pObj->register['SYS_LASTCHANGED']; // Most recent modification time (seconds) of the content on the page. Used to evaluate whether it should be re-indexed.
274
275 // Configuration of behavior:
276 $this->conf['index_externals'] = $pObj->config['config']['index_externals']; // Whether to index external documents like PDF, DOC etc. (if possible)
277 $this->conf['index_descrLgd'] = $pObj->config['config']['index_descrLgd']; // Length of description text (max 250, default 200)
278 $this->conf['index_metatags'] = isset($pObj->config['config']['index_metatags']) ? $pObj->config['config']['index_metatags'] : true;
279
280 // Set to zero:
281 $this->conf['recordUid'] = 0;
282 $this->conf['freeIndexUid'] = 0;
283 $this->conf['freeIndexSetId'] = 0;
284
285 // Init and start indexing:
286 $this->init();
287 $this->indexTypo3PageContent();
288 } else $this->log_setTSlogMessage('Index page? No, ->sys_language_uid was different from sys_language_content which indicates that the page contains fall-back content and that would be falsely indexed as localized content.');
289 } else $this->log_setTSlogMessage('Index page? No, page was set to "no_cache" and so cannot be indexed.');
290 } else $this->log_setTSlogMessage('Index page? No, The "No Search" flag has been set in the page properties!');
291 } else $this->log_setTSlogMessage('Index page? No, Ordinary Frontend indexing during rendering is disabled.');
292 $this->log_pull();
293 }
294 }
295
296
297
298
299
300
301
302
303 /****************************
304 *
305 * Backend API
306 *
307 ****************************/
308
309 /**
310 * Initializing the "combined ID" of the page (phash) being indexed (or for which external media is attached)
311 *
312 * @param integer The page uid, &id=
313 * @param integer The page type, &type=
314 * @param integer sys_language uid, typically &L=
315 * @param string The MP variable (Mount Points), &MP=
316 * @param array Rootline array of only UIDs.
317 * @param array Array of GET variables to register with this indexing
318 * @param boolean If set, calculates a cHash value from the $cHash_array. Probably you will not do that since such cases are indexed through the frontend and the idea of this interface is to index non-cachable pages from the backend!
319 * @return void
320 */
321 function backend_initIndexer($id, $type, $sys_language_uid, $MP, $uidRL, $cHash_array=array(), $createCHash=FALSE) {
322
323 // Setting up internal configuration from config array:
324 $this->conf = array();
325
326 // Information about page for which the indexing takes place
327 $this->conf['id'] = $id; // Page id (integer)
328 $this->conf['type'] = $type; // Page type (integer)
329 $this->conf['sys_language_uid'] = $sys_language_uid; // sys_language UID of the language of the indexing (integer)
330 $this->conf['MP'] = $MP; // MP variable, if any (Mount Points) (string)
331 $this->conf['gr_list'] = '0,-1'; // Group list (hardcoded for now...)
332
333 // cHash values:
334 $this->conf['cHash'] = $createCHash ? t3lib_div::generateCHash(t3lib_div::implodeArrayForUrl('', $cHash_array)) : ''; // cHash string for additional parameters
335 $this->conf['cHash_array'] = $cHash_array; // Array of the additional parameters
336
337 // Set to defaults
338 $this->conf['freeIndexUid'] = 0;
339 $this->conf['freeIndexSetId'] = 0;
340 $this->conf['page_cache_reg1'] = '';
341
342 // Root line uids
343 $this->conf['rootline_uids'] = $uidRL;
344
345 // Configuration of behavior:
346 $this->conf['index_externals'] = 1; // Whether to index external documents like PDF, DOC etc. (if possible)
347 $this->conf['index_descrLgd'] = 200; // Length of description text (max 250, default 200)
348 $this->conf['index_metatags'] = true; // Whether to index document keywords and description (if present)
349
350 // Init and start indexing:
351 $this->init();
352 }
353
354 /**
355 * Sets the free-index uid. Can be called right after backend_initIndexer()
356 *
357 * @param integer Free index UID
358 * @param integer Set id - an integer identifying the "set" of indexing operations.
359 * @return void
360 */
361 function backend_setFreeIndexUid($freeIndexUid, $freeIndexSetId=0) {
362 $this->conf['freeIndexUid'] = $freeIndexUid;
363 $this->conf['freeIndexSetId'] = $freeIndexSetId;
364 }
365
366 /**
367 * Indexing records as the content of a TYPO3 page.
368 *
369 * @param string Title equivalent
370 * @param string Keywords equivalent
371 * @param string Description equivalent
372 * @param string The main content to index
373 * @param string The charset of the title, keyword, description and body-content. MUST BE VALID, otherwise nothing is indexed!
374 * @param integer Last modification time, in seconds
375 * @param integer The creation date of the content, in seconds
376 * @param integer The record UID that the content comes from (for registration with the indexed rows)
377 * @return void
378 */
379 function backend_indexAsTYPO3Page($title, $keywords, $description, $content, $charset, $mtime, $crdate=0, $recordUid=0) {
380
381 // Content of page:
382 $this->conf['mtime'] = $mtime; // Most recent modification time (seconds) of the content
383 $this->conf['crdate'] = $crdate; // The creation date of the TYPO3 content
384 $this->conf['recordUid'] = $recordUid; // UID of the record, if applicable
385
386 // Construct fake HTML for parsing:
387 $this->conf['content'] = '
388 <html>
389 <head>
390 <title>'.htmlspecialchars($title).'</title>
391 <meta name="keywords" content="'.htmlspecialchars($keywords).'" />
392 <meta name="description" content="'.htmlspecialchars($description).'" />
393 </head>
394 <body>
395 '.htmlspecialchars($content).'
396 </body>
397 </html>'; // Content string (HTML of TYPO3 page)
398
399 // Initializing charset:
400 $this->conf['metaCharset'] = $charset; // Character set of content (will be converted to utf-8 during indexing)
401 $this->conf['indexedDocTitle'] = ''; // Alternative title for indexing
402
403 // Index content as if it was a TYPO3 page:
404 $this->indexTypo3PageContent();
405 }
406
407
408
409
410
411
412
413
414
415
416
417
418
419 /********************************
420 *
421 * Initialization
422 *
423 *******************************/
424
425 /**
426 * Initializes the object. $this->conf MUST be set with proper values prior to this call!!!
427 *
428 * @return void
429 */
430 function init() {
431 global $TYPO3_CONF_VARS;
432
433 // Initializing:
434 $this->cHashParams = $this->conf['cHash_array'];
435 if (is_array($this->cHashParams) && count($this->cHashParams)) {
436 if ($this->conf['cHash']) $this->cHashParams['cHash'] = $this->conf['cHash']; // Add this so that URL's come out right...
437 unset($this->cHashParams['encryptionKey']); // encryptionKey is added inside TSFE in order to calculate the cHash value and it should NOT be a part of this array!!! If it is it will be exposed in links!!!
438 }
439
440 // Setting phash / phash_grouping which identifies the indexed page based on some of these variables:
441 $this->setT3Hashes();
442
443 // Indexer configuration from Extension Manager interface:
444 $this->indexerConfig = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf']['indexed_search']);
445 $this->tstamp_minAge = t3lib_div::intInRange($this->indexerConfig['minAge']*3600,0);
446 $this->tstamp_maxAge = t3lib_div::intInRange($this->indexerConfig['maxAge']*3600,0);
447 $this->maxExternalFiles = t3lib_div::intInRange($this->indexerConfig['maxExternalFiles'],0,1000,5);
448 $this->flagBitMask = t3lib_div::intInRange($this->indexerConfig['flagBitMask'],0,255);
449
450 // Initialize external document parsers:
451 // Example configuration, see ext_localconf.php of this file!
452 if ($this->conf['index_externals']) {
453 $this->initializeExternalParsers();
454 }
455
456 // Initialize lexer (class that deconstructs the text into words):
457 // Example configuration (localconf.php) for this hook: $TYPO3_CONF_VARS['EXTCONF']['indexed_search']['lexer'] = 'EXT:indexed_search/class.lexer.php:&tx_indexedsearch_lexer';
458 $lexerObjRef = $TYPO3_CONF_VARS['EXTCONF']['indexed_search']['lexer'] ?
459 $TYPO3_CONF_VARS['EXTCONF']['indexed_search']['lexer'] :
460 'EXT:indexed_search/class.lexer.php:&tx_indexedsearch_lexer';
461 $this->lexerObj = t3lib_div::getUserObj($lexerObjRef);
462 $this->lexerObj->debug = $this->indexerConfig['debugMode'];
463
464 // Initialize metaphone hook:
465 // Example configuration (localconf.php) for this hook: $TYPO3_CONF_VARS['EXTCONF']['indexed_search']['metaphone'] = 'EXT:indexed_search/class.doublemetaphone.php:&user_DoubleMetaPhone';
466 if ($TYPO3_CONF_VARS['EXTCONF']['indexed_search']['metaphone']) {
467 $this->metaphoneObj = t3lib_div::getUserObj($TYPO3_CONF_VARS['EXTCONF']['indexed_search']['metaphone']);
468 $this->metaphoneObj->pObj = $this;
469 }
470
471 // Init charset class:
472 $this->csObj = t3lib_div::makeInstance('t3lib_cs');
473 }
474
475 /**
476 * Initialize external parsers
477 *
478 * @return void
479 * @access private
480 * @see init()
481 */
482 function initializeExternalParsers() {
483 global $TYPO3_CONF_VARS;
484
485 if (is_array($TYPO3_CONF_VARS['EXTCONF']['indexed_search']['external_parsers'])) {
486 foreach($TYPO3_CONF_VARS['EXTCONF']['indexed_search']['external_parsers'] as $extension => $_objRef) {
487 $this->external_parsers[$extension] = t3lib_div::getUserObj($_objRef);
488 $this->external_parsers[$extension]->pObj = $this;
489
490 // Init parser and if it returns false, unset its entry again:
491 if (!$this->external_parsers[$extension]->initParser($extension)) {
492 unset($this->external_parsers[$extension]);
493 }
494 }
495 }
496 }
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512 /********************************
513 *
514 * Indexing; TYPO3 pages (HTML content)
515 *
516 *******************************/
517
518 /**
519 * Start indexing of the TYPO3 page
520 *
521 * @return void
522 */
523 function indexTypo3PageContent() {
524
525 $check = $this->checkMtimeTstamp($this->conf['mtime'], $this->hash['phash']);
526 $is_grlist = $this->is_grlist_set($this->hash['phash']);
527
528 if ($check > 0 || !$is_grlist || $this->forceIndexing) {
529
530 // Setting message:
531 if ($this->forceIndexing) {
532 $this->log_setTSlogMessage('Indexing needed, reason: Forced',1);
533 } elseif ($check > 0) {
534 $this->log_setTSlogMessage('Indexing needed, reason: '.$this->reasons[$check],1);
535 } else {
536 $this->log_setTSlogMessage('Indexing needed, reason: Updates gr_list!',1);
537 }
538
539 // Divide into title,keywords,description and body:
540 $this->log_push('Split content','');
541 $this->contentParts = $this->splitHTMLContent($this->conf['content']);
542 if ($this->conf['indexedDocTitle']) {
543 $this->contentParts['title'] = $this->conf['indexedDocTitle'];
544 }
545 $this->log_pull();
546
547 // Calculating a hash over what is to be the actual page content. Maybe this hash should not include title,description and keywords? The bodytext is the primary concern. (on the other hand a changed page-title would make no difference then, so dont!)
548 $this->content_md5h = $this->md5inthash(implode($this->contentParts,''));
549
550 // This function checks if there is already a page (with gr_list = 0,-1) indexed and if that page has the very same contentHash.
551 // If the contentHash is the same, then we can rest assured that this page is already indexed and regardless of mtime and origContent we don't need to do anything more.
552 // This will also prevent pages from being indexed if a fe_users has logged in and it turns out that the page content is not changed anyway. fe_users logged in should always search with hash_gr_list = "0,-1" OR "[their_group_list]". This situation will be prevented only if the page has been indexed with no user login on before hand. Else the page will be indexed by users until that event. However that does not present a serious problem.
553 $checkCHash = $this->checkContentHash();
554 if (!is_array($checkCHash) || $check===1) {
555 $Pstart=t3lib_div::milliseconds();
556
557 $this->log_push('Converting charset of content ('.$this->conf['metaCharset'].') to utf-8','');
558 $this->charsetEntity2utf8($this->contentParts,$this->conf['metaCharset']);
559 $this->log_pull();
560
561 // Splitting words
562 $this->log_push('Extract words from content','');
563 $splitInWords = $this->processWordsInArrays($this->contentParts);
564 $this->log_pull();
565
566 // Analyse the indexed words.
567 $this->log_push('Analyse the extracted words','');
568 $indexArr = $this->indexAnalyze($splitInWords);
569 $this->log_pull();
570
571 // Submitting page (phash) record
572 $this->log_push('Submitting page','');
573 $this->submitPage();
574 $this->log_pull();
575
576 // Check words and submit to word list if not there
577 $this->log_push('Check word list and submit words','');
578 $this->checkWordList($indexArr);
579 $this->submitWords($indexArr,$this->hash['phash']);
580 $this->log_pull();
581
582 // Set parsetime
583 $this->updateParsetime($this->hash['phash'],t3lib_div::milliseconds()-$Pstart);
584
585 // Checking external files if configured for.
586 $this->log_push('Checking external files','');
587 if ($this->conf['index_externals']) {
588 $this->extractLinks($this->conf['content']);
589 }
590 $this->log_pull();
591 } else {
592 $this->updateTstamp($this->hash['phash'],$this->conf['mtime']); // Update the timestatmp
593 $this->updateSetId($this->hash['phash']);
594 $this->update_grlist($checkCHash['phash'],$this->hash['phash']); // $checkCHash['phash'] is the phash of the result row that is similar to the current phash regarding the content hash.
595 $this->updateRootline();
596 $this->log_setTSlogMessage('Indexing not needed, the contentHash, '.$this->content_md5h.', has not changed. Timestamp, grlist and rootline updated if necessary.');
597 }
598 } else {
599 $this->log_setTSlogMessage('Indexing not needed, reason: '.$this->reasons[$check]);
600 }
601 }
602
603 /**
604 * Splits HTML content and returns an associative array, with title, a list of metatags, and a list of words in the body.
605 *
606 * @param string HTML content to index. To some degree expected to be made by TYPO3 (ei. splitting the header by ":")
607 * @return array Array of content, having keys "title", "body", "keywords" and "description" set.
608 * @see splitRegularContent()
609 */
610 function splitHTMLContent($content) {
611
612 // divide head from body ( u-ouh :) )
613 $contentArr = $this->defaultContentArray;
614 $contentArr['body'] = stristr($content,'<body');
615 $headPart = substr($content,0,-strlen($contentArr['body']));
616
617 // get title
618 $this->embracingTags($headPart,'TITLE',$contentArr['title'],$dummy2,$dummy);
619 $titleParts = explode(':',$contentArr['title'],2);
620 $contentArr['title'] = trim(isset($titleParts[1]) ? $titleParts[1] : $titleParts[0]);
621
622 // get keywords and description metatags
623 if($this->conf['index_metatags']) {
624 for($i=0;$this->embracingTags($headPart,'meta',$dummy,$headPart,$meta[$i]);$i++) { /*nothing*/ }
625 for($i=0;isset($meta[$i]);$i++) {
626 $meta[$i] = t3lib_div::get_tag_attributes($meta[$i]);
627 if (stristr($meta[$i]['name'], 'keywords')) {
628 $contentArr['keywords'] .= ',' . $this->addSpacesToKeywordList($meta[$i]['content']);
629 }
630 if (stristr($meta[$i]['name'], 'description')) {
631 $contentArr['description'] .= ',' . $meta[$i]['content'];
632 }
633 }
634 }
635
636 // Process <!--TYPO3SEARCH_begin--> or <!--TYPO3SEARCH_end--> tags:
637 $this->typoSearchTags($contentArr['body']);
638
639 // Get rid of unwanted sections (ie. scripting and style stuff) in body
640 $tagList = explode(',',$this->excludeSections);
641 foreach($tagList as $tag) {
642 while($this->embracingTags($contentArr['body'],$tag,$dummy,$contentArr['body'],$dummy2));
643 }
644
645 // remove tags, but first make sure we don't concatenate words by doing it
646 $contentArr['body'] = str_replace('<',' <',$contentArr['body']);
647 $contentArr['body'] = trim(strip_tags($contentArr['body']));
648
649 $contentArr['keywords'] = trim($contentArr['keywords']);
650 $contentArr['description'] = trim($contentArr['description']);
651
652 // Return array
653 return $contentArr;
654 }
655
656 /**
657 * Extract the charset value from HTML meta tag.
658 *
659 * @param string HTML content
660 * @return string The charset value if found.
661 */
662 function getHTMLcharset($content) {
663 if (preg_match('/<meta[[:space:]]+[^>]*http-equiv[[:space:]]*=[[:space:]]*["\']CONTENT-TYPE["\'][^>]*>/i',$content,$reg)) {
664 if (preg_match('/charset[[:space:]]*=[[:space:]]*([[:alnum:]-]+)/i',$reg[0],$reg2)) {
665 return $reg2[1];
666 }
667 }
668 }
669
670 /**
671 * Converts a HTML document to utf-8
672 *
673 * @param string HTML content, any charset
674 * @param string Optional charset (otherwise extracted from HTML)
675 * @return string Converted HTML
676 */
677 function convertHTMLToUtf8($content,$charset='') {
678
679 // Find charset:
680 $charset = $charset ? $charset : $this->getHTMLcharset($content);
681 $charset = $this->csObj->parse_charset($charset);
682
683 // Convert charset:
684 if ($charset && $charset!=='utf-8') {
685 $content = $this->csObj->utf8_encode($content, $charset);
686 }
687 // Convert entities, assuming document is now UTF-8:
688 $content = $this->csObj->entities_to_utf8($content, TRUE);
689
690 return $content;
691 }
692
693 /**
694 * Finds first occurence of embracing tags and returns the embraced content and the original string with
695 * the tag removed in the two passed variables. Returns false if no match found. ie. useful for finding
696 * <title> of document or removing <script>-sections
697 *
698 * @param string String to search in
699 * @param string Tag name, eg. "script"
700 * @param string Passed by reference: Content inside found tag
701 * @param string Passed by reference: Content after found tag
702 * @param string Passed by reference: Attributes of the found tag.
703 * @return boolean Returns false if tag was not found, otherwise true.
704 */
705 function embracingTags($string,$tagName,&$tagContent,&$stringAfter,&$paramList) {
706 $endTag = '</'.$tagName.'>';
707 $startTag = '<'.$tagName;
708
709 $isTagInText = stristr($string,$startTag); // stristr used because we want a case-insensitive search for the tag.
710 if(!$isTagInText) return false; // if the tag was not found, return false
711
712 list($paramList,$isTagInText) = explode('>',substr($isTagInText,strlen($startTag)),2);
713 $afterTagInText = stristr($isTagInText,$endTag);
714 if ($afterTagInText) {
715 $stringBefore = substr($string, 0, strpos(strtolower($string), strtolower($startTag)));
716 $tagContent = substr($isTagInText,0,strlen($isTagInText)-strlen($afterTagInText));
717 $stringAfter = $stringBefore.substr($afterTagInText,strlen($endTag));
718 } else { // If there was no ending tag, the tagContent is blank and anything after the tag it self is returned.
719 $tagContent='';
720 $stringAfter = $isTagInText;
721 }
722
723 return true;
724 }
725
726 /**
727 * Removes content that shouldn't be indexed according to TYPO3SEARCH-tags.
728 *
729 * @param string HTML Content, passed by reference
730 * @return boolean Returns true if a TYPOSEARCH_ tag was found, otherwise false.
731 */
732 function typoSearchTags(&$body) {
733 $expBody = preg_split('/\<\!\-\-[\s]?TYPO3SEARCH_/',$body);
734
735 if(count($expBody)>1) {
736 $body = '';
737
738 foreach($expBody as $val) {
739 $part = explode('-->',$val,2);
740 if(trim($part[0])=='begin') {
741 $body.= $part[1];
742 $prev = '';
743 } elseif(trim($part[0])=='end') {
744 $body.= $prev;
745 } else {
746 $prev = $val;
747 }
748 }
749 return true;
750 } else {
751 return false;
752 }
753 }
754
755 /**
756 * Extract links (hrefs) from HTML content and if indexable media is found, it is indexed.
757 *
758 * @param string HTML content
759 * @return void
760 */
761 function extractLinks($content) {
762
763 // Get links:
764 $list = $this->extractHyperLinks($content);
765
766 if ($this->indexerConfig['useCrawlerForExternalFiles'] && t3lib_extMgm::isLoaded('crawler')) {
767 $this->includeCrawlerClass();
768 $crawler = t3lib_div::makeInstance('tx_crawler_lib');
769 }
770
771 // Traverse links:
772 foreach($list as $linkInfo) {
773
774 // Decode entities:
775 if ($linkInfo['localPath']) { // localPath means: This file is sent by a download script. While the indexed URL has to point to $linkInfo['href'], the absolute path to the file is specified here!
776 $linkSource = t3lib_div::htmlspecialchars_decode($linkInfo['localPath']);
777 } else {
778 $linkSource = t3lib_div::htmlspecialchars_decode($linkInfo['href']);
779 }
780
781 // Parse URL:
782 $qParts = parse_url($linkSource);
783
784 // Check for jumpurl (TYPO3 specific thing...)
785 if ($qParts['query'] && strstr($qParts['query'],'jumpurl=')) {
786 parse_str($qParts['query'],$getP);
787 $linkSource = $getP['jumpurl'];
788 $qParts = parse_url($linkSource); // parse again due to new linkSource!
789 }
790
791 if ($qParts['scheme']) {
792 if ($this->indexerConfig['indexExternalURLs']) {
793 // Index external URL (http or otherwise)
794 $this->indexExternalUrl($linkSource);
795 }
796 } elseif (!$qParts['query']) {
797 $linkSource = urldecode($linkSource);
798 if (t3lib_div::isAllowedAbsPath($linkSource)) {
799 $localFile = $linkSource;
800 } else {
801 $localFile = t3lib_div::getFileAbsFileName(PATH_site.$linkSource);
802 }
803 if ($localFile && @is_file($localFile)) {
804
805 // Index local file:
806 if ($linkInfo['localPath']) {
807
808 $fI = pathinfo($linkSource);
809 $ext = strtolower($fI['extension']);
810 if (is_object($crawler)) {
811 $params = array(
812 'document' => $linkSource,
813 'alturl' => $linkInfo['href'],
814 'conf' => $this->conf
815 );
816 unset($params['conf']['content']);
817
818 $crawler->addQueueEntry_callBack(0,$params,'EXT:indexed_search/class.crawler.php:&tx_indexedsearch_files',$this->conf['id']);
819 $this->log_setTSlogMessage('media "'.$params['document'].'" added to "crawler" queue.',1);
820 } else {
821 $this->indexRegularDocument($linkInfo['href'], false, $linkSource, $ext);
822 }
823 } else {
824 if (is_object($crawler)) {
825 $params = array(
826 'document' => $linkSource,
827 'conf' => $this->conf
828 );
829 unset($params['conf']['content']);
830 $crawler->addQueueEntry_callBack(0,$params,'EXT:indexed_search/class.crawler.php:&tx_indexedsearch_files',$this->conf['id']);
831 $this->log_setTSlogMessage('media "'.$params['document'].'" added to "crawler" queue.',1);
832 } else {
833 $this->indexRegularDocument($linkSource);
834 }
835 }
836 }
837 }
838 }
839 }
840
841 /**
842 * Extracts all links to external documents from content string.
843 *
844 * @param string Content to analyse
845 * @return array Array of hyperlinks
846 * @see extractLinks()
847 */
848 function extractHyperLinks($string) {
849 if (!is_object($this->htmlParser)) {
850 $this->htmlParser = t3lib_div::makeInstance('t3lib_parseHtml');
851 }
852
853 $parts = $this->htmlParser->splitTags('a',$string);
854 $list = array();
855 foreach ($parts as $k => $v) {
856 if ($k%2) {
857 $params = $this->htmlParser->get_tag_attributes($v,1);
858 $firstTagName = $this->htmlParser->getFirstTagName($v); // The 'name' of the first tag
859
860 switch (strtolower($firstTagName)) {
861 case 'a':
862 $src = $params[0]['href'];
863 if ($src) {
864 // Check if a local path to that file has been set - useful if you are using a download script.
865 $md5 = t3lib_div::shortMD5($src);
866 if (is_array($indexLocalFiles=$GLOBALS['T3_VAR']['ext']['indexed_search']['indexLocalFiles'])) {
867 $localPath = isset($indexLocalFiles[$md5]) ? $indexLocalFiles[$md5] : '';
868 } else $localPath=false;
869
870 $list[] = array(
871 'tag' => $v,
872 'href' => $params[0]['href'],
873 'localPath' => $localPath
874 );
875 }
876 break;
877 }
878 }
879 }
880
881 return $list;
882 }
883
884
885
886
887
888
889
890
891
892
893
894 /******************************************
895 *
896 * Indexing; external URL
897 *
898 ******************************************/
899
900 /**
901 * Index External URLs HTML content
902 *
903 * @param string URL, eg. "http://typo3.org/"
904 * @return void
905 * @see indexRegularDocument()
906 */
907 function indexExternalUrl($externalUrl) {
908
909 // Parse External URL:
910 $qParts = parse_url($externalUrl);
911 $fI = pathinfo($qParts['path']);
912 $ext = strtolower($fI['extension']);
913
914 // Get headers:
915 $urlHeaders = $this->getUrlHeaders($externalUrl);
916 if (stristr($urlHeaders['Content-Type'],'text/html')) {
917 $content = $this->indexExternalUrl_content = t3lib_div::getUrl($externalUrl);
918 if (strlen($content)) {
919
920 // Create temporary file:
921 $tmpFile = t3lib_div::tempnam('EXTERNAL_URL');
922 if ($tmpFile) {
923 t3lib_div::writeFile($tmpFile, $content);
924
925 // Index that file:
926 $this->indexRegularDocument($externalUrl, TRUE, $tmpFile, 'html'); // Using "TRUE" for second parameter to force indexing of external URLs (mtime doesn't make sense, does it?)
927 unlink($tmpFile);
928 }
929 }
930 }
931 }
932
933 /**
934 * Getting HTTP request headers of URL
935 *
936 * @param string The URL
937 * @param integer Timeout (seconds?)
938 * @return mixed If no answer, returns false. Otherwise an array where HTTP headers are keys
939 */
940 function getUrlHeaders($url) {
941 $content = t3lib_div::getURL($url,2); // Try to get the headers only
942
943 if (strlen($content)) {
944 // Compile headers:
945 $headers = t3lib_div::trimExplode(chr(10),$content,1);
946 $retVal = array();
947 foreach($headers as $line) {
948 if (!strlen(trim($line))) {
949 break; // Stop at the first empty line (= end of header)
950 }
951
952 list($headKey, $headValue) = explode(':', $line, 2);
953 $retVal[$headKey] = $headValue;
954 }
955 return $retVal;
956 }
957 }
958
959
960
961
962
963
964
965
966
967
968
969
970
971 /******************************************
972 *
973 * Indexing; external files (PDF, DOC, etc)
974 *
975 ******************************************/
976
977 /**
978 * Indexing a regular document given as $file (relative to PATH_site, local file)
979 *
980 * @param string Relative Filename, relative to PATH_site. It can also be an absolute path as long as it is inside the lockRootPath (validated with t3lib_div::isAbsPath()). Finally, if $contentTmpFile is set, this value can be anything, most likely a URL
981 * @param boolean If set, indexing is forced (despite content hashes, mtime etc).
982 * @param string Temporary file with the content to read it from (instead of $file). Used when the $file is a URL.
983 * @param string File extension for temporary file.
984 * @return void
985 */
986 function indexRegularDocument($file, $force=FALSE, $contentTmpFile='', $altExtension='') {
987
988 // Init
989 $fI = pathinfo($file);
990 $ext = $altExtension ? $altExtension : strtolower($fI['extension']);
991
992 // Create abs-path:
993 if (!$contentTmpFile) {
994 if (!t3lib_div::isAbsPath($file)) { // Relative, prepend PATH_site:
995 $absFile = t3lib_div::getFileAbsFileName(PATH_site.$file);
996 } else { // Absolute, pass-through:
997 $absFile = $file;
998 }
999 $absFile = t3lib_div::isAllowedAbsPath($absFile) ? $absFile : '';
1000 } else {
1001 $absFile = $contentTmpFile;
1002 }
1003
1004 // Indexing the document:
1005 if ($absFile && @is_file($absFile)) {
1006 if ($this->external_parsers[$ext]) {
1007 $mtime = filemtime($absFile);
1008 $cParts = $this->fileContentParts($ext,$absFile);
1009
1010 foreach($cParts as $cPKey) {
1011 $this->internal_log = array();
1012 $this->log_push('Index: '.str_replace('.','_',basename($file)).($cPKey?'#'.$cPKey:''),'');
1013 $Pstart = t3lib_div::milliseconds();
1014 $subinfo = array('key' => $cPKey); // Setting page range. This is "0" (zero) when no division is made, otherwise a range like "1-3"
1015 $phash_arr = $this->file_phash_arr = $this->setExtHashes($file,$subinfo);
1016 $check = $this->checkMtimeTstamp($mtime, $phash_arr['phash']);
1017 if ($check > 0 || $force) {
1018 if ($check > 0) {
1019 $this->log_setTSlogMessage('Indexing needed, reason: '.$this->reasons[$check],1);
1020 } else {
1021 $this->log_setTSlogMessage('Indexing forced by flag',1);
1022 }
1023
1024 // Check external file counter:
1025 if ($this->externalFileCounter < $this->maxExternalFiles || $force) {
1026
1027 // Divide into title,keywords,description and body:
1028 $this->log_push('Split content','');
1029 $contentParts = $this->readFileContent($ext,$absFile,$cPKey);
1030 $this->log_pull();
1031
1032 if (is_array($contentParts)) {
1033 // Calculating a hash over what is to be the actual content. (see indexTypo3PageContent())
1034 $content_md5h = $this->md5inthash(implode($contentParts,''));
1035
1036 if ($this->checkExternalDocContentHash($phash_arr['phash_grouping'], $content_md5h) || $force) {
1037
1038 // Increment counter:
1039 $this->externalFileCounter++;
1040
1041 // Splitting words
1042 $this->log_push('Extract words from content','');
1043 $splitInWords = $this->processWordsInArrays($contentParts);
1044 $this->log_pull();
1045
1046 // Analyse the indexed words.
1047 $this->log_push('Analyse the extracted words','');
1048 $indexArr = $this->indexAnalyze($splitInWords);
1049 $this->log_pull();
1050
1051 // Submitting page (phash) record
1052 $this->log_push('Submitting page','');
1053 $size = filesize($absFile);
1054 $ctime = filemtime($absFile); // Unfortunately I cannot determine WHEN a file is originally made - so I must return the modification time...
1055 $this->submitFilePage($phash_arr,$file,$subinfo,$ext,$mtime,$ctime,$size,$content_md5h,$contentParts);
1056 $this->log_pull();
1057
1058 // Check words and submit to word list if not there
1059 $this->log_push('Check word list and submit words','');
1060 $this->checkWordList($indexArr);
1061 $this->submitWords($indexArr,$phash_arr['phash']);
1062 $this->log_pull();
1063
1064 // Set parsetime
1065 $this->updateParsetime($phash_arr['phash'],t3lib_div::milliseconds()-$Pstart);
1066 } else {
1067 $this->updateTstamp($phash_arr['phash'],$mtime); // Update the timestamp
1068 $this->log_setTSlogMessage('Indexing not needed, the contentHash, '.$content_md5h.', has not changed. Timestamp updated.');
1069 }
1070 } else $this->log_setTSlogMessage('Could not index file! Unsupported extension.');
1071 } else $this->log_setTSlogMessage('The limit of '.$this->maxExternalFiles.' has already been exceeded, so no indexing will take place this time.');
1072 } else $this->log_setTSlogMessage('Indexing not needed, reason: '.$this->reasons[$check]);
1073
1074 // Checking and setting sections:
1075 # $this->submitFile_grlist($phash_arr['phash']); // Setting a gr_list record if there is none already (set for default fe_group)
1076 $this->submitFile_section($phash_arr['phash']); // Setting a section-record for the file. This is done also if the file is not indexed. Notice that section records are deleted when the page is indexed.
1077 $this->log_pull();
1078 }
1079 } else $this->log_setTSlogMessage('Indexing not possible; The extension "'.$ext.'" was not supported.');
1080 } else $this->log_setTSlogMessage('Indexing not possible; File "'.$absFile.'" not found or valid.');
1081 }
1082
1083 /**
1084 * Reads the content of an external file being indexed.
1085 * The content from the external parser MUST be returned in utf-8!
1086 *
1087 * @param string File extension, eg. "pdf", "doc" etc.
1088 * @param string Absolute filename of file (must exist and be validated OK before calling function)
1089 * @param string Pointer to section (zero for all other than PDF which will have an indication of pages into which the document should be splitted.)
1090 * @return array Standard content array (title, description, keywords, body keys)
1091 */
1092 function readFileContent($ext,$absFile,$cPKey) {
1093
1094 // Consult relevant external document parser:
1095 if (is_object($this->external_parsers[$ext])) {
1096 $contentArr = $this->external_parsers[$ext]->readFileContent($ext,$absFile,$cPKey);
1097 }
1098
1099 return $contentArr;
1100 }
1101
1102 /**
1103 * Creates an array with pointers to divisions of document.
1104 *
1105 * @param string File extension
1106 * @param string Absolute filename (must exist and be validated OK before calling function)
1107 * @return array Array of pointers to sections that the document should be divided into
1108 */
1109 function fileContentParts($ext,$absFile) {
1110 $cParts = array(0);
1111
1112 // Consult relevant external document parser:
1113 if (is_object($this->external_parsers[$ext])) {
1114 $cParts = $this->external_parsers[$ext]->fileContentParts($ext,$absFile);
1115 }
1116
1117 return $cParts;
1118 }
1119
1120 /**
1121 * Splits non-HTML content (from external files for instance)
1122 *
1123 * @param string Input content (non-HTML) to index.
1124 * @return array Array of content, having the key "body" set (plus "title", "description" and "keywords", but empty)
1125 * @see splitHTMLContent()
1126 */
1127 function splitRegularContent($content) {
1128 $contentArr = $this->defaultContentArray;
1129 $contentArr['body'] = $content;
1130
1131 return $contentArr;
1132 }
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147 /**********************************
1148 *
1149 * Analysing content, Extracting words
1150 *
1151 **********************************/
1152
1153 /**
1154 * Convert character set and HTML entities in the value of input content array keys
1155 *
1156 * @param array Standard content array
1157 * @param string Charset of the input content (converted to utf-8)
1158 * @return void
1159 */
1160 function charsetEntity2utf8(&$contentArr, $charset) {
1161
1162 // Convert charset if necessary
1163 reset($contentArr);
1164 while(list($key,)=each($contentArr)) {
1165 if (strlen($contentArr[$key])) {
1166
1167 if ($charset!=='utf-8') {
1168 $contentArr[$key] = $this->csObj->utf8_encode($contentArr[$key], $charset);
1169 }
1170
1171 // decode all numeric / html-entities in the string to real characters:
1172 $contentArr[$key] = $this->csObj->entities_to_utf8($contentArr[$key],TRUE);
1173 }
1174 }
1175 }
1176
1177 /**
1178 * Processing words in the array from split*Content -functions
1179 *
1180 * @param array Array of content to index, see splitHTMLContent() and splitRegularContent()
1181 * @return array Content input array modified so each key is not a unique array of words
1182 */
1183 function processWordsInArrays($contentArr) {
1184
1185 // split all parts to words
1186 reset($contentArr);
1187 while(list($key,)=each($contentArr)) {
1188 $contentArr[$key] = $this->lexerObj->split2Words($contentArr[$key]);
1189 }
1190
1191 // For title, keywords, and description we don't want duplicates:
1192 $contentArr['title'] = array_unique($contentArr['title']);
1193 $contentArr['keywords'] = array_unique($contentArr['keywords']);
1194 $contentArr['description'] = array_unique($contentArr['description']);
1195
1196 // Return modified array:
1197 return $contentArr;
1198 }
1199
1200 /**
1201 * Processing words in the array from split*Content -functions
1202 * This function is only a wrapper because the function has been removed (see above).
1203 *
1204 * @param array Array of content to index, see splitHTMLContent() and splitRegularContent()
1205 * @return array Content input array modified so each key is not a unique array of words
1206 * @deprecated since TYPO3 4.0, this function will be removed in TYPO3 4.5.
1207 */
1208 function procesWordsInArrays($contentArr) {
1209 t3lib_div::logDeprecatedFunction();
1210
1211 return $this->processWordsInArrays($contentArr);
1212 }
1213
1214 /**
1215 * Extracts the sample description text from the content array.
1216 *
1217 * @param array Content array
1218 * @return string Description string
1219 */
1220 function bodyDescription($contentArr) {
1221
1222 // Setting description
1223 $maxL = t3lib_div::intInRange($this->conf['index_descrLgd'],0,255,200);
1224 if ($maxL) {
1225 // Takes the quadruple lenght first, because whitespace and entities may be removed and thus shorten the string more yet.
1226 # $bodyDescription = implode(' ',split('[[:space:],]+',substr(trim($contentArr['body']),0,$maxL*4)));
1227 $bodyDescription = str_replace(array(' ',"\t","\r","\n"),' ',$contentArr['body']);
1228
1229 // Shorten the string:
1230 $bodyDescription = $this->csObj->strtrunc('utf-8', $bodyDescription, $maxL);
1231 }
1232
1233 return $bodyDescription;
1234 }
1235
1236 /**
1237 * Analyzes content to use for indexing,
1238 *
1239 * @param array Standard content array: an array with the keys title,keywords,description and body, which all contain an array of words.
1240 * @return array Index Array (whatever that is...)
1241 */
1242 function indexAnalyze($content) {
1243 $indexArr = Array();
1244 $counter = 0;
1245
1246 $this->analyzeHeaderinfo($indexArr,$content,'title',7);
1247 $this->analyzeHeaderinfo($indexArr,$content,'keywords',6);
1248 $this->analyzeHeaderinfo($indexArr,$content,'description',5);
1249 $this->analyzeBody($indexArr,$content);
1250
1251 return ($indexArr);
1252 }
1253
1254 /**
1255 * Calculates relevant information for headercontent
1256 *
1257 * @param array Index array, passed by reference
1258 * @param array Standard content array
1259 * @param string Key from standard content array
1260 * @param integer Bit-wise priority to type
1261 * @return void
1262 */
1263 function analyzeHeaderinfo(&$retArr,$content,$key,$offset) {
1264 reset($content[$key]);
1265 while(list(,$val)=each($content[$key])) {
1266 $val = substr($val,0,60); // Max 60 - because the baseword varchar IS 60. This MUST be the same.
1267 $retArr[$val]['cmp'] = $retArr[$val]['cmp']|pow(2,$offset);
1268 $retArr[$val]['count'] = $retArr[$val]['count']+1;
1269 $retArr[$val]['hash'] = hexdec(substr(md5($val),0,7));
1270 $retArr[$val]['metaphone'] = $this->metaphone($val);
1271 $this->wordcount++;
1272 }
1273 }
1274
1275 /**
1276 * Calculates relevant information for bodycontent
1277 *
1278 * @param array Index array, passed by reference
1279 * @param array Standard content array
1280 * @return void
1281 */
1282 function analyzeBody(&$retArr,$content) {
1283 foreach($content['body'] as $key => $val) {
1284 $val = substr($val,0,60); // Max 60 - because the baseword varchar IS 60. This MUST be the same.
1285 if(!isset($retArr[$val])) {
1286 $retArr[$val]['first'] = $key;
1287 $retArr[$val]['hash'] = hexdec(substr(md5($val),0,7));
1288 $retArr[$val]['metaphone'] = $this->metaphone($val);
1289 }
1290 $retArr[$val]['count'] = $retArr[$val]['count']+1;
1291 $this->wordcount++;
1292 }
1293 }
1294
1295 /**
1296 * Creating metaphone based hash from input word
1297 *
1298 * @param string Word to convert
1299 * @param boolean If set, returns the raw metaphone value (not hashed)
1300 * @return mixed Metaphone hash integer (or raw value, string)
1301 */
1302 function metaphone($word,$retRaw=FALSE) {
1303
1304 if (is_object($this->metaphoneObj)) {
1305 $tmp = $this->metaphoneObj->metaphone($word, $this->conf['sys_language_uid']);
1306 } else {
1307 $tmp = metaphone($word);
1308 }
1309
1310 // Return raw value?
1311 if ($retRaw) return $tmp;
1312
1313 // Otherwise create hash and return integer
1314 if($tmp=='') $ret=0; else $ret=hexdec(substr(md5($tmp),0,7));
1315 return $ret;
1316 }
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333 /********************************
1334 *
1335 * SQL; TYPO3 Pages
1336 *
1337 *******************************/
1338
1339 /**
1340 * Updates db with information about the page (TYPO3 page, not external media)
1341 *
1342 * @return void
1343 */
1344 function submitPage() {
1345
1346 // Remove any current data for this phash:
1347 $this->removeOldIndexedPages($this->hash['phash']);
1348
1349 // setting new phash_row
1350 $fields = array(
1351 'phash' => $this->hash['phash'],
1352 'phash_grouping' => $this->hash['phash_grouping'],
1353 'cHashParams' => serialize($this->cHashParams),
1354 'contentHash' => $this->content_md5h,
1355 'data_page_id' => $this->conf['id'],
1356 'data_page_reg1' => $this->conf['page_cache_reg1'],
1357 'data_page_type' => $this->conf['type'],
1358 'data_page_mp' => $this->conf['MP'],
1359 'gr_list' => $this->conf['gr_list'],
1360 'item_type' => 0, // TYPO3 page
1361 'item_title' => $this->contentParts['title'],
1362 'item_description' => $this->bodyDescription($this->contentParts),
1363 'item_mtime' => $this->conf['mtime'],
1364 'item_size' => strlen($this->conf['content']),
1365 'tstamp' => $GLOBALS['EXEC_TIME'],
1366 'crdate' => $GLOBALS['EXEC_TIME'],
1367 'item_crdate' => $this->conf['crdate'], // Creation date of page
1368 'sys_language_uid' => $this->conf['sys_language_uid'], // Sys language uid of the page. Should reflect which language it DOES actually display!
1369 'externalUrl' => 0,
1370 'recordUid' => intval($this->conf['recordUid']),
1371 'freeIndexUid' => intval($this->conf['freeIndexUid']),
1372 'freeIndexSetId' => intval($this->conf['freeIndexSetId']),
1373 );
1374
1375 $GLOBALS['TYPO3_DB']->exec_INSERTquery('index_phash', $fields);
1376
1377 // PROCESSING index_section
1378 $this->submit_section($this->hash['phash'],$this->hash['phash']);
1379
1380 // PROCESSING index_grlist
1381 $this->submit_grlist($this->hash['phash'],$this->hash['phash']);
1382
1383 // PROCESSING index_fulltext
1384 $fields = array(
1385 'phash' => $this->hash['phash'],
1386 'fulltextdata' => implode(' ', $this->contentParts)
1387 );
1388 if ($this->indexerConfig['fullTextDataLength']>0) {
1389 $fields['fulltextdata'] = substr($fields['fulltextdata'],0,$this->indexerConfig['fullTextDataLength']);
1390 }
1391 $GLOBALS['TYPO3_DB']->exec_INSERTquery('index_fulltext', $fields);
1392
1393 // PROCESSING index_debug
1394 if ($this->indexerConfig['debugMode']) {
1395 $fields = array(
1396 'phash' => $this->hash['phash'],
1397 'debuginfo' => serialize(array(
1398 'cHashParams' => $this->cHashParams,
1399 'external_parsers initialized' => array_keys($this->external_parsers),
1400 'conf' => array_merge($this->conf,array('content'=>substr($this->conf['content'],0,1000))),
1401 'contentParts' => array_merge($this->contentParts,array('body' => substr($this->contentParts['body'],0,1000))),
1402 'logs' => $this->internal_log,
1403 'lexer' => $this->lexerObj->debugString,
1404 ))
1405 );
1406 $GLOBALS['TYPO3_DB']->exec_INSERTquery('index_debug', $fields);
1407 }
1408 }
1409
1410 /**
1411 * Stores gr_list in the database.
1412 *
1413 * @param integer Search result record phash
1414 * @param integer Actual phash of current content
1415 * @return void
1416 * @see update_grlist()
1417 */
1418 function submit_grlist($hash,$phash_x) {
1419
1420 // Setting the gr_list record
1421 $fields = array(
1422 'phash' => $hash,
1423 'phash_x' => $phash_x,
1424 'hash_gr_list' => $this->md5inthash($this->conf['gr_list']),
1425 'gr_list' => $this->conf['gr_list']
1426 );
1427 $GLOBALS['TYPO3_DB']->exec_INSERTquery('index_grlist', $fields);
1428 }
1429
1430 /**
1431 * Stores section
1432 * $hash and $hash_t3 are the same for TYPO3 pages, but different when it is external files.
1433 *
1434 * @param integer phash of TYPO3 parent search result record
1435 * @param integer phash of the file indexation search record
1436 * @return void
1437 */
1438 function submit_section($hash,$hash_t3) {
1439 $fields = array(
1440 'phash' => $hash,
1441 'phash_t3' => $hash_t3,
1442 'page_id' => intval($this->conf['id'])
1443 );
1444
1445 $this->getRootLineFields($fields);
1446
1447 $GLOBALS['TYPO3_DB']->exec_INSERTquery('index_section', $fields);
1448 }
1449
1450 /**
1451 * Removes records for the indexed page, $phash
1452 *
1453 * @param integer phash value to flush
1454 * @return void
1455 */
1456 function removeOldIndexedPages($phash) {
1457 // Removing old registrations for all tables. Because the pages are TYPO3 pages there can be nothing else than 1-1 relations here.
1458 $tableArr = explode(',','index_phash,index_section,index_grlist,index_fulltext,index_debug');
1459 foreach($tableArr as $table) {
1460 $GLOBALS['TYPO3_DB']->exec_DELETEquery($table, 'phash='.intval($phash));
1461 }
1462 // Removing all index_section records with hash_t3 set to this hash (this includes such records set for external media on the page as well!). The re-insert of these records are done in indexRegularDocument($file).
1463 $GLOBALS['TYPO3_DB']->exec_DELETEquery('index_section', 'phash_t3='.intval($phash));
1464 }
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478 /********************************
1479 *
1480 * SQL; External media
1481 *
1482 *******************************/
1483
1484
1485 /**
1486 * Updates db with information about the file
1487 *
1488 * @param array Array with phash and phash_grouping keys for file
1489 * @param string File name
1490 * @param array Array of "cHashParams" for files: This is for instance the page index for a PDF file (other document types it will be a zero)
1491 * @param string File extension determining the type of media.
1492 * @param integer Modification time of file.
1493 * @param integer Creation time of file.
1494 * @param integer Size of file in bytes
1495 * @param integer Content HASH value.
1496 * @param array Standard content array (using only title and body for a file)
1497 * @return void
1498 */
1499 function submitFilePage($hash,$file,$subinfo,$ext,$mtime,$ctime,$size,$content_md5h,$contentParts) {
1500
1501 // Find item Type:
1502 $storeItemType = $this->external_parsers[$ext]->ext2itemtype_map[$ext];
1503 $storeItemType = $storeItemType ? $storeItemType : $ext;
1504
1505 // Remove any current data for this phash:
1506 $this->removeOldIndexedFiles($hash['phash']);
1507
1508 // Split filename:
1509 $fileParts = parse_url($file);
1510
1511 // Setting new
1512 $fields = array(
1513 'phash' => $hash['phash'],
1514 'phash_grouping' => $hash['phash_grouping'],
1515 'cHashParams' => serialize($subinfo),
1516 'contentHash' => $content_md5h,
1517 'data_filename' => $file,
1518 'item_type' => $storeItemType,
1519 'item_title' => trim($contentParts['title']) ? $contentParts['title'] : basename($file),
1520 'item_description' => $this->bodyDescription($contentParts),
1521 'item_mtime' => $mtime,
1522 'item_size' => $size,
1523 'item_crdate' => $ctime,
1524 'tstamp' => $GLOBALS['EXEC_TIME'],
1525 'crdate' => $GLOBALS['EXEC_TIME'],
1526 'gr_list' => $this->conf['gr_list'],
1527 'externalUrl' => $fileParts['scheme'] ? 1 : 0,
1528 'recordUid' => intval($this->conf['recordUid']),
1529 'freeIndexUid' => intval($this->conf['freeIndexUid']),
1530 'freeIndexSetId' => intval($this->conf['freeIndexSetId']),
1531 );
1532 $GLOBALS['TYPO3_DB']->exec_INSERTquery('index_phash', $fields);
1533
1534 // PROCESSING index_fulltext
1535 $fields = array(
1536 'phash' => $hash['phash'],
1537 'fulltextdata' => implode(' ', $contentParts)
1538 );
1539 if ($this->indexerConfig['fullTextDataLength']>0) {
1540 $fields['fulltextdata'] = substr($fields['fulltextdata'],0,$this->indexerConfig['fullTextDataLength']);
1541 }
1542 $GLOBALS['TYPO3_DB']->exec_INSERTquery('index_fulltext', $fields);
1543
1544 // PROCESSING index_debug
1545 if ($this->indexerConfig['debugMode']) {
1546 $fields = array(
1547 'phash' => $hash['phash'],
1548 'debuginfo' => serialize(array(
1549 'cHashParams' => $subinfo,
1550 'contentParts' => array_merge($contentParts,array('body' => substr($contentParts['body'],0,1000))),
1551 'logs' => $this->internal_log,
1552 'lexer' => $this->lexerObj->debugString,
1553 ))
1554 );
1555 $GLOBALS['TYPO3_DB']->exec_INSERTquery('index_debug', $fields);
1556 }
1557 }
1558
1559 /**
1560 * Stores file gr_list for a file IF it does not exist already
1561 *
1562 * @param integer phash value of file
1563 * @return void
1564 */
1565 function submitFile_grlist($hash) {
1566 // Testing if there is a gr_list record for a non-logged in user and if so, there is no need to place another one.
1567 $count = $GLOBALS['TYPO3_DB']->exec_SELECTcountRows(
1568 'phash',
1569 'index_grlist',
1570 'phash=' . intval($hash) .
1571 ' AND (hash_gr_list=' . $this->md5inthash($this->defaultGrList) .
1572 ' OR hash_gr_list=' . $this->md5inthash($this->conf['gr_list']) . ')'
1573 );
1574 if (!$count) {
1575 $this->submit_grlist($hash,$hash);
1576 }
1577 }
1578
1579 /**
1580 * Stores file section for a file IF it does not exist
1581 *
1582 * @param integer phash value of file
1583 * @return void
1584 */
1585 function submitFile_section($hash) {
1586 // Testing if there is a section
1587 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('phash', 'index_section', 'phash='.intval($hash).' AND page_id='.intval($this->conf['id']));
1588 if (!$GLOBALS['TYPO3_DB']->sql_num_rows($res)) {
1589 $this->submit_section($hash,$this->hash['phash']);
1590 }
1591 }
1592
1593 /**
1594 * Removes records for the indexed page, $phash
1595 *
1596 * @param integer phash value to flush
1597 * @return void
1598 */
1599 function removeOldIndexedFiles($phash) {
1600
1601 // Removing old registrations for tables.
1602 $tableArr = explode(',','index_phash,index_grlist,index_fulltext,index_debug');
1603 foreach($tableArr as $table) {
1604 $GLOBALS['TYPO3_DB']->exec_DELETEquery($table, 'phash='.intval($phash));
1605 }
1606 }
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621 /********************************
1622 *
1623 * SQL Helper functions
1624 *
1625 *******************************/
1626
1627 /**
1628 * Check the mtime / tstamp of the currently indexed page/file (based on phash)
1629 * Return positive integer if the page needs to be indexed
1630 *
1631 * @param integer mtime value to test against limits and indexed page (usually this is the mtime of the cached document)
1632 * @param integer "phash" used to select any already indexed page to see what its mtime is.
1633 * @return integer Result integer: Generally: <0 = No indexing, >0 = Do indexing (see $this->reasons): -2) Min age was NOT exceeded and so indexing cannot occur. -1) mtime matched so no need to reindex page. 0) N/A 1) Max age exceeded, page must be indexed again. 2) mtime of indexed page doesn't match mtime given for current content and we must index page. 3) No mtime was set, so we will index... 4) No indexed page found, so of course we will index.
1634 */
1635 function checkMtimeTstamp($mtime,$phash) {
1636
1637 // Select indexed page:
1638 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('item_mtime,tstamp', 'index_phash', 'phash='.intval($phash));
1639 $out = 0;
1640
1641 // If there was an indexing of the page...:
1642 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1643 if ($this->tstamp_maxAge && ($row['tstamp'] + $this->tstamp_maxAge) < $GLOBALS['EXEC_TIME']) { // If max age is exceeded, index the page
1644 $out = 1; // The configured max-age was exceeded for the document and thus it's indexed.
1645 } else {
1646 if (!$this->tstamp_minAge || ($row['tstamp'] + $this->tstamp_minAge) < $GLOBALS['EXEC_TIME']) { // if minAge is not set or if minAge is exceeded, consider at mtime
1647 if ($mtime) { // It mtime is set, then it's tested. If not, the page must clearly be indexed.
1648 if ($row['item_mtime'] != $mtime) { // And if mtime is different from the index_phash mtime, it's about time to re-index.
1649 $out = 2; // The minimum age was exceed and mtime was set and the mtime was different, so the page was indexed.
1650 } else {
1651 $out = -1; // mtime matched the document, so no changes detected and no content updated
1652 if ($this->tstamp_maxAge) {
1653 $this->log_setTSlogMessage('mtime matched, timestamp NOT updated because a maxAge is set (' . ($row['tstamp'] + $this->tstamp_maxAge - $GLOBALS['EXEC_TIME']) . ' seconds to expire time).', 1);
1654 } else {
1655 $this->updateTstamp($phash); // Update the timestatmp
1656 $this->log_setTSlogMessage('mtime matched, timestamp updated.',1);
1657 }
1658 }
1659 } else {$out = 3; } // The minimum age was exceed, but mtime was not set, so the page was indexed.
1660 } else {$out = -2;} // The minimum age was not exceeded
1661 }
1662 } else {$out = 4;} // Page has never been indexed (is not represented in the index_phash table).
1663 return $out;
1664 }
1665
1666 /**
1667 * Check content hash in phash table
1668 *
1669 * @return mixed Returns true if the page needs to be indexed (that is, there was no result), otherwise the phash value (in an array) of the phash record to which the grlist_record should be related!
1670 */
1671 function checkContentHash() {
1672 // With this query the page will only be indexed if it's content is different from the same "phash_grouping" -page.
1673 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('phash', 'index_phash A', 'A.phash_grouping='.intval($this->hash['phash_grouping']).' AND A.contentHash='.intval($this->content_md5h));
1674 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1675 return $row;
1676 }
1677 return 1;
1678 }
1679
1680 /**
1681 * Check content hash for external documents
1682 * Returns true if the document needs to be indexed (that is, there was no result)
1683 *
1684 * @param integer phash value to check (phash_grouping)
1685 * @param integer Content hash to check
1686 * @return boolean Returns true if the document needs to be indexed (that is, there was no result)
1687 */
1688 function checkExternalDocContentHash($hashGr,$content_md5h) {
1689 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'index_phash A', 'A.phash_grouping='.intval($hashGr).' AND A.contentHash='.intval($content_md5h));
1690 if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1691 return 0;
1692 }
1693 return 1;
1694 }
1695
1696 /**
1697 * Checks if a grlist record has been set for the phash value input (looking at the "real" phash of the current content, not the linked-to phash of the common search result page)
1698 *
1699 * @param integer Phash integer to test.
1700 * @return void
1701 */
1702 function is_grlist_set($phash_x) {
1703 return $GLOBALS['TYPO3_DB']->exec_SELECTcountRows(
1704 'phash_x',
1705 'index_grlist',
1706 'phash_x=' . intval($phash_x)
1707 );
1708 }
1709
1710 /**
1711 * Check if an grlist-entry for this hash exists and if not so, write one.
1712 *
1713 * @param integer phash of the search result that should be found
1714 * @param integer The real phash of the current content. The two values are different when a page with userlogin turns out to contain the exact same content as another already indexed version of the page; This is the whole reason for the grlist table in fact...
1715 * @return void
1716 * @see submit_grlist()
1717 */
1718 function update_grlist($phash,$phash_x) {
1719 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('phash', 'index_grlist', 'phash='.intval($phash).' AND hash_gr_list='.$this->md5inthash($this->conf['gr_list']));
1720 if (!$GLOBALS['TYPO3_DB']->sql_num_rows($res)) {
1721 $this->submit_grlist($phash,$phash_x);
1722 $this->log_setTSlogMessage("Inserted gr_list '".$this->conf['gr_list']."' for phash '".$phash."'",1);
1723 }
1724 }
1725
1726 /**
1727 * Update tstamp for a phash row.
1728 *
1729 * @param integer phash value
1730 * @param integer If set, update the mtime field to this value.
1731 * @return void
1732 */
1733 function updateTstamp($phash,$mtime=0) {
1734 $updateFields = array(
1735 'tstamp' => $GLOBALS['EXEC_TIME']
1736 );
1737 if ($mtime) { $updateFields['item_mtime'] = intval($mtime); }
1738
1739 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('index_phash', 'phash='.intval($phash), $updateFields);
1740 }
1741
1742 /**
1743 * Update SetID of the index_phash record.
1744 *
1745 * @param integer phash value
1746 * @return void
1747 */
1748 function updateSetId($phash) {
1749 $updateFields = array(
1750 'freeIndexSetId' => intval($this->conf['freeIndexSetId'])
1751 );
1752
1753 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('index_phash', 'phash='.intval($phash), $updateFields);
1754 }
1755
1756 /**
1757 * Update parsetime for phash row.
1758 *
1759 * @param integer phash value.
1760 * @param integer Parsetime value to set.
1761 * @return void
1762 */
1763 function updateParsetime($phash,$parsetime) {
1764 $updateFields = array(
1765 'parsetime' => intval($parsetime)
1766 );
1767
1768 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('index_phash', 'phash='.intval($phash), $updateFields);
1769 }
1770
1771 /**
1772 * Update section rootline for the page
1773 *
1774 * @return void
1775 */
1776 function updateRootline() {
1777
1778 $updateFields = array();
1779 $this->getRootLineFields($updateFields);
1780
1781 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('index_section', 'page_id='.intval($this->conf['id']), $updateFields);
1782 }
1783
1784 /**
1785 * Adding values for root-line fields.
1786 * rl0, rl1 and rl2 are standard. A hook might add more.
1787 *
1788 * @param array Field array, passed by reference
1789 * @return void
1790 */
1791 function getRootLineFields(&$fieldArr) {
1792
1793 $fieldArr['rl0'] = intval($this->conf['rootline_uids'][0]);
1794 $fieldArr['rl1'] = intval($this->conf['rootline_uids'][1]);
1795 $fieldArr['rl2'] = intval($this->conf['rootline_uids'][2]);
1796
1797 if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['indexed_search']['addRootLineFields'])) {
1798 foreach($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['indexed_search']['addRootLineFields'] as $fieldName => $rootLineLevel) {
1799 $fieldArr[$fieldName] = intval($this->conf['rootline_uids'][$rootLineLevel]);
1800 }
1801 }
1802 }
1803
1804 /**
1805 * Removes any indexed pages with userlogins which has the same contentHash
1806 * NOT USED anywhere inside this class!
1807 *
1808 * @return void
1809 */
1810 function removeLoginpagesWithContentHash() {
1811 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'index_phash A,index_grlist B', '
1812 A.phash=B.phash
1813 AND A.phash_grouping='.intval($this->hash['phash_grouping']).'
1814 AND B.hash_gr_list!='.$this->md5inthash($this->defaultGrList).'
1815 AND A.contentHash='.intval($this->content_md5h));
1816 while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1817 $this->log_setTSlogMessage("The currently indexed page was indexed under no user-login and apparently this page has been indexed under login conditions earlier, but with the SAME content. Therefore the old similar page with phash='".$row['phash']."' are now removed.",1);
1818 $this->removeOldIndexedPages($row['phash']);
1819 }
1820 }
1821
1822 /**
1823 * Includes the crawler class
1824 *
1825 * @return void
1826 */
1827 function includeCrawlerClass() {
1828 global $TYPO3_CONF_VARS;
1829
1830 require_once(t3lib_extMgm::extPath('crawler').'class.tx_crawler_lib.php');
1831 }
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842 /********************************
1843 *
1844 * SQL; Submitting words
1845 *
1846 *******************************/
1847
1848 /**
1849 * Adds new words to db
1850 *
1851 * @param array Word List array (where each word has information about position etc).
1852 * @return void
1853 */
1854 function checkWordList($wl) {
1855 reset($wl);
1856 $phashArr = array();
1857 while(list($key,) = each($wl)) {
1858 $phashArr[] = $wl[$key]['hash'];
1859 }
1860 if (count($phashArr)) {
1861 $cwl = implode(',',$phashArr);
1862 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('baseword', 'index_words', 'wid IN ('.$cwl.')');
1863
1864 if($GLOBALS['TYPO3_DB']->sql_num_rows($res)!=count($wl)) {
1865 $this->log_setTSlogMessage('Inserting words: '.(count($wl)-$GLOBALS['TYPO3_DB']->sql_num_rows($res)),1);
1866 while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
1867 unset($wl[$row['baseword']]);
1868 }
1869
1870 reset($wl);
1871 while(list($key,$val)=each($wl)) {
1872 $insertFields = array(
1873 'wid' => $val['hash'],
1874 'baseword' => $key,
1875 'metaphone' => $val['metaphone']
1876 );
1877 // A duplicate-key error will occur here if a word is NOT unset in the unset() line. However as long as the words in $wl are NOT longer as 60 chars (the baseword varchar is 60 characters...) this is not a problem.
1878 $GLOBALS['TYPO3_DB']->exec_INSERTquery('index_words', $insertFields);
1879 }
1880 }
1881 }
1882 }
1883
1884 /**
1885 * Submits RELATIONS between words and phash
1886 *
1887 * @param array Word list array
1888 * @param integer phash value
1889 * @return void
1890 */
1891 function submitWords($wl,$phash) {
1892 $GLOBALS['TYPO3_DB']->exec_DELETEquery('index_rel', 'phash='.intval($phash));
1893
1894 foreach($wl as $val) {
1895 $insertFields = array(
1896 'phash' => $phash,
1897 'wid' => $val['hash'],
1898 'count' => $val['count'],
1899 'first' => $val['first'],
1900 'freq' => $this->freqMap(($val['count']/$this->wordcount)),
1901 'flags' => ($val['cmp'] & $this->flagBitMask)
1902 );
1903
1904 $GLOBALS['TYPO3_DB']->exec_INSERTquery('index_rel', $insertFields);
1905 }
1906 }
1907
1908 /**
1909 * maps frequency from a real number in [0;1] to an integer in [0;$this->freqRange] with anything above $this->freqMax as 1
1910 * and back.
1911 *
1912 * @param double Frequency
1913 * @return integer Frequency in range.
1914 */
1915 function freqMap($freq) {
1916 $mapFactor = $this->freqMax*100*$this->freqRange;
1917 if($freq<1) {
1918 $newFreq = $freq*$mapFactor;
1919 $newFreq = $newFreq>$this->freqRange?$this->freqRange:$newFreq;
1920 } else {
1921 $newFreq = $freq/$mapFactor;
1922 }
1923 return $newFreq;
1924
1925 }
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937 /********************************
1938 *
1939 * Hashing
1940 *
1941 *******************************/
1942
1943 /**
1944 * Get search hash, T3 pages
1945 *
1946 * @return void
1947 */
1948 function setT3Hashes() {
1949
1950 // Set main array:
1951 $hArray = array(
1952 'id' => (integer)$this->conf['id'],
1953 'type' => (integer)$this->conf['type'],
1954 'sys_lang' => (integer)$this->conf['sys_language_uid'],
1955 'MP' => (string)$this->conf['MP'],
1956 'cHash' => $this->cHashParams
1957 );
1958
1959 // Set grouping hash (Identifies a "page" combined of id, type, language, mountpoint and cHash parameters):
1960 $this->hash['phash_grouping'] = $this->md5inthash(serialize($hArray));
1961
1962 // Add gr_list and set plain phash (Subdivision where special page composition based on login is taken into account as well. It is expected that such pages are normally similar regardless of the login.)
1963 $hArray['gr_list'] = (string)$this->conf['gr_list'];
1964 $this->hash['phash'] = $this->md5inthash(serialize($hArray));
1965 }
1966
1967 /**
1968 * Get search hash, external files
1969 *
1970 * @param string File name / path which identifies it on the server
1971 * @param array Additional content identifying the (subpart of) content. For instance; PDF files are divided into groups of pages for indexing.
1972 * @return array Array with "phash_grouping" and "phash" inside.
1973 */
1974 function setExtHashes($file,$subinfo=array()) {
1975 // Set main array:
1976 $hash = array();
1977 $hArray = array(
1978 'file' => $file,
1979 );
1980
1981 // Set grouping hash:
1982 $hash['phash_grouping'] = $this->md5inthash(serialize($hArray));
1983
1984 // Add subinfo
1985 $hArray['subinfo'] = $subinfo;
1986 $hash['phash'] = $this->md5inthash(serialize($hArray));
1987
1988 return $hash;
1989 }
1990
1991 /**
1992 * md5 integer hash
1993 * Using 7 instead of 8 just because that makes the integers lower than 32 bit (28 bit) and so they do not interfere with UNSIGNED integers or PHP-versions which has varying output from the hexdec function.
1994 *
1995 * @param string String to hash
1996 * @return integer Integer intepretation of the md5 hash of input string.
1997 */
1998 function md5inthash($str) {
1999 return hexdec(substr(md5($str),0,7));
2000 }
2001
2002 /**
2003 * Calculates the cHash value of input GET array (for constructing cHash values if needed)
2004 *
2005 * @param array Array of GET parameters to encode
2006 * @return void
2007 * @deprecated since TYPO3 4.3, this function will be removed in TYPO3 4.5, use directly t3lib_div::calculateCHash()
2008 */
2009 function makeCHash($paramArray) {
2010 t3lib_div::logDeprecatedFunction();
2011
2012 $addQueryParams = t3lib_div::implodeArrayForUrl('', $paramArray);
2013
2014 $pA = t3lib_div::cHashParams($addQueryParams);
2015
2016 return t3lib_div::shortMD5(serialize($pA));
2017 }
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030 /*********************************
2031 *
2032 * Internal logging functions
2033 *
2034 *********************************/
2035
2036 /**
2037 * Push function wrapper for TT logging
2038 *
2039 * @param string Title to set
2040 * @param string Key (?)
2041 * @return void
2042 */
2043 function log_push($msg,$key) {
2044 if (is_object($GLOBALS['TT'])) $GLOBALS['TT']->push($msg,$key);
2045 }
2046
2047 /**
2048 * Pull function wrapper for TT logging
2049 *
2050 * @return void
2051 */
2052 function log_pull() {
2053 if (is_object($GLOBALS['TT'])) $GLOBALS['TT']->pull();
2054 }
2055
2056 /**
2057 * Set log message function wrapper for TT logging
2058 *
2059 * @param string Message to set
2060 * @param integer Error number
2061 * @return void
2062 */
2063 function log_setTSlogMessage($msg, $errorNum=0) {
2064 if (is_object($GLOBALS['TT'])) $GLOBALS['TT']->setTSlogMessage($msg,$errorNum);
2065 $this->internal_log[] = $msg;
2066 }
2067
2068
2069
2070
2071
2072
2073
2074
2075 /**************************
2076 *
2077 * tslib_fe hooks:
2078 *
2079 **************************/
2080
2081 /**
2082 * Frontend hook: If the page is not being re-generated this is our chance to force it to be (because re-generation of the page is required in order to have the indexer called!)
2083 *
2084 * @param array Parameters from frontend
2085 * @param object TSFE object (reference under PHP5)
2086 * @return void
2087 * @deprecated since TYPO3 4.3, this function will be removed in TYPO3 4.5, the method was extracted to hooks/class.tx_indexedsearch_tslib_fe_hook.php
2088 */
2089 function fe_headerNoCache(&$params, $ref) {
2090 t3lib_div::logDeprecatedFunction();
2091
2092 require_once t3lib_extMgm::extPath('indexed_search') . 'hooks/class.tx_indexedsearch_tslib_fe_hook.php';
2093 t3lib_div::makeInstance('tx_indexedsearch_tslib_fe_hook')->headerNoCache($params, $ref);
2094 }
2095
2096 /**
2097 * Makes sure that keywords are space-separated. This is impotant for their
2098 * proper displaying as a part of fulltext index.
2099 *
2100 * @param string $keywordList
2101 * @return string
2102 * @see http://bugs.typo3.org/view.php?id=1436
2103 */
2104 protected function addSpacesToKeywordList($keywordList) {
2105 $keywords = t3lib_div::trimExplode(',', $keywordList);
2106 return ' ' . implode(', ', $keywords) . ' ';
2107 }
2108 }
2109
2110
2111 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/indexed_search/class.indexer.php']) {
2112 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/indexed_search/class.indexer.php']);
2113 }
2114 ?>