ENH: fixed bug #291 Added dynamic help

Author: Charles Ma

core/AppController.php

@@ -174,8 +174,7 @@ public function preDispatch()
 
           $this->view->recentItems = $recentItems;
           $check = $this->_getParam('checkRecentItem');
-          }
-        $user->Dao->lastAction = date('c');
+          }      
         }
       else
         {
@@ -197,9 +196,14 @@ public function preDispatch()
     else
       {
       Zend_Registry::set('userSession', null);
+      $user = null;
       }
 
     $this->view->lang = Zend_Registry::get('configGlobal')->application->lang;
+    
+    $this->view->isStartingGuide = $this->isStartingGuide();
+    $this->view->isDynamicHelp = $this->isDynamicHelp();   
+    
     //create a global javascript json array
     $jsonGlobal = array(
       "webroot" => $this->view->webroot,
@@ -208,6 +212,9 @@ public function preDispatch()
       "needToLog" => false,
       "currentUri" => $this->getRequest()->REQUEST_URI,
       "lang" => Zend_Registry::get('configGlobal')->application->lang,
+      "dynamichelp" => $this->isDynamicHelp(),
+      "dynamichelpAnimate" => $this->isDynamicHelp() && isset($_GET['first']),
+      "startingGuide" => $this->isStartingGuide(),
       "Yes" => $this->t('Yes'),
       "No" => $this->t('No'));
 
@@ -247,8 +254,81 @@ public function preDispatch()
 
     $this->view->json = array(
       "global" => $jsonGlobal, "login" => $login, 'feed' => $feed, "browse" => $browse);
+    
+    // Init Dynamic Help (the order makes sense for the animation)
+    if($this->isDemoMode())
+      {
+      $this->addDynamicHelp('.loginLink', "<b>Authenticate.</b><br/><br/>Demo Administrator:<br/>- Login: admin@kitware.com<br/>- Password: admin<br/><br/>
+                            Demo User:<br/>-Login: user@kitware.com<br/>-Password: useryour information.", 'bottom left', 'top right');
+      }
+    
+    if($this->logged)
+      {
+      $this->addDynamicHelp('#startingGuideLink', 'Show the <b>Starting Guide</b>. You can disable these messages from this panel.');
+      }
+    else
+      {
+      $this->addDynamicHelp('.HeaderLogo', 'The <b>MIDAS Platform</b> integrates multimedia server technology with open-source data analysis and visualization clients.');
+      }
+      
+        
+    $this->addDynamicHelp('.HeaderSearch', '<b>Quick search</b>. Use this tool to quickly find information and data.');
+    $this->addDynamicHelp('li.uploadFile a', '<b>Upload</b> files, data using this button.');
+    
+    if($this->logged)
+      {
+      $this->addDynamicHelp('#topUserName', '<b>Manage</b> your information.', 'bottom left', 'top right');
+      }
+    else
+      {
+      $this->addDynamicHelp('.registerLink', '<b>Register</b> to create your personnal space.', 'bottom left', 'top right');
+      }
+    
+    $this->addDynamicHelp('.SideBar ul:first', '<b>Navigation menu</b>. Browse, explore and manage data.');
+    
     Zend_Loader::loadClass("JsonComponent", BASE_PATH.'/core/controllers/components');
     } // end preDispatch()
+    
+  /** show dynamic help ? */
+  function isDynamicHelp()
+    {
+    if($this->isDemoMode())
+      {
+      return true;
+      }
+    try
+      {
+      $dynamichelp = Zend_Registry::get('configGlobal')->dynamichelp;
+      if($dynamichelp && $this->userSession != null && $this->userSession->Dao != null)
+        {
+        return $this->userSession->Dao->getDynamichelp() == 1;
+        }
+      return $dynamichelp == 1;
+      }
+    catch (Zend_Exception $exc)
+      {
+      $this->getLogger()->warn($exc->getMessage());
+      return false;
+      }
+    }
+    
+  /** show starting guide ? */
+  function isStartingGuide()
+    {
+    try
+      {
+      if($this->userSession != null && $this->userSession->Dao != null && isset($_GET['first']))
+        {
+        return $this->userSession->Dao->getDynamichelp() == 1;
+        }
+      return false;
+      }
+    catch (Zend_Exception $exc)
+      {
+      $this->getLogger()->warn($exc->getMessage());
+      return false;
+      }
+    }
 
   /** get server's url */
   function getServerURL()
@@ -277,6 +357,17 @@ public function isTestingEnv()
     return Zend_Registry::get('configGlobal')->environment == 'testing';
     }
 
