Changeset 4361 in subversion

Timestamp:

Dec 22, 2010 1:25:02 PM (2 years ago)

Author:

thomasb

Message:

Add basic error reporting to rcube_addressbook; make warnings and errors appear longer in UI

Location:

branches/devel-addressbook/program

Files:

• include/rcube_addressbook.php (modified) (3 diffs)
• include/rcube_ldap.php (modified) (6 diffs)
• js/app.js (modified) (1 diff)
• steps/addressbook/save.inc (modified) (2 diffs)

branches/devel-addressbook/program/include/rcube_addressbook.php

@@ -28 +28 @@
 abstract class rcube_addressbook
 {
+    /** constants for error reporting **/
+    const ERROR_READ_ONLY = 1;
+    const ERROR_NO_CONNECTION = 2;
+    const ERROR_INCOMPLETE = 3;
+    const ERROR_SAVING = 4;
+    
     /** public properties (mandatory) */
     public $primary_key;
@@ -36 +42 @@
     public $page_size = 10;
     public $coltypes = array('name' => array('limit'=>1), 'firstname' => array('limit'=>1), 'surname' => array('limit'=>1), 'email' => array('limit'=>1));
+    
+    protected $error;
 
     /**
@@ -100 +108 @@
      */
     abstract function get_record($id, $assoc=false);
+
+    /**
+     * Returns the last error occured (e.g. when updating/inserting failed)
+     *
+     * @return array Hash array with the following fields: type, message
+     */
+    function get_error()
+    {
+      return $this->error;
+    }
+    
+    /**
+     * Setter for errors for internal use
+     *
+     * @param int Error type (one of this class' error constants)
+     * @param string Error message (name of a text label)
+     */
+    protected function set_error($type, $message)
+    {
+      $this->error = array('type' => $type, 'message' => $message);
+    }
 
     /**

branches/devel-addressbook/program/include/rcube_ldap.php

@@ -27 +27 @@
 class rcube_ldap extends rcube_addressbook
 {
-  var $conn;
-  var $prop = array();
-  var $fieldmap = array();
-
-  var $filter = '';
-  var $result = null;
-  var $ldap_result = null;
-  var $sort_col = '';
-  var $mail_domain = '';
-  var $debug = false;
+  protected $conn;
+  protected $prop = array();
+  protected $fieldmap = array();
+
+  protected $filter = '';
+  protected $result = null;
+  protected $ldap_result = null;
+  protected $sort_col = '';
+  protected $mail_domain = '';
+  protected $debug = false;
 
   /** public properties */
-  var $primary_key = 'ID';
-  var $readonly = true;
-  var $list_page = 1;
-  var $page_size = 10;
-  var $ready = false;
-  var $coltypes = array();
+  public $primary_key = 'ID';
+  public $readonly = true;
+  public $list_page = 1;
+  public $page_size = 10;
+  public $ready = false;
+  public $coltypes = array();
 
 
@@ -524 +524 @@
     // Verify that the required fields are set.
     foreach ($this->prop['required_fields'] as $fld) {
-      $complete = true;
+      $missing = null;
       if (!isset($newentry[$fld])) {
-        $complete = true;
-      } // end if
-    } // end foreach
+        $missing[] = $fld;
+      }
+    }
     
     // abort process if requiered fields are missing
-    if (!$complete)
+    // TODO: generate message saying which fields are missing
+    if ($missing) {
+      $this->set_error(self::ERROR_INCOMPLETE, 'formincomplete');
       return false;
+    }
 
     // Build the new entries DN.
@@ -542 +545 @@
     if ($res === FALSE) {
       $this->_debug("S: ".ldap_error($this->conn));
+      $this->set_error(self::ERROR_SAVING, 'errorsaving');
       return false;
     } // end if
@@ -600 +604 @@
       if (!ldap_mod_del($this->conn, $dn, $deletedata)) {
         $this->_debug("S: ".ldap_error($this->conn));
+        $this->set_error(self::ERROR_SAVING, 'errorsaving');
         return false;
       }
@@ -633 +638 @@
       if (!ldap_mod_add($this->conn, $dn, $newdata)) {
         $this->_debug("S: ".ldap_error($this->conn));
+        $this->set_error(self::ERROR_SAVING, 'errorsaving');
         return false;
       }
@@ -672 +678 @@
       if ($res === FALSE) {
         $this->_debug("S: ".ldap_error($this->conn));
+        $this->set_error(self::ERROR_SAVING, 'errorsaving');
         return false;
       } // end if

branches/devel-addressbook/program/js/app.js

@@ -4805 +4805 @@
     else {
       obj.appendTo(cont).bind('mousedown', function(){ return ref.hide_message(obj); });
-      window.setTimeout(function(){ ref.hide_message(obj, true); }, this.message_time);
+      window.setTimeout(function(){ ref.hide_message(obj, true); }, this.message_time * (type == 'warning' || type == 'error' ? 2 : 1));
       return obj;
     }

branches/devel-addressbook/program/steps/addressbook/save.inc

@@ -207 +207 @@
   else {
     // show error message
-    $OUTPUT->show_message($plugin['message'] ? $plugin['message'] : 'errorsaving', 'error', null, false);
+    $err = $CONTACTS->get_error();
+    $OUTPUT->show_message($plugin['message'] ? $plugin['message'] : ($err['message'] ? $err['message'] : 'errorsaving'), 'error', null, false);
     rcmail_overwrite_action('show');
   }
@@ -259 +260 @@
   else {
     // show error message
-    $OUTPUT->show_message($plugin['message'] ? $plugin['message'] : 'errorsaving', 'error', null, false);
+    $err = $CONTACTS->get_error();
+    $OUTPUT->show_message($plugin['message'] ? $plugin['message'] : ($err['message'] ? $err['message'] : 'errorsaving'), 'error', null, false);
     rcmail_overwrite_action('add');
   }