X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;ds=inline;f=html%2Fhelpviewer.php;h=a5710b20257a77fb3f65f78b4d7ffdb6b3dd458d;hb=24fab470be00492015bbf360e12cb6e8cc5e3a6b;hp=b8915104cd9567344a0250ffe7be0122f43a65f2;hpb=ec21c1199da86989cdadbb3d94a5dbe696a6e9bc;p=gosa.git
diff --git a/html/helpviewer.php b/html/helpviewer.php
index b8915104c..a5710b202 100644
--- a/html/helpviewer.php
+++ b/html/helpviewer.php
@@ -18,511 +18,212 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/* Include classes and configs */
+@require_once ("../include/php_setup.inc");
+@require_once ("functions.inc");
+@require_once ("functions_helpviewer.inc");
+
+error_reporting(0);
+header("Content-type: text/html; charset=UTF-8");
+session_start();
+$config= $_SESSION['config'];
-
-
-/* Basic setup, remove eventually registered sessions */
-require_once ("../include/php_setup.inc");
-require_once ("../include/functions.inc");
-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.")."";
+/* If no config object is found in the session, abort help */
+if (!isset($_SESSION['config'])){
+ gosa_log ("main.php called without session");
+ header ("Location: index.php");
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'] == ""){
$lang= get_browser_language();
} else {
$lang= $config->data['MAIN']['LANG'];
}
+
$lang.=".UTF-8";
+
putenv("LANGUAGE=");
putenv("LANG=$lang");
setlocale(LC_ALL, $lang);
$GLOBALS['t_language']= $lang;
$GLOBALS['t_gettext_message_dir'] = $BASE_DIR.'/locale/';
-/* Set the text domain as 'messages' */
$domain = 'messages';
bindtextdomain($domain, "$BASE_DIR/locale");
textdomain($domain);
@DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__, $lang, "Setting language to");
-/* Get plugin list */
-$plist= $_SESSION['plist'];
+$config= $_SESSION['config'];
+if (isset ($config->data['MAIN']['COMPILE'])){
+ $smarty->compile_dir= $config->data['MAIN']['COMPILE'];
+} else {
+ $smarty->compile_dir= '/var/spool/gosa/';
+}
-/*
-##################
-My PART ^^
-##################
+/* HELP management starts here ...
*/
-//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;
+/* Generate helpobject */
+if(isset($_SESSION['helpobject'])){
+ $helpobject = $_SESSION['helpobject'];
+}else{
+ $helpobject['lang'] = $lang;
+ $helpobject['helpconf'] = array();
+ $helpobject['currentplug'] = "";
+ $helpobject['file'] = "index.html";
+ $helpobject['helpconf'] = $_SESSION['plist']->gen_headlines();
}
-/* 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'] = "" ;
+$lang = $lang[0].$lang[1];
+
+$helpobject['lang'] = $lang;
+$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 > ...
/* Default pages */
$backward =$defaultpage;
$index =$defaultpage;
$forward ="node1.html";
-/*
- Here it begins, the real function, above only definitions
+/* Every class which is called within a tab, stores its name in the Session.
+ * If $_SESSION['current_class_for_help'] isset,
+ * get the helpfile specified in the xml file and display it.
+ * Unset this Session entry, to avoid displaying it again.
*/
-/* 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));
-
- /* 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'];
- }
-
- /* 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;
+if(isset($_SESSION['current_class_for_help'])){
+
+ /* Create new XML parser with the path to the Xml file */
+ $xml = new parseXml("../doc/guide.xml");
+
+ /* Generate help array */
+ $str = $xml->parse();
+
+ /* __LANG__ is used as placeholder for the used language*/
+ $helpdir= preg_replace("/__LANG__/i",$lang,$str[($_SESSION['current_class_for_help'])]['PATH']);
+
+ /* If there is no entry in the xml file for this class, display an error message */
+ if($helpdir == ""){
+
+ $smarty->assign("help_contents","
"._("There is no helpfile specified for this class."))."
";
+ $header= "".$smarty->fetch(get_template_path('headers.tpl'));
+ $display= ( $header.$smarty->fetch(get_template_path('help.tpl')));
+ echo $display;
+ unset($_SESSION['current_class_for_help']);
+ exit();
}
-
- /* Check forward backward, funtionality*/
- if($page != $defaultpage)
- {
- /* Extract Number of node page */
- $number = str_replace($prefix,"",str_replace($suffix,"",$page));
-
- /* Check if we can switch forward and/or backward*/
- $bck = $prefix.($number-1).$suffix;
- $fck = $prefix.($number+1).$suffix;
-
- /* backward page exists ?, so allow it*/
- if((isset($helppages[$bck]))) {
- $backward = $bck;
- }
-
- /* forward exists ?*/
- if((isset($helppages[$fck]))) {
- $forward = $fck;
- }
- }
-
- $help_contents=readfiles($helpdir,$prefix,$suffix,false,$page);
-
- /* 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);
+
+ /* Save filename */
+ $helpobject['file']= $str[($_SESSION['current_class_for_help'])]['FILE'];
+
+ /* Save path to the file */
+ $helpobject['currentplug'] = $helpdir;
+
+ /* Avoid displaying the same help every time */
+ if(isset($_GET['pg'])){
+ unset($_SESSION['current_class_for_help']);
}
-
- $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++;
- }
- }
-
- /* 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);
- }
-
- /* Include file status, for debugging, not used in script yet */
- $str[$file]['stat'] = stat($basedir.$file);
+}elseif(isset($_GET['plug'])){
+ /* This displays helpfiles depending on the current $_GET[plug] */
+ $tmp = new pluglist($_SESSION['config'],NULL);
+ $path = $tmp->get_path($_GET['plug']);
+ $helpobject['currentplug'] = $path;
+ $helpobject['file'] = "index.html";
+ $helpdir = "../doc/guide/user/".$helpobject['lang']."/html/".preg_replace("/^.*\//i","",$helpobject['currentplug']);
+ if(empty($helpobject['currentplug'])){
+ $helpdir= "";
}
-
- /* 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);
}
-
-/* Read filecontent */
-function getcontents($file)
-{
- $str = "" ; // Temporary variable for file contents
- $tmp = "" ; // Temporary varibale for partitial file contents
-
- /* open file and read*/
- $fp = fopen($file,"r");
- if($fp) {
- while($tmp = fread($fp,512))
- {
- $str.= $tmp;
- }
+/* this Post var is set if another page is requested */
+if(isset($_GET['pg'])){
+
+ if(preg_match("/\//",$_GET['pg'])){
+ $arr = split("\/",$_GET['pg']);
+ $helpobject['currentplug'] = "../doc/guide/user/".$helpobject['lang']."/html/".$arr[0];
+ $helpdir = $helpobject['currentplug'];
+ $helpobject['file']= $arr[1];
}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);
-}
+ /* PG should contain a filename */
+ $helpobject['file'] = $_GET['pg'];
-/*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);
-}
-/* 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;
+ /* If empty, force displaying the index */
+ if(empty($_GET['pg'])){
+ $helpobject['currentplug'] = "";
+ $helpobject['file'] = "index.html";
}
- }
+ /* Create new helpdir (The path where the requested page is located)*/
+ $helpdir = "../doc/guide/user/".$helpobject['lang']."/html/".preg_replace("/^.*\//i","",$helpobject['currentplug']);
- /* 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)
- {
- /* 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];
- }
+ /* If helpdir is empty, force index */
+ if(empty($helpobject['currentplug'])){
+ $helpdir= "";
}
}
-
- /* Save result in Session, so we can mark words later, or go back to search, without searching again*/
- $_SESSION['lastresults'] = $result;
- return($result);
}
-/* 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']);
-
- /* Detect 10 best Sites */
- foreach($res as $key=>$val){
-
- /* Skip results with no hits */
- if($val['hits']['overall']>0){
- $topten[$key] = $val['hits']['overall'];
- }
- }
+$helpdir.="/";
- /* Sort by hit position in content, to easier mark words */
- asort($topten);
- $topten = array_reverse($topten);
- $topten = (array_slice($topten,0,$maxresults));
+/* Save current settings */
+$_SESSION['helpobject'] = $helpobject;
- /* 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']);
- }
+/*
+ * Display management
+ */
- /* appending footer message for resultlist */
- $ret.= "
".count($topten)." - "._("Results for your search with the keyword")." ".$_SESSION['search_string'].""._(" interpreted as ")."".$_SESSION['parsed_search_keyword']."";
+/* If there is no helpdir or file defined, display the index */
+if(isset($_POST['search'])){
+ $helpdir = "../doc/guide/user/".$helpobject['lang']."/html/";
+ /* read all available directories */
+ $index = readfiles($helpdir,$prefix,$suffix,false,false);
+ $smarty->assign("help_contents",((searchlist($index,search($index,$_POST['search_string']),10))));
+ $header= "".$smarty->fetch(get_template_path('headers.tpl'));
- return($ret);
-}
+ /* I don't know why, but we must use utf8_encode to avoid dispplay errors */
+ $display= ( $header.$smarty->fetch(get_template_path('help.tpl')));
+ echo $display;
+}elseif(((empty($helpdir)))||($helpdir=="/")){
+ /* Generate Index and display it */
+ $smarty->assign("help_contents",genIndex());
+ $header= "".$smarty->fetch(get_template_path('headers.tpl'));
-/* 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];
- }
- }
+ /* I don't know why, but we must use utf8_encode to avoid dispplay errors */
+ $display= utf8_encode( $header.$smarty->fetch(get_template_path('help.tpl')));
+ echo $display;
- ksort($repl);
+}elseif((is_dir($helpdir))&&($fp = opendir($helpdir))){
+
+ /* Readfile gets the content of the requested file,
+ * parse it, rework links images and so on */
+ $index = readfiles($helpdir,$prefix,$suffix,false,$helpobject['file']);
- foreach($repl as $position=>$word) {
- $pos1 = strlen($arr);
- $arr= markword($arr,($position+$posadd),$word,$pre,$suf);
- $pos2 = strlen($arr);
- $posadd =$posadd + ($pos2 - $pos1);
+ /* if this page is result from a search, mark the search strings */
+ if(isset($_GET['mark'])){
+ $matches = $_SESSION['lastresults'][preg_replace("/^.*\//i","",$helpobject['currentplug'])][$helpobject['file']];
+ $index[$helpobject['file']]['content'] = markup_page($index[$helpobject['file']]['content'],$matches);
}
- 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);
-}
+ /* Display the help contents */
+ $smarty->assign("help_contents",$index[$helpobject['file']]['content']);
+ $header= "".$smarty->fetch(get_template_path('headers.tpl'));
+
+ /* I don't know why, but we must use utf8_encode to avoid dispplay errors */
+ $display= utf8_encode( $header.$smarty->fetch(get_template_path('help.tpl')));
+ echo $display;
-/* 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);
-}
-
-/*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);
-
- if ($pos1 > $pos2) {
- return(true);
- }else{
- return(false);
- }
+}else{
+
+ /* There was a file requested which actually doesn't exists */
+ $smarty->assign("help_contents","".sprintf(_("Helpdir '%s' is not accessible, can't read any helpfiles."),$helpdir))."
";
+ $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:
?>