X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=html%2Fhelpviewer.php;h=511dc06676e4806f08294af1e238d8740a19ac0f;hb=957790bc47ebcd5314ec6a72c82b8090492a8ed6;hp=68c0c4bd1bd5edd96529bbec0d1736bf491e0cdf;hpb=8f8b3c7afa701b59baa67a28da3db5c26490579a;p=gosa.git

diff --git a/html/helpviewer.php b/html/helpviewer.php
index 68c0c4bd1..511dc0667 100644
--- a/html/helpviewer.php
+++ b/html/helpviewer.php
@@ -18,29 +18,24 @@
    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");
 
-
-
-/* Basic setup, remove eventually registered sessions */
-require_once ("../include/php_setup.inc");
-require_once ("../include/functions.inc");
-require_once ("../include/functions_helpviewer.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 "<b>"._("Help is not available if you are not logged in.")."</b>";
-  exit;
-}
+restore_error_handler();
+header("Content-type: text/html; charset=UTF-8");
 
-
-/* Set template compile directory */
+session_start();
+$ui= $_SESSION["ui"];
 $config= $_SESSION['config'];
-if (isset ($config->data['MAIN']['COMPILE'])){
-  $smarty->compile_dir= $config->data['MAIN']['COMPILE'];
-} else {
-  $smarty->compile_dir= '/var/spool/gosa/';
+
+/* 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;
 }
 
 /* Language setup */
@@ -49,174 +44,228 @@ if ($config->data['MAIN']['LANG'] == ""){
 } 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/';
+}
+$smarty->assign("title", "GOsa - "._("Help browser"));
 
-/*
-##################
-My PART ^^
-##################
+/* HELP management starts here ...
  */
 
-//set_error_handler("myone");
-$helpdir                      = "../doc/guide/admin/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                     = "<b><u><i>" ;  // Sign words with this
-$suf_mark                     = "</i></u></b>";                   //  and this
-
-// Only for testing delete this if everything works fine
-function myone($par1,$par2,$par3,$par3)
-{
-  print "<br>Seite : ".$par1."<br>Name : ".$par2."<br>Seite : ".$par3."<br>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 */
-$replacements=array();
-$replacements['from']=array("@<!DOC.*<BODY >@si",
-                            "@<DIV[^>]*?>.*?DIV>@si",
-                            "'<code.*code>'",
-                            "/<HR>/",
-                            "@<ADDRESS[^>]*?>.*?ADDRESS>@si",
-                            "@<\/BODY[^>]*?>.*?HTML>@si",
-                            "'<TABLE.*>'");
-$replacements['to']=array("",
-                          "",
-                          "",
-                          "",
-                          "",
-                          "",
-                          "<table border=1 cellspacing=0 bgcolor=\"#E0E0E0\" width=\"95%\" align=\"center\" cellpadding=\"3\">");
+$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
+$helpdir ="";
+/* 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'];  
+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","<br><h2>"._("There is no helpfile specified for this class"))."</h2>";
+    $header= "<!-- headers.tpl-->".$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();  
+  }
+ 
+  /* 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']);
+  }
 
-  /* Save Keyword to be able to show last searched word in template */
-  $_SESSION['search_string']= $keyword;
+}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= "";
+  }
+}
+/* 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{
+    /* PG should contain a filename */
+    $helpobject['file'] = $_GET['pg'];
 
-  /* 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); 
+    /* 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']);
 
-  /* Tell smarty which pages to use for backward forwa.. */
-  $smarty->assign("backward",$backward);
-  $smarty->assign("index"   ,$index);
-  $smarty->assign("forward" ,$forward);
+    /* If helpdir is empty, force index */
+    if(empty($helpobject['currentplug'])){
+      $helpdir= "";
+    }
+  }
+}
+$helpdir.="/";
 
-  /* Tell smarty the Keyword, to show it in the input field again */
-  $smarty->assign("search_string",$keyword);
+/* Save current settings */
+$_SESSION['helpobject'] = $helpobject;
 
-  /* Create result list */
-  $smarty->assign("help_contents",searchlist($arr,$res,$maxresults));
+/* 
+ * Display management 
+ */
 