+  /** Add a qtip help in the page
+   *
+   * @param type $selector (javascript selector)
+   * @param type $text
+   * @param type $location
+   * @param type $arrow 
+   */
+  public function addDynamicHelp($selector, $text, $location = 'bottom right', $arrow = 'top left')
+    {
+    $this->view->json['dynamicHelp'][] = array('selector' => $selector, 'text' => htmlspecialchars($text) , 'my' => $arrow, 'at' => $location);
+    }
   /** check if demo mode is set */
   public function isDemoMode()
     {

core/configs/application.ini

@@ -27,6 +27,9 @@ processing=onthefly
 defaultlicense=1
 ;Demo Mode (only works with MySql)
 demomode=0
+;Enable Dynamic help
+dynamichelp=1
+
 
 [module]
 

core/controllers/AdminController.php

@@ -98,6 +98,10 @@ function indexAction()
     $formArray['lang']->setValue($applicationConfig['global']['application.lang']);
     $formArray['smartoptimizer']->setValue($applicationConfig['global']['smartoptimizer']);
     $formArray['timezone']->setValue($applicationConfig['global']['default.timezone']);
+    if(isset($applicationConfig['global']['dynamichelp']))
+      {
+      $formArray['dynamichelp']->setValue($applicationConfig['global']['dynamichelp']);
+      }
     $this->view->selectedLicense = $applicationConfig['global']['defaultlicense'];
     $this->view->configForm = $formArray;
 
@@ -125,6 +129,7 @@ function indexAction()
         $applicationConfig['global']['smartoptimizer'] = $this->_getParam('smartoptimizer');
         $applicationConfig['global']['default.timezone'] = $this->_getParam('timezone');
         $applicationConfig['global']['defaultlicense'] = $this->_getParam('licenseSelect');
+        $applicationConfig['global']['dynamichelp'] = $this->_getParam('dynamichelp');
         $this->Component->Utility->createInitFile(BASE_PATH.'/core/configs/application.local.ini', $applicationConfig);
         echo JsonComponent::encode(array(true, 'Changed saved'));
         }

core/controllers/CommunityController.php

@@ -241,6 +241,9 @@ function indexAction()
     $communities = $this->Component->Sortdao->arrayUniqueDao($communities);
 
     $this->view->userCommunities = $communities;
+    
+    $this->addDynamicHelp('.communityList:first', 'List of current projects/communities hosted on MIDAS.', 'top right', 'bottom left');
+    $this->addDynamicHelp('.createCommunity', 'Manage your own community or project.');
     }//end index
 
   /** View a community*/
@@ -319,6 +322,12 @@ function viewAction()
 
     $this->view->customJSs = Zend_Registry::get('notifier')->callback('CALLBACK_CORE_GET_COMMUNITY_VIEW_JSS', array());
     $this->view->customCSSs = Zend_Registry::get('notifier')->callback('CALLBACK_CORE_GET_COMMUNITY_VIEW_CSSS', array());
+    
+    $this->addDynamicHelp('#tabDataLink', 'Public and Private Data hosted by the community.');
+    $this->addDynamicHelp('#tabFeedLink', 'What\'s new?');
+    $this->addDynamicHelp('#tabInfoLink', 'Description of the community.');
+    $this->addDynamicHelp('#tabSharedLink', 'Data shared to the member of the community.');
+    
     } //end index
 
   /** Delete a community*/

core/controllers/FeedController.php

@@ -46,6 +46,8 @@ public function indexAction()
         }
       setcookie('newFeed'.$this->userSession->Dao->getKey(), strtotime("now"), time() + 60 * 60 * 24 * 300, '/'); //30 days
       }
+      
+    $this->addDynamicHelp('.feedContainer', 'The <b>Feed</b> shows recent actions and events.', 'top right', 'bottom left');
     }
 
   /** get delete a feed */

core/controllers/IndexController.php

