![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/html/helpviewer.php b/html/helpviewer.php
index 308500d0aa1da9fe7d56d1980ffc71a401a197a9..a5710b20257a77fb3f65f78b4d7ffdb6b3dd458d 100644 (file)
--- a/html/helpviewer.php
+++ b/html/helpviewer.php
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 ("functions.inc");
-require_once ("functions_helpviewer.inc");
+error_reporting(0);
header("Content-type: text/html; charset=UTF-8");
+session_start();
+$config= $_SESSION['config'];
-session_start ();
-error_reporting(E_ALL);
+/* 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 */
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");
-
-/* 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;
-}
-
-/* Set template compile directory */
$config= $_SESSION['config'];
if (isset ($config->data['MAIN']['COMPILE'])){
$smarty->compile_dir= $config->data['MAIN']['COMPILE'];
$smarty->compile_dir= '/var/spool/gosa/';
}
-/* Get plugin list */
-$plist= $_SESSION['plist'];
-
-/*
-##################
-My PART ^^
-##################
+/* HELP management starts here ...
*/
-$helpdir = HELP_BASEDIR."/en/manual_gosa_en/"; // Folder to use for help files
+/* 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();
+}
+
+$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 > ...
-$pre_mark = "<span style=\"background-color: #FFFC35;\">" ; // Sign words with this
-$suf_mark = "</span>"; // and this
-$backwardlink = "<a href=\"?pg=%s\" class=\"maintitlebar\">
- <img src='images/back.png' align=\"middle\" alt=\""._("previous")."\" border=\"0\">
- </a>";
-
-$forwardlink = "<a href=\"?pg=%s\" class=\"maintitlebar\">
- <img src='images/forward.png' align=\"middle\" alt=\""._("next")."\" border=\"0\">
- </a>";
-
-/* Define which tags musst be delete, header, navigation, banner */
-$replacements=array();
-$replacements['from']=array("@<!DOC.*<BODY >@si",
- "/border=\".*\"/i",
- "'<code.*code>'",
-// "/alt=\".*\"/i",
- "/<HR>/",
- "@<ADDRESS[^>]*?>.*?ADDRESS>@si",
- "@<\/BODY[^>]*?>.*?HTML>@si",
- "'<TABLE.*>'",
- "/src.*icons/i",
- "/src=\"/i",
- "/<H1 ALIGN=\"CENTER\">/",
- /* picture replacements */
- // "",
- );
-
-
-$replacements['to']=array("",
- " border=\"0\" ",
- "",
- // "",
- "",
- "",
- "",
- "<table border=1 cellspacing=0 bgcolor=\"#E0E0E0\" width=\"95%\" align=\"center\" cellpadding=\"3\" summary=\"\">",
- "src=\"",
- "src=\"images/",
- "<H1>",
- /* picture replacements */
-// "",
- );
-
/* 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.
*/
+if(isset($_SESSION['current_class_for_help'])){
-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","<br>".sprintf(_("Can't read any helpfiles from ' %s ', possibly there is no help available."),HELP_BASEDIR."/en/manual_gosa_en/"));
-
- /* Output html ...*/
- $header= "<!-- headers.tpl-->".$smarty->fetch(get_template_path('headers.tpl'));
- $display= $header.$smarty->fetch(get_template_path('help.tpl'));
- echo $display;
-
-}else{
-
- /* 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","");
- $smarty->assign("index" ,$index);
- $smarty->assign("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));
+ /* Create new XML parser with the path to the Xml file */
+ $xml = new parseXml("../doc/guide.xml");
+
+ /* Generate help array */
+ $str = $xml->parse();
- /* show some errors */
- if (isset($_SESSION['errors'])){
- $smarty->assign("errors", $_SESSION['errors']);
- }
- if ($error_collector != ""){
- $smarty->assign("php_errors", $error_collector."</div>");
- } else {
- $smarty->assign("php_errors", "");
- }
+ /* __LANG__ is used as placeholder for the used language*/
+ $helpdir= preg_replace("/__LANG__/i",$lang,$str[($_SESSION['current_class_for_help'])]['PATH']);
- /* Output html ...*/
+ /* 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'));
+ $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']);
+ }
- /*
- Don't search, only show selected page
- */
+}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'];
- /* present last searched word(s)*/
- if(!isset($_SESSION['search_string'])){
- $_SESSION['search_string']="";
- }
-
- $smarty->assign("search_string",$_SESSION['search_string']);
-
- /* Read all files, prepare to serach */
- $helppages = readfiles($helpdir,$prefix,$suffix,true);
-
- /* Get transmitted page */
- if(isset($_GET['pg'])){
- $page = $_GET['pg'];
- }else{
- $page = $defaultpage;
- }
-
- /* 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 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']);
- /* Check forward backward, funtionality*/
- if($page != $defaultpage)
- {
- /* Extract Number of node page */
- $number = str_replace($prefix,"",str_replace($suffix,"",$page));
+ /* If helpdir is empty, force index */
+ if(empty($helpobject['currentplug'])){
+ $helpdir= "";
+ }
+ }
+}
- /* Check if we can switch forward and/or backward*/
- $bck = $prefix.($number-1).$suffix;
- $fck = $prefix.($number+1).$suffix;
+$helpdir.="/";
- /* backward page exists ?, so allow it*/
- if((isset($helppages[$bck]))) {
- $backward = $bck;
- }
+/* Save current settings */
+$_SESSION['helpobject'] = $helpobject;
- $forward = $fck;
- }
+/*
+ * Display management
+ */
- $help_contents=readfiles($helpdir,$prefix,$suffix,false,$page);
+/* 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'));
- /* 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'];
- }
+ /* 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'));
- $smarty->assign("help_contents",$help_contents);
+ /* 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;
- /* Define our own navigation pages */
- if($page == $defaultpage){
- $smarty->assign("backward","");
- }else{
- $smarty->assign("backward",sprintf($backwardlink,$backward));
- }
- $smarty->assign("index" ,$index);
+}elseif((is_dir($helpdir))&&($fp = opendir($helpdir))){
- if(!(isset($helppages[$forward]))){
- $smarty->assign("forward","");
- }else{
- $smarty->assign("forward",sprintf($forwardlink,$forward));
- }
+ /* Readfile gets the content of the requested file,
+ * parse it, rework links images and so on */
+ $index = readfiles($helpdir,$prefix,$suffix,false,$helpobject['file']);
+
+ /* 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);
+ }
- /* show some errors */
- if (isset($_SESSION['errors'])){
- $smarty->assign("errors", $_SESSION['errors']);
- }
- if ($error_collector != ""){
- $smarty->assign("php_errors", $error_collector."</div>");
- } else {
- $smarty->assign("php_errors", "");
- }
+ /* 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 */
+ $display= utf8_encode( $header.$smarty->fetch(get_template_path('help.tpl')));
+ echo $display;
- /* Fill page */
- $header= "<!-- headers.tpl-->".$smarty->fetch(get_template_path('headers.tpl'));
- $display= $header.$smarty->fetch(get_template_path('help.tpl'));
- echo $display;
- }
+}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')));
+ echo $display;
}
// vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
?>