very simple dashlet disabling.

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

very simple dashlet disabling.
git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@4396 c91229c3-7414-0410-bfa2-8a42b809f60b
Brad Shuttleworth
1 parent f0c1de40
Showing 7 changed files with 154 additions and 28 deletions
config/tableMappings.inc
lib/dashboard/DashletDisables.inc.php
plugins/ktcore/assistance/KTUserAssistance.php
presentation/lookAndFeel/knowledgeTree/dashboard.php
sql/mysql/install/structure.sql
templates/ktcore/dashlets/admintutorial.smarty
templates/ktcore/dashlets/usertutorial.smarty
@@ -141,4 +141,5 @@ $default-&gt;permission_dynamic_conditions_table = &#39;permission_dynamic_conditions&#39;;
 $default->permission_dynamic_assignments_table = 'permission_dynamic_assignments';
 $default->notifications_table = "notifications";
 $default->authentication_sources_table = "authentication_sources";
+$default->dashlet_disable_table = "dashlet_disables";
 ?>
+<?php
+
+require_once(KT_LIB_DIR . "/ktentity.inc");
+
+/** a _disable_ flag for a particular dashlet, and a particular user.
+
+ shouldn't use an enable flag, since the target user is transient and
+ may need to know about the item on creation, not on dashlet registration.
+ 
+*/
+
+
+class KTDashletDisable extends KTEntity {
+        
+    /** primary key value */
+    var $iId = -1;
+    var $iUserId;
+    var $sNamespace;
+
+    var $_bUsePearError = true;
+        
+    function getId() { return $this->iId; }
+    function getUserId() { return $this->iUserId; }
+    function setUserId($iNewValue) { $this->iUserId = $iNewValue; }
+    function getNamespace() { return $this->sNamespace; }
+    function setNamespace($sNewValue) {	$this->sNamespace = $sNewValue; }
+
+    var $_aFieldToSelect = array(
+        "iId" => "id",
+        "iUserId" => "user_id",
+        "sNamespace" => "dashlet_namespace",
+    );
+        
+    function _table () {
+        return KTUtil::getTableName('dashlet_disable');
+    }
+
+    // Static function
+    function &get($iId) { return KTEntityUtil::get('KTDashletDisable', $iId); }
+    function &getList($sWhereClause = null) { return KTEntityUtil::getList2('KTDashletDisable', $sWhereClause);	}	
+    function &createFromArray($aOptions) { return KTEntityUtil::createFromArray('KTDashletDisable', $aOptions); }
+
+    function &getForUserAndDashlet($iUserId, $sNamespace) {
+        $sWhereClause = 'WHERE user_id = ? AND dashlet_namespace = ?';
+        $aParams = array($iUserId, $sNamespace);
+        
+        return KTDashletDisable::getList(array($sWhereClause, $aParams));
+    }
+}
+
+?>
 \ No newline at end of file
@@ -5,6 +5,7 @@
 require_once(KT_LIB_DIR . '/plugins/pluginregistry.inc.php');
 require_once(KT_LIB_DIR . '/plugins/plugin.inc.php');
 require_once(KT_LIB_DIR . '/dashboard/dashlet.inc.php');
+require_once(KT_LIB_DIR . '/dashboard/DashletDisables.inc.php');
 require_once(KT_LIB_DIR . "/templating/templating.inc.php");
 require_once(KT_LIB_DIR . "/dashboard/Notification.inc.php");
 require_once(KT_LIB_DIR . "/security/Permission.inc");
