Allow help files to be edited via the admin interface and saved into the

database. git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@3457 c91229c3-7414-0410-bfa2-8a42b809f60b

Allow help files to be edited via the admin interface and saved into the
database. git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@3457 c91229c3-7414-0410-bfa2-8a42b809f60b
Neil Blakey-Milner
1 parent 4a79c7da
Showing 8 changed files with 257 additions and 12 deletions
config/siteMap.inc
config/tableMappings.inc
lib/help/help.inc.php
lib/help/helpreplacement.inc.php
presentation/lookAndFeel/knowledgeTree/administration/help/manageHelp.php
presentation/lookAndFeel/knowledgeTree/help.php
templates/ktcore/manage_help.smarty
templates/ktcore/manage_help_item.smarty
@@ -134,6 +134,8 @@ $default-&gt;siteMap-&gt;addPage(&quot;browseAdministration&quot;, &quot;/presentation/lookAndFeel/kn
 $default->siteMap->addPage("docLinkManagement", "/presentation/lookAndFeel/knowledgeTree/administration/doclinkmanagement/listLinkTypesBL.php", "Administration", SysAdmin, _("Link Type Management"), true, 16);
+$default->siteMap->addPage("helpAdmin", "/presentation/lookAndFeel/knowledgeTree/administration/help/manageHelp.php", "Administration", SysAdmin, _("Help Administration"), true, 17);
+
 $default->siteMap->addSectionColour("Administration", "th", "056DCE");
 $default->siteMap->addSectionColour("Administration", "td", "6699FF");
@@ -113,4 +113,5 @@ $default-&gt;status_table = &quot;status_lookup&quot;;
 $default->search_permissions_table = "search_document_user_link";
 $default->document_link_types_table = "document_link_types";
 $default->upgrades_table = "upgrades";
+$default->help_replacement_table = "help_replacement";
 ?>
+<?php
+
+class KTHelp {
+    function getHelpStringForSection($sSection) {
+        global $default;
+        $sQuery = "SELECT hlp.help_info AS helpinfo FROM
+            $default->help_table AS hlp WHERE hlp.fSection = ?";
+        $aParams = array($sSection);
+        $sHelpFile = DBUtil::getOneResultKey(array($sQuery, $aParams), 'helpinfo');
+        if (PEAR::isError($sHelpFile)) {
+            return $sHelpFile;
+        }
+        $sQuery = "SELECT hlprp.description AS contents FROM
+            $default->help_replacement_table AS hlprp WHERE
+            hlprp.name = ?";
+        $aParams = array($sHelpFile);
+        $sHelpContents = DBUtil::getOneResultKey(array($sQuery,
+                    $aParams), 'contents');
+        if (PEAR::isError($sHelpContents)) {
+            return $sHelpContents;
+        }
+        if (!(is_null($sHelpContents) || trim($sHelpContents) === "")) {
+            return $sHelpContents;
+        }
+        return file_get_contents("$default->uiDirectory/help/" .  $sHelpFile);
+    }
+}
+
+?>
+<?php
+
+require_once(KT_LIB_DIR . "/ktentity.inc");
+
+class KTHelpReplacement extends KTEntity {
+    /** primary key */
+    var $iId = -1;
+    /** help file name */
+    var $sName;
+    /** replacement string */
+    var $sDescription;
+
+    var $_aFieldToSelect = array(
+        "iId" => "id",
+        "sName" => "name",
+        "sDescription" => "description",
+    );
+
+    var $_bUsePearError = true;
+
+    function getID() { return $this->iId; }
+    function getName() { return $this->sName; }
+    function getDescription() { return $this->sDescription; }
+    function setID($iId) { $this->iId = $iId; }
+    function setName($sName) { $this->sName = $sName; }
+    function setDescription($sDescription) { $this->sDescription = $sDescription; }
+
+    function _table () {
+        global $default;
+        return $default->help_replacement_table;
+    }
+
+    // STATIC
+    function &get($iId) {
+        return KTEntityUtil::get('KTHelpReplacement', $iId);
+    }
+
+    // STATIC
+    function &createFromArray($aOptions) {
+        return KTEntityUtil::createFromArray('KTHelpReplacement', $aOptions);
+    }
+
+    function &getList($sWhereClause = null) {
+        global $default;
+        return KTEntityUtil::getList($default->help_replacement_table, 'KTHelpReplacement', $sWhereClause);
+    }
+}
+
+?>
+<?php
+require_once("../../../../../config/dmsDefaults.php");
+
+require_once(KT_DIR . "/presentation/Html.inc");
+
+require_once(KT_LIB_DIR . "/templating/templating.inc.php");
+require_once(KT_LIB_DIR . "/help/helpreplacement.inc.php");
+require_once(KT_LIB_DIR . "/help/help.inc.php");
+
+// require_once(KT_DIR . "/FCKeditor/fckeditor.php");
+
+function getItemData($iId) {
+    $oTemplating = new KTTemplating;
+    $oHelp =& KTHelpReplacement::get($iId);
+    if (PEAR::isError($oHelp)) {
+        $_SESSION['KTErrorMessage'][] = "Help for that item not found";
+        exit(controllerRedirect('helpAdmin'));
+    }
+
+    // $oEditor = new FCKEditor("description");
+    // $oEditor->Value = $oHelp->getDescription();
+    // $oEditor->Height = 400;
+
+    $oTemplate = $oTemplating->loadTemplate("ktcore/manage_help_item");
+    $aTemplateData = array(
+        "help" => $oHelp,
+        // "fck" => $oEditor,
+    );
+    return $oTemplate->render($aTemplateData);
+}
+
+function getData() {
+    $oTemplating = new KTTemplating;
+    $aHelps = KTHelpReplacement::getList();
+    $oTemplate = $oTemplating->loadTemplate("ktcore/manage_help");
+    $aTemplateData = array(
+        "helps" => $aHelps,
+    );
+
+    return $oTemplate->render($aTemplateData);
+}
+
+$id = KTUtil::arrayGet($_REQUEST, 'id');
+if ($id) {
+    $action = KTUtil::arrayGet($_REQUEST, 'action');
+    if ($action === "update") {
+        $oHelp =& KTHelpReplacement::get($id);
+        if (PEAR::isError($oHelp)) {
+            $_SESSION['KTErrorMessage'][] = "Help for that item not found";
+            exit(controllerRedirect('helpAdmin'));
+        }
+        $description = KTUtil::arrayGet($_REQUEST, 'description');
+        if ($description) {
+            $oHelp->setDescription($description);
+            $res = $oHelp->update();
+            if (PEAR::isError($res)) {
+                $_SESSION['KTErrorMessage'][] = "Error updating
+                    object";
+                $data = getItemData($id);
+            } else {
+                $_SESSION['KTErrorMessage'][] = "Updated";
+                exit(controllerRedirect('helpAdmin'));
+            }
+        } else {
+            $_SESSION['KTErrorMessage'][] = "No description given";
+            var_dump($_REQUEST);
+            exit(0);
+            $data = getItemData($id);
+        }
+    } else {
+        $data = getItemData($id);
+    }
+} else {
+    $data = getData();
+}
+
+$sectionName = "Administration";
+
+require_once(KT_DIR . "/presentation/webpageTemplate.inc");
+$main->bFormDisabled = true;
+$main->setCentralPayload($data);
+$main->render();
+
+?>
@@ -40,16 +40,6 @@ $headingBar .= &quot;\t&lt;/tr&gt;\n&quot;;
 $headingBar .= "</table>\n";
 echo $headingBar;
-//Query the database for the helpURL based on the current action
-/*ok*/ $sQuery = array("SELECT HLP.help_info as helpinfo ".
-		"FROM $default->help_table AS HLP WHERE HLP.fSection = ?", $_REQUEST['fAction']);
-		
-$sql = $default->db;
-$sql->query($sQuery);
-
-if ($sql->next_record()) {
-	require_once("$default->uiDirectory/help/" . $sql->f("helpinfo"));
-} else {
-	echo "No help available for " . $_REQUEST['fAction'];
-}
+require_once(KT_LIB_DIR . '/help/help.inc.php');
+print KTHelp::getHelpStringForSection($_REQUEST['fAction']);
 ?>
+<h2>Existing permissions</h2>
+
+{literal}
+<style>
+table.pretty {
+    margin: 0;
+    padding: 0;
+    border: 0;
+    border-top: 1px solid #cccccc;
+    border-left: 1px solid #cccccc;
+}
+
+table.pretty > thead > tr {
+    border: 0;
+    margin: 0;
+    padding: 0;
+    background-color: #feeeee;
+}
+
+table.pretty > thead > tr > th {
+    border-right: 1px solid #cccccc;
+    border-bottom: 2px solid #000000;
+    border-left: 0;
+    border-right: 0;
+    padding-left: 5px;
+    padding-right: 5px;
+    padding-top: 2px;
+    padding-bottom: 2px;
+}
+
+table.pretty > tbody > tr {
+    border: 0;
+    margin: 0;
+    padding: 0;
+    background-color: #eeeefe;
+}
+
+table.pretty > tbody > tr.odd {
+    background-color: #eeeefe;
+}
+table.pretty > tbody > tr.odd {
+    background-color: #fafafe;
+}
+
+table.pretty > tbody > tr > td {
+    border: 0;
+    border-right: 1px solid #cccccc;
+    border-bottom: 1px solid #cccccc;
+    margin: 0;
+    padding-top: 2px;
+    padding-bottom: 2px;
+    padding-left: 3px;
+    padding-right: 3px;
+}
+
+
+</style>
+{/literal}
+
+<table class="pretty" cellspacing="0" cellpadding="0" border="0">
+<thead>
+<tr>
+<th>Name</th>
+</tr>
+</thead>
+{ foreach item=oHelpReplacement from=$helps }
+<tr class="{cycle values="odd,even"}">
+<td>
+<a href="{$smarty.server.PHP_SELF}?id={$oHelpReplacement->iId}">{ $oHelpReplacement->sName }</a>
+</td>
+</tr>
+{ /foreach }
+</table>
+
+<script language="javascript" type="text/javascript" src="/tinymce/jscripts/tiny_mce/tiny_mce.js"></script>
+<script language="javascript" type="text/javascript">
+{literal}
+tinyMCE.init({
+		mode : "textareas",
+		theme : "simple",
+});
+{/literal}
+</script>
+
+<form method="POST" action="{$smarty.server.PHP_SELF}">
+<input type="hidden" name="id" value="{$help->iId}">
+<input type="hidden" name="action" value="update">
+<textarea cols="60" rows="20" name="description">{$help->sDescription|escape}</textarea>
+<input type="submit" name="submit" value="Update">
+</form>