X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=html%2Fhelpviewer.php;h=308500d0aa1da9fe7d56d1980ffc71a401a197a9;hb=af68c0eb4e77ea7e8f783b08fa1396a8fd8463b7;hp=b8915104cd9567344a0250ffe7be0122f43a65f2;hpb=ec21c1199da86989cdadbb3d94a5dbe696a6e9bc;p=gosa.git diff --git a/html/helpviewer.php b/html/helpviewer.php index b8915104c..308500d0a 100644 --- a/html/helpviewer.php +++ b/html/helpviewer.php @@ -19,28 +19,14 @@ */ - - /* Basic setup, remove eventually registered sessions */ require_once ("../include/php_setup.inc"); -require_once ("../include/functions.inc"); +require_once ("functions.inc"); +require_once ("functions_helpviewer.inc"); +header("Content-type: text/html; charset=UTF-8"); + session_start (); error_reporting(E_ALL); -/* Logged in? Simple security check */ -if (!isset($_SESSION['ui'])){ - gosa_log ("Error: helpviewer.php called without session"); - echo ""._("Help is not available if you are not logged in.").""; - exit; -} - - -/* Set template compile directory */ -$config= $_SESSION['config']; -if (isset ($config->data['MAIN']['COMPILE'])){ - $smarty->compile_dir= $config->data['MAIN']['COMPILE']; -} else { - $smarty->compile_dir= '/var/spool/gosa/'; -} /* Language setup */ if ($config->data['MAIN']['LANG'] == ""){ @@ -61,6 +47,22 @@ bindtextdomain($domain, "$BASE_DIR/locale"); textdomain($domain); @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__, $lang, "Setting language to"); + +/* Logged in? Simple security check */ +if (!isset($_SESSION['ui'])){ + gosa_log ("Error: helpviewer.php called without session"); + echo ""._("Help is not available if you are not logged in.").""; + exit; +} + +/* Set template compile directory */ +$config= $_SESSION['config']; +if (isset ($config->data['MAIN']['COMPILE'])){ + $smarty->compile_dir= $config->data['MAIN']['COMPILE']; +} else { + $smarty->compile_dir= '/var/spool/gosa/'; +} + /* Get plugin list */ $plist= $_SESSION['plist']; @@ -70,43 +72,56 @@ My PART ^^ ################## */ -//set_error_handler("myone"); -$helpdir = "../doc/guide/admin/en/manual_gosa_en/"; -$defaultpage = "index.html"; -$prefix = "node"; -$suffix = ".html"; -$maxresults = 10; -$minwordlength= 3; - -// Only for testing delete this if everything works fine -function myone($par1,$par2,$par3,$par3) -{ - print "
Seite : ".$par1."
Name : ".$par2."
Seite : ".$par3."
Zeile : ".$par3; -} +$helpdir = HELP_BASEDIR."/en/manual_gosa_en/"; // Folder to use for help files +$defaultpage = "index.html"; // alternative file, shown on error, or on first call +$prefix = "node"; // Prefix of the generated help files +$suffix = ".html"; // Suffix of the generated helpfiles +$maxresults = 10; // max number of results shown in result list +$minwordlength = 3; // Word less than 3 chars will be dropped in search +$allowed_chars_in_searchword = "'[^a-z0-9 %_-]'i"; // Remove all chars that would disturb our search like < or > ... +$pre_mark = "" ; // Sign words with this +$suf_mark = ""; // and this +$backwardlink = " + \""._("previous")."\" + "; + +$forwardlink = " + \""._("next")."\" + "; /* Define which tags musst be delete, header, navigation, banner */ -#fixme Theres a better method to handle replacment , preg_replace can handle arrays , this, would be little easier -$i=0; $replacements=array(); -$replacements['range'][$i]['from'] = "//"; -$replacements['range'][$i]['to'] = ""; -$i++; -$replacements['range'][$i]['from'] = "@]*?>.*?DIV>@si"; -$replacements['range'][$i]['to'] = ""; -$i++; -$replacements['range'][$i]['from'] = "/
/"; -$replacements['range'][$i]['to'] = ""; -$i++; -$replacements['range'][$i]['from'] = "@]*?>.*?ADDRESS>@si"; -$replacements['range'][$i]['to'] = ""; -$i++; -$replacements['range'][$i]['from'] = "/<\/BODY.*>/"; -$replacements['range'][$i]['to'] = ""; -$i++; - -/* Bsp . : Replace Table Head to specified tableheader */ -$replacements['range'][$i]['from'] = "@]*?>.*?>@si"; -$replacements['range'][$i]['to'] = "" ; +$replacements['from']=array("@@si", + "/border=\".*\"/i", + "''", +// "/alt=\".*\"/i", + "/
/", + "@]*?>.*?ADDRESS>@si", + "@<\/BODY[^>]*?>.*?HTML>@si", + "''", + "/src.*icons/i", + "/src=\"/i", + "/