@@ -25,10 +26,17 @@ $oRegistry-&gt;registerPlugin(&#39;KTUserAssistance&#39;, &#39;ktcore.userassistance&#39;, __FILE__
 $oPlugin =& $oRegistry->getPlugin('ktcore.userassistance');
 // ultra simple skeleton for the user tutorial
+// FIXME do we want to store the namespace inside the dashlet?
 class KTUserTutorialDashlet extends KTBaseDashlet {
 	function is_active($oUser) {
-	    // FIXME check if the user has "turned this off" for themselves.
-		return true;
+	    $namespace = 'ktcore.dashlet.usertutorial';
+		$disables = KTDashletDisable::getForUserAndDashlet($oUser->getId(), $namespace);
+		
+		if (!empty($disables)) { 
+		    return false;
+		} else {
+		    return true;
+		}
 	}
     function render() {
@@ -45,9 +53,19 @@ $oPlugin-&gt;registerDashlet(&#39;KTUserTutorialDashlet&#39;, &#39;ktcore.dashlet.usertutorial&#39;
 // ultra simple skeleton for the admin tutorial
 class KTAdminTutorialDashlet extends KTBaseDashlet {
 	function is_active($oUser) {
-	    // FIXME check if the user has "turned this off" for themselves.
-		return Permission::userIsSystemAdministrator($oUser->getId());
-		return true;
+	 
+	    $namespace = 'ktcore.dashlet.admintutorial';
+
+		if (!Permission::userIsSystemAdministrator($oUser->getId())) {
+		    return false; // quickest disable.
+		}
+		
+		$disables = KTDashletDisable::getForUserAndDashlet($oUser->getId(), $namespace);		
+		if (!empty($disables)) { 
+		    return false;
+		} else {
+		    return true;
+		}
 	}
     function render() {
@@ -78,6 +96,8 @@ class KTUserAssistBasePage extends KTStandardDispatcher {
 		$this->oPage->setShowPortlets(false);
 		return $contents;
 	}
+	
+	// hide the dashlet from the user (e.g. don't show it again) and redirect back to the dashboard.
 }
 class KTUserAssistB1WhatIs extends KTUserAssistBasePage { var $pagefile = 'kt3b1-what-is-a-beta'; var $title = 'What is a Beta?'; }
@@ -37,11 +37,13 @@ require_once(KT_LIB_DIR . &quot;/templating/templating.inc.php&quot;);
 require_once(KT_LIB_DIR . "/templating/kt3template.inc.php");
 require_once(KT_LIB_DIR . "/dispatcher.inc.php");
+require_once(KT_LIB_DIR . "/dashboard/DashletDisables.inc.php");
+
 $sectionName = "dashboard";
 class DashboardDispatcher extends KTStandardDispatcher {
-	
-	var $notifications = array();
+    
+    var $notifications = array();
     function DashboardDispatcher() {
         $this->aBreadcrumbs = array(
@@ -50,26 +52,50 @@ class DashboardDispatcher extends KTStandardDispatcher {
         return parent::KTStandardDispatcher();
     }
     function do_main() {
-	    $this->oPage->setShowPortlets(false);
-		// retrieve action items for the user.
-		// FIXME what is the userid?
-		
-		
-		$oDashletRegistry =& KTDashletRegistry::getSingleton();
-		$aDashlets = $oDashletRegistry->getDashlets($this->oUser);
-		
-		$this->sSection = "dashboard";
-		$this->oPage->setBreadcrumbDetails(_("Home"));
-		$this->oPage->title = _("Dashboard");
-	
-		$oTemplating = new KTTemplating;
-		$oTemplate = $oTemplating->loadTemplate("kt3/dashboard");
-		$aTemplateData = array(
+        $this->oPage->setShowPortlets(false);
+        // retrieve action items for the user.
+        // FIXME what is the userid?
+        
+        
+        $oDashletRegistry =& KTDashletRegistry::getSingleton();
+        $aDashlets = $oDashletRegistry->getDashlets($this->oUser);
+        
+        $this->sSection = "dashboard";
+        $this->oPage->setBreadcrumbDetails(_("Home"));
+        $this->oPage->title = _("Dashboard");
+    
+        $oTemplating = new KTTemplating;
+        $oTemplate = $oTemplating->loadTemplate("kt3/dashboard");
+        $aTemplateData = array(
               "context" => $this,
-			  "dashlets" => $aDashlets,
-		);
-		return $oTemplate->render($aTemplateData);
-	}   
+              "dashlets" => $aDashlets,
+        );
+        return $oTemplate->render($aTemplateData);
+    }
+    
+    // disable a dashlet.  
+    // FIXME this very slightly violates the separation of concerns, but its not that flagrant.
+    function do_disableDashlet() {
+        $sNamespace = KTUtil::arrayGet($_REQUEST, 'fNamespace');
+        $iUserId = $this->oUser->getId();
+        
+        if (empty($sNamespace)) {
+            $this->errorRedirectToMain('No dashlet specified.');
+            exit(0);
+        }
+    
+        // do the "delete"
+        
+        $this->startTransaction();
+        $aParams = array('sNamespace' => $sNamespace, 'iUserId' => $iUserId);
+        $oDD = KTDashletDisable::createFromArray($aParams);
+        if (PEAR::isError($oDD)) {
+            $this->errorRedirectToMain('Failed to disable the dashlet.');
+        }
+    
+        $this->commitTransaction();
+        $this->successRedirectToMain('Dashlet disabled.');
+    }
 }
 $oDispatcher = new DashboardDispatcher();
@@ -118,6 +118,22 @@ CREATE TABLE `data_types` (
 -- --------------------------------------------------------
 -- 
+-- Table structure for table `dashlet_disables`
+-- 
+
+CREATE TABLE `dashlet_disables` (
+  `id` int(11) NOT NULL default '0',
+  `user_id` int(11) NOT NULL default '',
+  `dashlet_namespace` varchar(255) NOT NULL default '',
+  UNIQUE KEY `id` (`id`),
+  INDEX (`user_id`),
+  INDEX (`dashlet_namespace`)
+) ENGINE=InnoDB ;
+
+-- --------------------------------------------------------
+
+
+-- 
 -- Table structure for table `dependant_document_instance`
 -- 
@@ -2084,6 +2100,18 @@ CREATE TABLE `zseq_workflows` (
   PRIMARY KEY  (`id`)
 ) ENGINE=MyISAM ;
+
+-- --------------------------------------------------------
+
+-- 
+-- Table structure for table `zseq_dashlet_disables`
+-- 
+
+CREATE TABLE `zseq_dashlet_disables` (
+  `id` int(10) unsigned NOT NULL auto_increment,
+  PRIMARY KEY  (`id`)
+) ENGINE=MyISAM ;
+
 -- 
 -- Constraints for dumped tables
 -- 
@@ -9,4 +9,4 @@ which might help you get to grips with the new system.{/i18n}&lt;/p&gt;
 href="{$rootUrl}/plugin.php/ktcore.userassistance/admin-quickguide">{i18n}Read the admin introduction.{/i18n}</a> |
 <a
 href="{$rootUrl}/plugin.php/ktcore.userassistance/admin-guide-whats-new-in-kt3">{i18n}Find out what's different in <strong>KT 3</strong>.{/i18n}</a> |
-<a href="#">{i18n}Don't show me this again.{/i18n}</a>
+<a href="?action=disableDashlet&fNamespace=ktcore.dashlet.admintutorial">{i18n}Don't show me this again.{/i18n}</a>
@@ -6,4 +6,4 @@ KnowledgeTree&amp;trade; 3?  We&#39;ve written some quick documentation{/i18n}&lt;/p&gt;
 <a href="#">Take the crash course.</a> |
 <a href="#">Learn about KnowledgeTree 3.</a> |
-<a href="#">Don't show me this again.</a>
+<a href="?action=disableDashlet&fNamespace=ktcore.dashlet.usertutorial">{i18n}Don't show me this again.{/i18n}</a>