Project

General

Profile

1
<?php
2

    
3
// $Id: search_modext.php 869 2008-10-29 19:05:42Z thorn $
4

    
5
/*
6

    
7
 Website Baker Project <http://www.websitebaker.org/>
8
 Copyright (C) 2004-2008, Ryan Djurovich
9

    
10
 Website Baker is free software; you can redistribute it and/or modify
11
 it under the terms of the GNU General Public License as published by
12
 the Free Software Foundation; either version 2 of the License, or
13
 (at your option) any later version.
14

    
15
 Website Baker is distributed in the hope that it will be useful,
16
 but WITHOUT ANY WARRANTY; without even the implied warranty of
17
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
 GNU General Public License for more details.
19

    
20
 You should have received a copy of the GNU General Public License
21
 along with Website Baker; if not, write to the Free Software
22
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23

    
24
*/
25

    
26
// make the url-string for highlighting
27
function make_url_searchstring($search_match, $search_url_array) {
28
	$link = "";
29
	if ($search_match != 'exact') {
30
		$str = implode(" ", $search_url_array);
31
		$link = "?searchresult=1&amp;sstring=".urlencode($str);
32
	} else {
33
		$str = str_replace(' ', '_', $search_url_array[0]);
34
		$link = "?searchresult=2&amp;sstring=".urlencode($str);
35
	}
36
	return $link;
37
}
38

    
39
// make date and time for "last modified by... on ..."-string
40
function get_page_modified($page_modified_when) {
41
	global $TEXT;
42
	if($page_modified_when > 0) {
43
		$date = gmdate(DATE_FORMAT, $page_modified_when+TIMEZONE);
44
		$time = gmdate(TIME_FORMAT, $page_modified_when+TIMEZONE);
45
	} else {
46
		$date = $TEXT['UNKNOWN'].' '.$TEXT['DATE'];
47
		$time = $TEXT['UNKNOWN'].' '.$TEXT['TIME'];
48
	}
49
	return array($date, $time);
50
}
51

    
52
// make username and displayname for "last modified by... on ..."-string
53
function get_page_modified_by($page_modified_by, $users) {
54
	global $TEXT;
55
	if($page_modified_by > 0) {
56
			$username = $users[$page_modified_by]['username'];
57
			$displayname = $users[$page_modified_by]['display_name'];
58
		} else {
59
			$username = "";
60
			$displayname = $TEXT['UNKNOWN'];
61
		}
62
	return array($username, $displayname);
63
}
64

    
65
// checks if _all_ searchwords matches
66
function is_all_matched($text, $search_words) {
67
	$all_matched = true;
68
	foreach ($search_words AS $word) {
69
		if(!preg_match('/'.$word.'/i', $text)) {
70
			$all_matched = false;
71
			break;
72
		}
73
	}
74
	return $all_matched;
75
}
76

    
77
// checks if _any_ of the searchwords matches
78
function is_any_matched($text, $search_words) {
79
	$any_matched = false;
80
	$word = '('.implode('|', $search_words).')';
81
	if(preg_match('/'.$word.'/i', $text)) {
82
		$any_matched = true;
83
	}
84
	return $any_matched;
85
}
86

    
87
// collects the matches from text in excerpt_array
88
function get_excerpts($text, $search_words, $max_excerpt_num) {
89
	$match_array = array();
90
	$excerpt_array = array();
91
	$word = '('.implode('|', $search_words).')';
92
	// Build the regex-string
93
	if(strpos(strtoupper(PHP_OS), 'WIN')===0) { // windows -> see below
94
		$str1=".!?;";
95
		$str2=".!?;";
96
	} else { // linux & Co.
97
		// start-sign: .!?; + INVERTED EXCLAMATION MARK - INVERTED QUESTION MARK - DOUBLE EXCLAMATION MARK - INTERROBANG - EXCLAMATION QUESTION MARK - QUESTION EXCLAMATION MARK - DOUBLE QUESTION MARK - HALFWIDTH IDEOGRAPHIC FULL STOP - IDEOGRAPHIC FULL STOP - IDEOGRAPHIC COMMA
98
		$str1=".!?;"."\xC2\xA1"."\xC2\xBF"."\xE2\x80\xBC"."\xE2\x80\xBD"."\xE2\x81\x89"."\xE2\x81\x88"."\xE2\x81\x87"."\xEF\xBD\xA1"."\xE3\x80\x82"."\xE3\x80\x81";
99
		// stop-sign: .!?; + DOUBLE EXCLAMATION MARK - INTERROBANG - EXCLAMATION QUESTION MARK - QUESTION EXCLAMATION MARK - DOUBLE QUESTION MARK - HALFWIDTH IDEOGRAPHIC FULL STOP - IDEOGRAPHIC FULL STOP - IDEOGRAPHIC COMMA
100
		$str2=".!?;"."\xE2\x80\xBC"."\xE2\x80\xBD"."\xE2\x81\x89"."\xE2\x81\x88"."\xE2\x81\x87"."\xEF\xBD\xA1"."\xE3\x80\x82"."\xE3\x80\x81";
101
	}
102
	$regex='/(?:^|\b|['.$str1.'])([^'.$str1.']{0,200}?'.$word.'[^'.$str2.']{0,200}(?:['.$str2.']|\b|$))/isu';
103
	if(version_compare(PHP_VERSION, '4.3.3', '>=') &&
104
	   strpos(strtoupper(PHP_OS), 'WIN')!==0
105
	) { // this may crash windows server, so skip if on windows
106
		// jump from match to match, get excerpt, stop if $max_excerpt_num is reached
107
		$last_end = 0; $offset = 0;
108
		while(preg_match('/'.$word.'/Sisu', $text, $match_array, PREG_OFFSET_CAPTURE, $last_end)) {
109
			$offset = ($match_array[0][1]-206 < $last_end)?$last_end:$match_array[0][1]-206;
110
			if(preg_match($regex, $text, $matches, PREG_OFFSET_CAPTURE, $offset)) {
111
				$last_end = $matches[1][1]+strlen($matches[1][0])-1;
112
				if(!preg_match('/\b[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\./', $matches[1][0])) // skip excerpts with email-addresses
113
					$excerpt_array[] = trim($matches[1][0]);
114
				if(count($excerpt_array)>=$max_excerpt_num) {
115
					$excerpt_array = array_unique($excerpt_array);
116
					if(count($excerpt_array) >= $max_excerpt_num)
117
						break;
118
				}
119
			} else { // problem: preg_match failed - can't find a start- or stop-sign
120
				$last_end += 201; // jump forward and try again
121
			}
122
		}
123
	} else { // compatible, but may be very slow with large pages
124
		if(preg_match_all($regex, $text, $match_array)) {
125
			foreach($match_array[1] AS $string) {
126
				if(!preg_match('/\b[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\./', $string)) // skip excerpts with email-addresses
127
					$excerpt_array[] = trim($string);
128
			}
129
		}
130
	}
131
	return $excerpt_array;
132
}
133

    
134
// makes excerpt_array a string ready to print out
135
function prepare_excerpts($excerpt_array, $search_words, $max_excerpt_num) {
136
	// excerpts: text before and after a single excerpt, html-tag for markup
137
	$EXCERPT_BEFORE =       '...&nbsp;';
138
	$EXCERPT_AFTER =        '&nbsp;...<br />';
139
	$EXCERPT_MARKUP_START = '<b>';
140
	$EXCERPT_MARKUP_END =   '</b>';
141
	// remove duplicate matches from $excerpt_array, if any.
142
	$excerpt_array = array_unique($excerpt_array);
143
	// use the first $max_excerpt_num excerpts only
144
	if(count($excerpt_array) > $max_excerpt_num) {
145
		$excerpt_array = array_slice($excerpt_array, 0, $max_excerpt_num);
146
	}
147
	// prepare search-string
148
	$string = "(".implode("|", $search_words).")";
149
	// we want markup on search-results page,
150
	// but we need some 'magic' to prevent <br />, <b>... from being highlighted
151
	$excerpt = '';
152
	foreach($excerpt_array as $str) {
153
		$excerpt .= '#,,#'.preg_replace("/($string)/iu","#,,,,#$1#,,,,,#",$str).'#,,,#';
154
	}
155
	$excerpt = str_replace(array('&','<','>','"','\'',"\xC2\xA0"), array('&amp;','&lt;','&gt;','&quot;','&#39;','&nbsp;'), $excerpt);
156
	$excerpt = str_replace(array('#,,,,#','#,,,,,#'), array($EXCERPT_MARKUP_START,$EXCERPT_MARKUP_END), $excerpt);
157
	$excerpt = str_replace(array('#,,#','#,,,#'), array($EXCERPT_BEFORE,$EXCERPT_AFTER), $excerpt);
158
	// prepare to write out
159
	if(DEFAULT_CHARSET != 'utf-8') {
160
		$excerpt = umlauts_to_entities($excerpt, 'UTF-8');
161
	}
162
	return $excerpt;
163
}
164

    
165
// work out what the link-anchor should be
166
function make_url_target($page_link_target, $text, $search_words) {
167
	// 1. e.g. $page_link_target=="&monthno=5&year=2007" - module-dependent target. Do nothing.
168
	// 2. $page_link_target=="#!wb_section_..." - the user wants the section-target, so do nothing.
169
	// 3. $page_link_target=="#wb_section_..." - try to find a better target, use the section-target as fallback.
170
	// 4. $page_link_target=="" - do nothing
171
	if(version_compare(PHP_VERSION, '4.3.3', ">=") && substr($page_link_target,0,12)=='#wb_section_') {
172
		$word = '('.implode('|', $search_words).')';
173
		preg_match('/'.$word.'/i', $text, $match, PREG_OFFSET_CAPTURE);
174
		if($match && is_array($match[0])) {
175
			$x=$match[0][1]; // position of first match
176
			// is there an anchor nearby?
177
			if(preg_match_all('/<(?:[^>]+id|\s*a[^>]+name)\s*=\s*"(.*)"/iU', substr($text,0,$x), $match, PREG_OFFSET_CAPTURE)) {
178
				$anchor='';
179
				foreach($match[1] AS $array) {
180
					if($array[1] > $x) {
181
						break;
182
					}
183
					$anchor = $array[0];
184
				}
185
				if($anchor != '') {
186
					$page_link_target = '#'.$anchor;
187
				}
188
			}
189
		}
190
	}
191
	elseif(substr($page_link_target,0,13)=='#!wb_section_') {
192
		$page_link_target = '#'.substr($page_link_target, 2);
193
	}
194
	return $page_link_target;
195
}
196

    
197
// wrapper for compatibility with old print_excerpt()
198
function print_excerpt($page_link, $page_link_target, $page_title, $page_description, $page_modified_when, $page_modified_by, $text, $max_excerpt_num, $func_vars, $pic_link="") {
199
	$mod_vars = array(
200
		'page_link' => $page_link,
201
		'page_link_target' => $page_link_target,
202
		'page_title' => $page_title,
203
		'page_description' => $page_description,
204
		'page_modified_when' => $page_modified_when,
205
		'page_modified_by' => $page_modified_by,
206
		'text' => $text,
207
		'max_excerpt_num' => $max_excerpt_num,
208
		'pic_link' => $pic_link
209
	);
210
	print_excerpt2($mod_vars, $func_vars);
211
}
212

    
213
/* These functions can be used in module-supplied search_funcs
214
 * -----------------------------------------------------------
215
 * print_excerpt2() - the main-function to use in all search_funcs
216
 * print_excerpt() - wrapper for compatibility-reason. Use print_excerpt2() instead.
217
 * list_files_dirs() - lists all files and dirs below a given directory
218
 * clear_filelist() - keeps only wanted or removes unwanted entries in file-list.
219
 */