@@ -35,7 +35,7 @@ function init()
    */
   function indexAction()
     {
-    $this->_forward('index', "feed");
+    $this->_redirect("/feed");
     } // end method indexAction
 
   /** no javascript*/

core/controllers/UserController.php

@@ -138,6 +138,24 @@ function logoutAction()
     $this->_redirect('/');
     } //end logoutAction
 
+  /** Set user's starting guide value */
+  function startingguideAction()
+    {
+    $this->disableLayout();
+    $this->disableView();
+    if($this->logged && isset($_POST['value']))
+      {
+      $value = 0;
+      if($_POST['value'] == 1)
+        {
+        $value = 1;
+        }
+      $this->userSession->Dao->setDynamichelp($value);
+      $user = $this->User->load($this->userSession->Dao->getKey());
+      $user->setDynamichelp($value);
+      $this->User->save($user);
+      }
+    }
 
   /** Register a user */
   function registerAction()
@@ -152,13 +170,14 @@ function registerAction()
 
       $this->userSession->Dao = $this->User->createUser(trim($form->getValue('email')), $form->getValue('password1'), trim($form->getValue('firstname')), trim($form->getValue('lastname')));
 
-      $this->_redirect("/");
+      $this->_redirect("/feed?first=true");
       }
     $this->view->form = $this->getFormAsArray($form);
     $this->disableLayout();
     $this->view->jsonRegister = JsonComponent::encode(array(
       'MessageNotValid' => $this->t('The e-mail is not valid'), 'MessageNotAvailable' => $this->t('This e-mail is not available'), 'MessagePassword' => $this->t('Password too short'), 'MessagePasswords' => $this->t('The passwords are not the same'), 'MessageLastname' => $this->t('Please set your lastname'), 'MessageTerms' => $this->t('Please validate the terms of service'), 'MessageFirstname' => $this->t('Please set your firstname')
     ));
+   
     } //end register
 
   /** Login action */
@@ -230,11 +249,11 @@ function loginAction()
 
       if(isset($previousUri) && strpos($previousUri, $this->view->webroot) !== false && strpos($previousUri, "logout") === false)
         {
-        $this->_redirect(substr($previousUri, strlen($this->view->webroot)));
+        $this->_redirect(substr($previousUri, strlen($this->view->webroot)).'?first=true');
         }
       else
         {
-        $this->_redirect("/");
+        $this->_redirect("/feed?first=true");
         }
       }
     } // end method login

core/controllers/components/DemoComponent.php

@@ -73,6 +73,7 @@ public function reset()
     $applicationConfig = parse_ini_file(BASE_PATH.'/core/configs/application.ini', true);
     $applicationConfig['global']['defaultassetstore.id'] = $assetstoreDao->getKey();
     $applicationConfig['global']['demomode'] = true;
+    $applicationConfig['global']['dynamichelp'] = true;
     $applicationConfig['global']['environment'] = 'development';
     $applicationConfig['global']['application.name'] = 'MIDAS - Demo';
     $applicationConfig['global']['application.description'] = '';

core/controllers/forms/AdminForm.php

@@ -48,12 +48,13 @@ public function createConfigForm()
           ->addValidator('NotEmpty', true);
 
     $smartoptimizer = new Zend_Form_Element_Checkbox("smartoptimizer");
+    $dynamichelp = new Zend_Form_Element_Checkbox("dynamichelp");
 
 
     $submit = new  Zend_Form_Element_Submit('submitConfig');
     $submit ->setLabel('Save configuration');
 
-    $form->addElements(array($keywords, $description, $timezone, $environment, $lang, $name, $smartoptimizer, $submit));
+    $form->addElements(array($dynamichelp, $keywords, $description, $timezone, $environment, $lang, $name, $smartoptimizer, $submit));
     return $form;
     }
 } // end class

core/database/upgrade/3.1.2.php

@@ -0,0 +1,24 @@
+<?php
+
+class Upgrade_3_1_2 extends MIDASUpgrade
+{ 
+  public function preUpgrade()
+    {             
+    }
+    
+  public function mysql()
+    {
+    }
+    
+  public function pgsql()
+    {
+    }
+    
+  public function postUpgrade()
+    {
+    $this->addTableField('user', 'dynamichelp', 'tinyint(4)', ' integer', 1);
+    }
+}
+?>
+
+