-  /* Output html ...*/
-  $header= "<!-- headers.tpl-->".$smarty->fetch(get_template_path('headers.tpl'));
-  $display= $header.$smarty->fetch(get_template_path('help.tpl'));
-  echo $display;
+$files = array();
+$f = opendir($helpdir);
+while($file = readdir($f)){
+  $files[$file]=$file;
+}
 
-  /*
-     Don't search, only show selected page
-   */
-}else{
+/* Some replacements */
+$backwardlink  = "<a href=\"?pg=%s\"  class=\"maintitlebar\">
+                  <img src='images/back.png' align=\"middle\" alt=\""._("previous")."\" border=\"0\">
+                 </a>";
 
-  /* present last searched word(s)*/
-  $smarty->assign("search_string",$_SESSION['search_string']);
+$forwardlink   = "<a href=\"?pg=%s\"  class=\"maintitlebar\">
+                  <img src='images/forward.png' align=\"middle\" alt=\""._("next")."\" border=\"0\">
+                 </a>";
 
-  /* 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'];
+$back = $for  ="";
+if($helpobject['file'] == "index.html"){
+  $back = "&nbsp;";
+  $for  = sprintf($forwardlink,   $prefix."1".$suffix);
+}else{
+  $current = preg_replace("/^".$prefix."/","",$helpobject['file']);
+  $current = preg_replace("/\.html$/","",$current);
+ 
+  if(isset($files[$prefix.($current+1).$suffix])) {
+    $for  = sprintf($forwardlink,    $prefix.($current+1).$suffix);
   }
-
-  /* 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($files[$prefix.($current-1).$suffix])) {
+    $back = sprintf($backwardlink,   $prefix.($current-1).$suffix);
+  }
+  if(($current-1) == 0){
+    $back = sprintf($backwardlink,   "index.html");
   }
+}
 
-  /* 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;
+/* 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= "<!-- headers.tpl-->".$smarty->fetch(get_template_path('headers.tpl'));
 
-    /* backward page exists ?, so allow it*/
-    if((isset($helppages[$bck]))) {
-      $backward = $bck;
-    }
+  /* 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= "<!-- headers.tpl-->".$smarty->fetch(get_template_path('headers.tpl'));
 
-    /* forward exists ?*/
-    if((isset($helppages[$fck])))  {
-      $forward  = $fck;
-    }
-  }
+  /* 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;
 
-  $help_contents=readfiles($helpdir,$prefix,$suffix,false,$page);
+}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']);
 
-  /* Mark last searched words */
+  /* if this page is result from a search, mark the search strings */
   if(isset($_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);
+    $matches = $_SESSION['lastresults'][preg_replace("/^.*\//i","",$helpobject['currentplug'])][$helpobject['file']];
+    $index[$helpobject['file']]['content']   = markup_page($index[$helpobject['file']]['content'],$matches);
   }
 
-  $smarty->assign("help_contents",$help_contents);
-
-  /* Define our own navigation pages */
-  $smarty->assign("backward",$backward);
-  $smarty->assign("index"   ,$index);
-  $smarty->assign("forward" ,$forward);
+  /* Display the help contents */
+  $smarty->assign("help_contents",$index[$helpobject['file']]['content']);
+  $header= "<!-- headers.tpl-->".$smarty->fetch(get_template_path('headers.tpl'));
+  
+  /* I don't know why, but we must use utf8_encode to avoid dispplay errors */
+  $smarty->assign("backward",$back);
+  $smarty->assign("forward" ,$for);
+  $display= utf8_encode(  $header.$smarty->fetch(get_template_path('help.tpl')));
+  echo $display;
 
-  /* Fill page */
+}else{
+  
+  /* There was a file requested which actually doesn't exists */
+  $smarty->assign("help_contents","<h2>".sprintf(_("Helpdir '%s' is not accessible, can't read any helpfiles."),$helpdir))."</h2><br>";
   $header= "<!-- headers.tpl-->".$smarty->fetch(get_template_path('headers.tpl'));
-  $display= $header.$smarty->fetch(get_template_path('help.tpl'));
+  $display= (  $header.$smarty->fetch(get_template_path('help.tpl')));
   echo $display;
 }
-
 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 ?>