220
 
221
// prints the excerpts for one section
222
function print_excerpt2($mod_vars, $func_vars) {
223
	extract($func_vars, EXTR_PREFIX_ALL, 'func');
224
	extract($mod_vars, EXTR_PREFIX_ALL, 'mod');
225
	global $TEXT;
226
	// check $mod_...vars
227
	if(!isset($mod_page_link))          $mod_page_link = $func_page_link;
228
	if(!isset($mod_page_link_target))   $mod_page_link_target = "";
229
	if(!isset($mod_page_title))         $mod_page_title = $func_page_title;
230
	if(!isset($mod_page_description))   $mod_page_description = $func_page_description;
231
	if(!isset($mod_page_modified_when)) $mod_page_modified_when = $func_page_modified_when;
232
	if(!isset($mod_page_modified_by))   $mod_page_modified_by = $func_page_modified_by;
233
	if(!isset($mod_text))               $mod_text = "";
234
	if(!isset($mod_max_excerpt_num))    $mod_max_excerpt_num = $func_default_max_excerpt;
235
	if(!isset($mod_pic_link))           $mod_pic_link = "";
236
	if(!isset($mod_no_highlight))       $mod_no_highlight = false;
237
	if(!isset($func_enable_flush))      $func_enable_flush = false; // set this in db: wb_search.cfg_enable_flush [READ THE DOC BEFORE]
238
	if(isset($mod_ext_charset) && $mod_ext_charset!='utf-8') $mod_ext_charset = 'utf-8'; // only utf-8 is allowed, yet. For other charset see DOCU
239
	if($mod_text == "") // nothing to do
240
		{ return false; }
241
	if($mod_no_highlight) // no highlighting
242
		{ $mod_page_link_target = "&amp;nohighlight=1".$mod_page_link_target; }
243
	// clean the text:
244
	$mod_text = preg_replace('#<(!--.*--|style.*</style|script.*</script)>#SiU', ' ', $mod_text);
245
	$mod_text = preg_replace('#<(br( /)?|dt|/dd|/?(h[1-6]|tr|table|p|li|ul|pre|code|div|hr))[^>]*>#Si', '.', $mod_text);
246
	$mod_text = preg_replace('/\s+/', ' ', $mod_text);
247
	$mod_text = preg_replace('/ \./', '.', $mod_text);
248
	if(isset($mod_ext_charset)) { // data from external database may have a different charset
249
		require_once(WB_PATH.'/framework/functions-utf8.php');
250
		$mod_text = charset_to_utf8($mod_text, $mod_ext_charset);
251
	} else {
252
	$mod_text = entities_to_umlauts($mod_text, 'UTF-8');
253
	}
254
	$anchor_text = $mod_text; // make an copy containing html-tags
255
	$mod_text = strip_tags($mod_text);
256
	$mod_text = str_replace(array('&gt;','&lt;','&amp;','&quot;','&#39;','&apos;','&nbsp;'), array('>','<','&','"','\'','\'',"\xC2\xA0"), $mod_text);
257
	$mod_text = '.'.trim($mod_text).'.';
258
	// Do a fast scan over $mod_text first. This will speedup things a lot.
259
	if($func_search_match == 'all') {
260
		if(!is_all_matched($mod_text, $func_search_words))
261
			return false;
262
	}
263
	elseif(!is_any_matched($mod_text, $func_search_words)) {
264
		return false;
265
	}
266
	// search for an better anchor - this have to be done before strip_tags() (may fail if search-string contains <, &, amp, gt, lt, ...)
267
	$anchor =  make_url_target($mod_page_link_target, $anchor_text, $func_search_words);
268

    
269
	// make the link from $mod_page_link, add anchor
270
	$link = "";
271
	$link = page_link($mod_page_link);
272
	if(strpos($mod_page_link, 'http:')===FALSE)
273
		$link .= make_url_searchstring($func_search_match, $func_search_url_array);
274
	$link .= $anchor;
275

    
276
	// now get the excerpt
277
	$excerpt = "";
278
	$excerpt_array = array();
279
	if($mod_max_excerpt_num > 0) {
280
		if(!$excerpt_array = get_excerpts($mod_text, $func_search_words, $mod_max_excerpt_num)) {
281
			return false;
282
		}
283
		$excerpt = prepare_excerpts($excerpt_array, $func_search_words, $mod_max_excerpt_num);
284
	}
285

    
286
	// handle thumbs - to deactivate this look in the module's search.php: $show_thumb (or maybe in the module's settings-page)
287
	if($mod_pic_link != "") {
288
		$excerpt = '<table class="excerpt_thumb" width="100%" cellspacing="0" cellpadding="0" border="0"><tbody><tr><td width="110" valign="top"><a href="'.$link.'"><img src="'.WB_URL.'/'.MEDIA_DIRECTORY.$mod_pic_link.'" alt="" /></a></td><td>'.$excerpt.'</td></tr></tbody></table>';
289
	}
290

    
291
	// print-out the excerpt
292
	$vars = array();
293
	$values = array();
294
	list($date, $time) = get_page_modified($mod_page_modified_when);
295
	list($username, $displayname) = get_page_modified_by($mod_page_modified_by, $func_users);
296
	$vars = array('[LINK]', '[TITLE]', '[DESCRIPTION]', '[USERNAME]','[DISPLAY_NAME]','[DATE]','[TIME]','[TEXT_LAST_UPDATED_BY]','[TEXT_ON]','[EXCERPT]');
297
	$values = array(
298
		$link,
299
		$mod_page_title,
300
		$mod_page_description,
301
		$username,
302
		$displayname,
303
		$date,
304
		$time,
305
		$TEXT['LAST_UPDATED_BY'],
306
		$TEXT['ON'],
307
		$excerpt
308
	);
309
	echo str_replace($vars, $values, $func_results_loop_string);
310
	if($func_enable_flush) { // ATTN: this will bypass output-filters and may break template-layout or -filters
311
		ob_flush();flush();
312
	}
313
	return true;
314
}
315

    
316
// list all files and dirs in $dir (recursive), omits '.', '..', and hidden files/dirs
317
// returns an array of two arrays ($files[] and $dirs[]).
318
// usage: list($files,$dirs) = list_files_dirs($directory);
319
//        $depth: get subdirs (true/false)
320
function list_files_dirs($dir, $depth=true, $files=array(), $dirs=array()) {
321
	$dh=opendir($dir);
322
	while(($file = readdir($dh)) !== false) {
323
		if($file{0} == '.' || $file == '..') {
324
			continue;
325
		}
326
		if(is_dir($dir.'/'.$file)) {
327
			if($depth) {
328
				$dirs[] = $dir.'/'.$file;
329
				list($files, $dirs) = list_files_dirs($dir.'/'.$file, $depth, $files, $dirs);
330
			}
331
		} else {
332
			$files[] = $dir.'/'.$file;
333
		}
334
	}
335
	closedir($dh);
336
	natcasesort($files);
337
	natcasesort($dirs);
338
	return(array($files, $dirs));
339
}
340

    
341
// keeps only wanted entries in array $files. $str have to be an eregi()-compatible regex
342
function clear_filelist($files, $str, $keep=true) {
343
	// options: $keep = true  : remove all non-matching entries
344
	//          $keep = false : remove all matching entries
345
	$c_filelist = array();
346
	if($str == '')
347
		return $files;
348
	foreach($files as $file) {
349
		if($keep) {
350
			if(eregi($str, $file)) {
351
				$c_filelist[] = $file;
352
			}
353
		} else {
354
			if(!eregi($str, $file)) {
355
				$c_filelist[] = $file;
356
			}
357
		}
358
	}
359
	return($c_filelist);
360
}
361

    
362
?>
(4-4/4)