Project

General

Profile

1
<?php
2

    
3
// $Id: search_modext.php 857 2008-09-16 18:33:01Z 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) { // this may crash windows server, so skip if on windows
105
		// jump from match to match, get excerpt, stop if $max_excerpt_num is reached
106
		$last_end = 0; $offset = 0;
107
		while(preg_match('/'.$word.'/Sisu', $text, $match_array, PREG_OFFSET_CAPTURE, $last_end)) {
108
			$offset = ($match_array[0][1]-206 < $last_end)?$last_end:$match_array[0][1]-206;
109
			if(preg_match($regex, $text, $matches, PREG_OFFSET_CAPTURE, $offset)) {
110
				$last_end = $matches[1][1]+strlen($matches[1][0])-1;
111
				if(!preg_match('/\b[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\./', $matches[1][0])) // skip excerpts with email-addresses
112
					$excerpt_array[] = trim($matches[1][0]);
113
				if(count($excerpt_array)>=$max_excerpt_num) {
114
					$excerpt_array = array_unique($excerpt_array);
115
					if(count($excerpt_array) >= $max_excerpt_num)
116
						break;
117
				}
118
			} else { // problem - preg_match failed: can't find a start- or stop-sign
119
				$last_end += 201; // jump forward and try again
120
			}
121
		}
122
	} else { // compatile, but may be very slow with many large pages
123
		if(preg_match_all($regex, $text, $match_array)) {
124
			foreach($match_array[1] AS $string) {
125
				if(!preg_match('/\b[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\./', $string)) // skip excerpts with email-addresses
126
					$excerpt_array[] = trim($string);
127
			}
128
		}
129
	}
130
	return $excerpt_array;
131
}
132

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

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

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

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

    
261
	// make the link from $mod_page_link, add anchor
262
	$link = "";
263
	$link = page_link($mod_page_link);
264
	if(strpos($mod_page_link, 'http:')===FALSE)
265
		$link .= make_url_searchstring($func_search_match, $func_search_url_array);
266
	$link .= $anchor;
267

    
268
	// now get the excerpt
269
	$excerpt = "";
270
	$excerpt_array = array();
271
	if($mod_max_excerpt_num > 0) {
272
		if(!$excerpt_array = get_excerpts($mod_text, $func_search_words, $mod_max_excerpt_num)) {
273
			return false;
274
		}
275
		$excerpt = prepare_excerpts($excerpt_array, $func_search_words, $mod_max_excerpt_num);
276
	}
277

    
278
	// handle thumbs - to deactivate this look in the module's search.php: $show_thumb (or maybe in the module's settings-page)
279
	if($mod_pic_link != "") {
280
		$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>';
281
	}
282

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

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

    
333
// keeps only wanted entries in array $files. $str have to be an eregi()-compatible regex
334
function clear_filelist($files, $str, $keep=true) {
335
	// options: $keep = true  : remove all non-matching entries
336
	//          $keep = false : remove all matching entries
337
	$c_filelist = array();
338
	if($str == '')
339
		return $files;
340
	foreach($files as $file) {
341
		if($keep) {
342
			if(eregi($str, $file)) {
343
				$c_filelist[] = $file;
344
			}
345
		} else {
346
			if(!eregi($str, $file)) {
347
				$c_filelist[] = $file;
348
			}
349
		}
350
	}
351
	return($c_filelist);
352
}
353

    
354
?>
(4-4/4)