/", + /* picture replacements */ + // "", + ); + + +$replacements['to']=array("", + " border=\"0\" ", + "", + // "", + "", + "", + "", + "

", + "src=\"", + "src=\"images/", + "

", + /* picture replacements */ +// "", + ); + /* Default pages */ $backward =$defaultpage; @@ -116,413 +131,158 @@ $forward ="node1.html"; /* Here it begins, the real function, above only definitions */ -/* We prepare to search, all Document for the given keyword */ -if(isset($_POST['search'])){ - - /* Get Keyword */ - $keyword = $_POST['search_string']; - - /* Save Keyword to be able to show last searched word in template */ - $_SESSION['search_string']= $keyword; - /* Read all files with contents*/ - /* |Folder="/var/ww...", - | |Fileprefix="node" - | | |Filesuffix=".html" - | | | |WithoutContent=false(This means : read content) - | | | | |Singlepage=false(Means read all, if w want to read single, specify its filename)"*/ - $arr = readfiles($helpdir,$prefix,$suffix,false,$singlepage=false); - - /* Create Searchresult for our Keyword(s) */ - $res = search($arr,$keyword); - - /* Tell smarty which pages to use for backward forwa.. */ - $smarty->assign("backward",$backward); - $smarty->assign("index" ,$index); - $smarty->assign("forward" ,$forward); - - /* Tell smarty the Keyword, to show it in the input field again */ - $smarty->assign("search_string",$keyword); - - /* Create result list */ - $smarty->assign("help_contents",searchlist($arr,$res,$maxresults)); +if(!file_exists(HELP_BASEDIR."/en/manual_gosa_en/")){ + /* prevent php warning missing value ... or so*/ + $smarty->assign("backward",""); + $smarty->assign("index" ,""); + $smarty->assign("forward" ,""); + $smarty->assign("search_string",""); + $smarty->assign("help_contents","
".sprintf(_("Can't read any helpfiles from ' %s ', possibly there is no help available."),HELP_BASEDIR."/en/manual_gosa_en/")); /* Output html ...*/ $header= "".$smarty->fetch(get_template_path('headers.tpl')); $display= $header.$smarty->fetch(get_template_path('help.tpl')); echo $display; - /* - Don't search, only show selected page - */ -}else{ - - /* present last searched word(s)*/ - $smarty->assign("search_string",$_SESSION['search_string']); - - /* Read all files, prepare to serach */ - $helppages = readfiles("../doc/guide/admin/en/manual_gosa_en/",$prefix,$suffix,true); - - /* Get transmitted page */ - if(isset($_GET['pg'])){ - $page = $_GET['pg']; - } +}else{ - /* test if this page exists, in our array of files */ - if((!isset($helppages[$page]))&&($page!=$defaultpage)) - { - //print "Requested helppage is unknown, redirekted to index"; // For debugging only - $page = $defaultpage; - } + /* We prepare to search, all Document for the given keyword */ + if(isset($_POST['search'])){ - /* Check forward backward, funtionality*/ - if($page != $defaultpage) - { - /* Extract Number of node page */ - $number = str_replace($prefix,"",str_replace($suffix,"",$page)); + /* Get Keyword */ + $keyword = $_POST['search_string']; - /* Check if we can switch forward and/or backward*/ - $bck = $prefix.($number-1).$suffix; - $fck = $prefix.($number+1).$suffix; + /* Save Keyword to be able to show last searched word in template */ + $_SESSION['search_string']= $keyword; - /* backward page exists ?, so allow it*/ - if((isset($helppages[$bck]))) { - $backward = $bck; - } + /* Read all files with contents*/ + /* |Folder="/var/ww...", + | |Fileprefix="node" + | | |Filesuffix=".html" + | | | |WithoutContent=false(This means : read content) + | | | | |Singlepage=false(Means read all, if w want to read single, specify its filename)"*/ + $arr = readfiles($helpdir,$prefix,$suffix,false,$singlepage=false); - /* forward exists ?*/ - if((isset($helppages[$fck]))) { - $forward = $fck; - } - } + /* Create Searchresult for our Keyword(s) */ + $res = search($arr,$keyword); - $help_contents=readfiles($helpdir,$prefix,$suffix,false,$page); + /* Tell smarty which pages to use for backward forwa.. */ + $smarty->assign("backward",""); + $smarty->assign("index" ,$index); + $smarty->assign("forward" ,""); - /* Mark last searched words */ - if($_GET['mark']){ - $marks = ($_SESSION['lastresults']) ; - $help_contents = markup_page($help_contents[$page]['content'],$marks[$page]); - $help_contents=remove_unwanted_tags($help_contents,$replacements); - }else{ - $help_contents=remove_unwanted_tags($help_contents[$page]['content'],$replacements); - } + /* Tell smarty the Keyword, to show it in the input field again */ + $smarty->assign("search_string",$keyword); + /* Create result list */ + $smarty->assign("help_contents",searchlist($arr,$res,$maxresults)); - $smarty->assign("help_contents",$help_contents); - - /* Define our own navigation pages */ - $smarty->assign("backward",$backward); - $smarty->assign("index" ,$index); - $smarty->assign("forward" ,$forward); - - /* Fill page */ - $header= "".$smarty->fetch(get_template_path('headers.tpl')); - $display= $header.$smarty->fetch(get_template_path('help.tpl')); - echo $display; -} - -/******************************************* - Only function definition will follow here -#fixme Exclude function to seperate file -/******************************************* - -/* Reads all files in specified directory with contents an some inforations about the file */ -/* Read all files with contents*/ -/* |Folder="/var/ww...", - | |Fileprefix="node" - | | |Filesuffix=".html" - | | | |WithoutContent=false(This means : read content) - | | | | |Singlepage=false(Means read all, if w want to read single, specify its filename)"*/ -function readfiles($basedir,$prefix,$suffix,$onlyIndex,$singlepage=false) -{ - global $replacements; - - $str = array(); // Temporary variable - $cnt = 0; // Array index creation - $file = ""; // Contains Filename - - $dir = opendir($basedir); - - $str['global']['start'] = $cnt; // collect basic informations - Startpage - $str['global']['basedir'] = $basedir; // collect basic informations - Basedirectory - - /* Startime for Benchmark */ - $start = (time()+microtime()); - - /* if singlepage == false -> Get all pages, */ - if(!$singlepage) { - - /* While theres is an unreaded file in our resource */ - while (($file = readdir($dir)) !== false) { - - /* Filter all files which arn't intressting */ - if((strstr($file,$suffix))&&($file!=".")&&($file!="..")&&(strstr($file,$prefix))){ - - /* Collect informations */ - $str[$file]=array(); - $str[$file]['name'] = $file; - $str[$file]['size'] = filesize($basedir.$file); - - /* Readfile conent too ? */ - if(!$onlyIndex){ - $str[$file]['content']= remove_unwanted_tags(linkwrapper(getcontents($basedir.$file),""),$replacements); - } - - /* Include file status, for debugging, not used in script yet */ - $str[$file]['stat'] = stat($basedir.$file); - $cnt++; - } + /* show some errors */ + if (isset($_SESSION['errors'])){ + $smarty->assign("errors", $_SESSION['errors']); } - - /* Only get on file*/ - }else{ - /* Pages read = 1 */ - $cnt = 1; - - /* Prepare result*/ - $file = $singlepage; - $str[$file] = array(); - $str[$file]['name'] = $file; - $str[$file]['size'] = filesize($basedir.$file); - - /* If onlyIndex == true skip reading content */ - if(!$onlyIndex){ - $str[$file]['content']= remove_unwanted_tags(linkwrapper(getcontents($basedir.$file),""),$replacements); + if ($error_collector != ""){ + $smarty->assign("php_errors", $error_collector.""); + } else { + $smarty->assign("php_errors", ""); } - /* Include file status, for debugging, not used in script yet */ - $str[$file]['stat'] = stat($basedir.$file); - } - - /* Sort to right order */ - asort($str); - - /* Endtime for Benchmark*/ - $end = (time()+microtime()); - $str['global']['cmptime'] = $end-$start; - - /* Number of pages readed */ - $str['global']['numpages']= $cnt; - closedir($dir); - return($str); -} + /* Output html ...*/ + $header= "".$smarty->fetch(get_template_path('headers.tpl')); + $display= $header.$smarty->fetch(get_template_path('help.tpl')); + echo $display; -/* Read filecontent */ -function getcontents($file) -{ - $str = "" ; // Temporary variable for file contents - $tmp = "" ; // Temporary varibale for partitial file contents + /* + Don't search, only show selected page + */ + }else{ - /* open file and read*/ - $fp = fopen($file,"r"); - if($fp) { - while($tmp = fread($fp,512)) - { - $str.= $tmp; + /* present last searched word(s)*/ + if(!isset($_SESSION['search_string'])){ + $_SESSION['search_string']=""; } - }else{ - return(false); - } - return($str); -} -/*Remove tags */ -function remove_unwanted_tags($str,$replacements) -{ -#fixme This solution is .... - $str=str_replace("\n","||WasBr||",$str); - foreach($replacements['range'] as $var) - { - $str=preg_replace($var['from'],$var['to'],$str); - } - $str=str_replace("||WasBr||","\n",$str); - return($str); -} + $smarty->assign("search_string",$_SESSION['search_string']); -/*Converts the all links to specified path, is needed to get simple navigation */ -function linkwrapper($str,$link) -{ - $str=str_replace("HREF=\"","href=\"".$link."?pg=",$str); - return($str); -} + /* Read all files, prepare to serach */ + $helppages = readfiles($helpdir,$prefix,$suffix,true); -/* Search content */ -function search($arr,$word) -{ - global $minwordlength; - /* Prepare Vars */ - $result =array(); // Search result, filename, + hits + hits per word + matches - $words =array(); // Temporary searchword handling - $useablewords =array(); // Temporary searchword handling - $tryword = ""; // Temporary searchword handling - $result['global']['maxhit'] = 0; - unset($_SESSION['lastresults']); - unset($_SESSION['parsed_search_keyword']); - - /* prepare searchwords */ - $word = trim($word); - - /* Filter all unusable chars */ - $word = preg_replace("[^a-z0-9_+% ]","",$word); - $words = split(" ",str_replace("+"," ",$word)); - - /* Check all wordlengths */ - foreach($words as $tryword){ - $tryword = trim($tryword); - - /* Filter words smaler than 3 chars */ - if(strlen($tryword)>=$minwordlength) { - $_SESSION['parsed_search_keyword'].=$tryword." "; - $useablewords[]=$tryword; + /* Get transmitted page */ + if(isset($_GET['pg'])){ + $page = $_GET['pg']; + }else{ + $page = $defaultpage; } - } - - /* Use words to search the content */ - foreach($arr as $key=>$val) - { - /* overallhits counts hits per page */ - $overallhits=0; - - /* Search all words */ - foreach($useablewords as $word) + + /* test if this page exists, in our array of files */ + if((!isset($helppages[$page]))&&($page!=$defaultpage)) { - /* Skip key global, it contains no file data - it is a summary info*/ - if($key!="global") - { - /* Get all hits for the word in $matches*/ - preg_match_all("/".$word."/i",$arr[$key]['content'], $matches,PREG_OFFSET_CAPTURE); - - /* Filter in Tag results*/ - if(count($matches[0])){ - foreach($matches[0] as $num=>$hit){ - if(is_in_tag($arr[$key]['content'],$hit[1])) { - unset($matches[0][$num]); - } - } - } - - /* Count matches */ - $overallhits=$overallhits + count($matches[0]); - - /* Save collected data */ - $result[$key]['hits'][$word] = count($matches[0]); - $result[$key]['hits']['overall']= $overallhits; - - /* Save max hits for page */ - if($overallhits > $result['global']['maxhit']){ - $result['global']['maxhit']=$overallhits; - } - - /* Add results for word to return value*/ - $result[$key]['match'][$word]=array(); - $result[$key]['match'][$word]=$matches[0]; - } + //print "Requested helppage is unknown, redirekted to index"; // For debugging only + $page = $defaultpage; } - } - /* Save result in Session, so we can mark words later, or go back to search, without searching again*/ - $_SESSION['lastresults'] = $result; - return($result); -} + /* Check forward backward, funtionality*/ + if($page != $defaultpage) + { + /* Extract Number of node page */ + $number = str_replace($prefix,"",str_replace($suffix,"",$page)); -/* Detect 10 Best result entries, sort and call createResultEntry to create HTML output for complete list */ -function searchlist($arr,$res,$maxresults) -{ - $global = $res['global']; - $topten = array(); // To detect 10 best solutions - $ret = ""; // return value - unset($res['global']); + /* Check if we can switch forward and/or backward*/ + $bck = $prefix.($number-1).$suffix; + $fck = $prefix.($number+1).$suffix; - /* Detect 10 best Sites */ - foreach($res as $key=>$val){ + /* backward page exists ?, so allow it*/ + if((isset($helppages[$bck]))) { + $backward = $bck; + } - /* Skip results with no hits */ - if($val['hits']['overall']>0){ - $topten[$key] = $val['hits']['overall']; + $forward = $fck; } - } - /* Sort by hit position in content, to easier mark words */ - asort($topten); - $topten = array_reverse($topten); - $topten = (array_slice($topten,0,$maxresults)); + $help_contents=readfiles($helpdir,$prefix,$suffix,false,$page); - /* We have a result, an array with all content, an array with hits and position and we have the 10 best hits */ - /* Foreach */ - foreach($topten as $name => $hits) { - $ret.= createResultEntry($arr[$name],$res[$name],$name,$global['maxhit']); - } - - /* appending footer message for resultlist */ - $ret.= "
".count($topten)." - "._("Results for your search with the keyword")." ".$_SESSION['search_string'].""._(" interpreted as ")."".$_SESSION['parsed_search_keyword'].""; - - return($ret); -} - -/* This function marks a string with the given search result for this string*/ -function markup_page($arr,$res) -{ - $ret = ""; // return value - $pre = "" ; - $suf = ""; - $repl = array(); - $posadd = 0; - - foreach($res['match'] as $word => $matches) { - foreach($matches as $matchnr=>$match) { - $repl[$match[1]]=$match[0]; + /* Mark last searched words */ + if(isset($_GET['mark'])){ + $marks = ($_SESSION['lastresults']) ; + $help_contents = markup_page($help_contents[$page]['content'],$marks[$page]); + $help_contents=$help_contents; + }else{ + $help_contents=$help_contents[$page]['content']; } - } - ksort($repl); + $smarty->assign("help_contents",$help_contents); - foreach($repl as $position=>$word) { - $pos1 = strlen($arr); - $arr= markword($arr,($position+$posadd),$word,$pre,$suf); - $pos2 = strlen($arr); - $posadd =$posadd + ($pos2 - $pos1); - } - return($arr); -} - -/* This function marks a single word with the specified prefix and suffix */ -function markword($string,$position,$word,$prefix,$suffix) -{ - $wordlength = strlen($word); - $wholelength = strlen($string); - - $first = substr($string,0,$position); - $last = substr($string,($position+$wordlength),$wholelength); - - return($first.$prefix.$word.$suffix.$last); -} - - -/* Creates HTML output for a single search result entry */ -function createResultEntry($entry,$res,$name,$max) -{ - $percentage = (int)(($res['hits']['overall'] / $max) * 100) ; - - $str = "".$percentage."% "._("hit rate in following file ").$name."
" ; - $str.= substr(strip_tags($entry['content']),0,200); - $str.= "
"; - - return($str); -} + /* Define our own navigation pages */ + if($page == $defaultpage){ + $smarty->assign("backward",""); + }else{ + $smarty->assign("backward",sprintf($backwardlink,$backward)); + } + $smarty->assign("index" ,$index); + + if(!(isset($helppages[$forward]))){ + $smarty->assign("forward",""); + }else{ + $smarty->assign("forward",sprintf($forwardlink,$forward)); + } -/*Simple function to detect if we prepare to change a tag or visible text */ -function is_in_tag($string,$pos) -{ - $pos1 = strpos($string,"<",$pos); - $pos2 = strpos($string,">",$pos); + /* show some errors */ + if (isset($_SESSION['errors'])){ + $smarty->assign("errors", $_SESSION['errors']); + } + if ($error_collector != ""){ + $smarty->assign("php_errors", $error_collector.""); + } else { + $smarty->assign("php_errors", ""); + } - if ($pos1 > $pos2) { - return(true); - }else{ - return(false); + /* Fill page */ + $header= "".$smarty->fetch(get_template_path('headers.tpl')); + $display= $header.$smarty->fetch(get_template_path('help.tpl')); + echo $display; } } - // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler: ?>