Style police.

functions/abook_database.php

@@ -1,4 +1,4 @@
-<?php {
+<?php
    
 /**
  * abook_database.php
@@ -30,118 +30,114 @@
  * $Id$
  */
    
-/*****************************************************************/
-/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!!           ***/
-/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION.             ***/
-/***    + Base level indent should begin at left margin, as    ***/
-/***      the require_once below looks.                        ***/
-/***    + All identation should consist of four space blocks   ***/
-/***    + Tab characters are evil.                             ***/
-/***    + all comments should use "slash-star ... star-slash"  ***/
-/***      style -- no pound characters, no slash-slash style   ***/
-/***    + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD      ***/
-/***      ALWAYS USE { AND } CHARACTERS!!!                     ***/
-/***    + Please use ' instead of ", when possible. Note "     ***/
-/***      should always be used in _( ) function calls.        ***/
-/*** Thank you for your help making the SM code more readable. ***/
-/*****************************************************************/
-
 require_once('DB.php');
    
-   class abook_database extends addressbook_backend {
-      var $btype = 'local';
-      var $bname = 'database';
+class abook_database extends addressbook_backend {
+    var $btype = 'local';
+    var $bname = 'database';
       
-      var $dsn       = '';
-      var $table     = '';
-      var $owner     = '';
-      var $dbh       = false;
+    var $dsn       = '';
+    var $table     = '';
+    var $owner     = '';
+    var $dbh       = false;
       
-      var $writeable = true;
+    var $writeable = true;
       
-      // ========================== Private =======================
+    /* ========================== Private ======================= */
       
-      // Constructor
-      function abook_database($param) {
-         $this->sname = _("Personal address book");
+    /* Constructor */
+    function abook_database($param) {
+        $this->sname = _("Personal address book");
          
-         if(is_array($param)) {
-            if(empty($param['dsn']) || 
-               empty($param['table']) || 
-               empty($param['owner']))
-               return $this->set_error('Invalid parameters');
+        if (is_array($param)) {
+            if (empty($param['dsn']) || 
+                empty($param['table']) || 
+                empty($param['owner'])) {
+                return $this->set_error('Invalid parameters');
+            }
             
             $this->dsn   = $param['dsn'];
             $this->table = $param['table'];
             $this->owner = $param['owner'];
             
-            if(!empty($param['name']))
+            if (!empty($param['name'])) {
                $this->sname = $param['name'];
+            }
 
-            if(isset($param['writeable']))
+            if (isset($param['writeable'])) {
                $this->writeable = $param['writeable'];
+            }
 
             $this->open(true);
-         } else {
+        }
+        else {
             return $this->set_error('Invalid argument to constructor');
-         }
-      }
+        }
+    }
       
       
-      // Open the database. New connection if $new is true
-      function open($new = false) {
-         $this->error = '';
+    /* Open the database. New connection if $new is true */
+    function open($new = false) {
+        $this->error = '';
          
-         // Return true is file is open and $new is unset
-         if($this->dbh && !$new)
+        /* Return true is file is open and $new is unset */
+        if ($this->dbh && !$new) {
             return true;
+        }
          
-         // Close old file, if any
-         if($this->dbh) $this->close();
+        /* Close old file, if any */
+        if ($this->dbh) {
+            $this->close();
+        }
          
-         $dbh = DB::connect($this->dsn, true);
+        $dbh = DB::connect($this->dsn, true);
          
-         if(DB::isError($dbh) || DB::isWarning($dbh)) 
+        if (DB::isError($dbh) || DB::isWarning($dbh)) {
             return $this->set_error(sprintf(_("Database error: %s"),
                                             DB::errorMessage($dbh)));
+        }
          
-         $this->dbh = $dbh;
-         return true;
-      }
+        $this->dbh = $dbh;
+        return true;
+    }
 
-      // Close the file and forget the filehandle
-      function close() {
-         $this->dbh->disconnect();
-         $this->dbh = false;
-      }
+    /* Close the file and forget the filehandle */
+    function close() {
+        $this->dbh->disconnect();
+        $this->dbh = false;
+    }
 
-      // ========================== Public ========================
+    /* ========================== Public ======================== */
      
-      // Search the file
-      function &search($expr) {
-         $ret = array();
-         if(!$this->open())
+    /* Search the file */
+    function &search($expr) {
+        $ret = array();
+        if(!$this->open()) {
             return false;
+        }
          
-         // To be replaced by advanded search expression parsing
-         if(is_array($expr)) return;
-
-         // Make regexp from glob'ed expression 
-         $expr = str_replace('?', '_', $expr);
-         $expr = str_replace('*', '%', $expr);
-         $expr = $this->dbh->quoteString($expr);
-         $expr = "%$expr%";
-
-         $query = sprintf("SELECT * FROM %s WHERE owner='%s' AND " .
-                          "(firstname LIKE '%s' OR lastname LIKE '%s')",
-                          $this->table, $this->owner, $expr, $expr);
-         $res = $this->dbh->query($query);
-
-         if(DB::isError($res)) 
+        /* To be replaced by advanded search expression parsing */
+        if (is_array($expr)) {
+            return;
+        }
+
+        /* Make regexp from glob'ed expression  */
+        $expr = str_replace('?', '_', $expr);
+        $expr = str_replace('*', '%', $expr);
+        $expr = $this->dbh->quoteString($expr);
+        $expr = "%$expr%";
+
+        $query = sprintf("SELECT * FROM %s WHERE owner='%s' AND " .
+                         "(firstname LIKE '%s' OR lastname LIKE '%s')",
+                         $this->table, $this->owner, $expr, $expr);
+        $res = $this->dbh->query($query);
+
+        if (DB::isError($res)) {
             return $this->set_error(sprintf(_("Database error: %s"),
                                             DB::errorMessage($res)));
+        }
 
-         while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
+        while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
             array_push($ret, array('nickname'  => $row['nickname'],
                                    'name'      => "$row[firstname] $row[lastname]",
                                    'firstname' => $row['firstname'],
@@ -150,30 +146,33 @@ require_once('DB.php');
                                    'label'     => $row['label'],
                                    'backend'   => $this->bnum,
                                    'source'    => &$this->sname));
-         }
-         return $ret;
-      }
+        }
+        return $ret;
+    }
      
-      // Lookup alias
-      function &lookup($alias) {
-         if(empty($alias))
+    /* Lookup alias */
+    function &lookup($alias) {
+        if (empty($alias)) {
             return array();
+        }
          
-         $alias = strtolower($alias);
+        $alias = strtolower($alias);
 
-         if(!$this->open())
+        if (!$this->open()) {
             return false;
+        }
          
-         $query = sprintf("SELECT * FROM %s WHERE owner='%s' AND nickname='%s'",
-                          $this->table, $this->owner, $alias);
+        $query = sprintf("SELECT * FROM %s WHERE owner='%s' AND nickname='%s'",
+                         $this->table, $this->owner, $alias);
 
-         $res = $this->dbh->query($query);
+        $res = $this->dbh->query($query);
 
-         if(DB::isError($res)) 
+        if (DB::isError($res)) {
             return $this->set_error(sprintf(_("Database error: %s"),
                                             DB::errorMessage($res)));
+        }
 
-         if ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
+        if ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
             return array('nickname'  => $row['nickname'],
                          'name'      => "$row[firstname] $row[lastname]",
                          'firstname' => $row['firstname'],
@@ -182,27 +181,28 @@ require_once('DB.php');
                          'label'     => $row['label'],
                          'backend'   => $this->bnum,
                          'source'    => &$this->sname);
-         }
-
-         return array();
-      }
-
-      // List all addresses
-      function &list_addr() {
-         $ret = array();
-         if(!$this->open())
+        }
+        return array();
+    }
+
+    /* List all addresses */
+    function &list_addr() {
+        $ret = array();
+        if (!$this->open()) {
             return false;
+        }
 
-         $query = sprintf("SELECT * FROM %s WHERE owner='%s'",
-                          $this->table, $this->owner);
+        $query = sprintf("SELECT * FROM %s WHERE owner='%s'",
+                         $this->table, $this->owner);
 
-         $res = $this->dbh->query($query);
-
-         if(DB::isError($res)) 
+        $res = $this->dbh->query($query);
+        
+        if (DB::isError($res)) {
             return $this->set_error(sprintf(_("Database error: %s"),
                                             DB::errorMessage($res)));
+        }
 
-         while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
+        while ($row = $res->fetchRow(DB_FETCHMODE_ASSOC)) {
             array_push($ret, array('nickname'  => $row['nickname'],
                                    'name'      => "$row[firstname] $row[lastname]",
                                    'firstname' => $row['firstname'],
@@ -211,108 +211,122 @@ require_once('DB.php');
                                    'label'     => $row['label'],
                                    'backend'   => $this->bnum,
                                    'source'    => &$this->sname));
-         }
-         return $ret;
-      }
+        }
+        return $ret;
+    }
 
-      // Add address
-      function add($userdata) {
-         if(!$this->writeable)
+    /* Add address */
+    function add($userdata) {
+        if (!$this->writeable) {
             return $this->set_error(_("Addressbook is read-only"));
+        }
 
-         if(!$this->open())
+        if (!$this->open()) {
             return false;
+        }
          
-         // See if user exist already
-         $ret = $this->lookup($userdata['nickname']);
-         if(!empty($ret))
+        /* See if user exist already */
+        $ret = $this->lookup($userdata['nickname']);
+        if (!empty($ret)) {
             return $this->set_error(sprintf(_("User '%s' already exist"),
                                             $ret['nickname']));
-
-         // Create query
-         $query = sprintf("INSERT INTO %s (owner, nickname, firstname, " .
-                          "lastname, email, label) VALUES('%s','%s','%s'," .
-                          "'%s','%s','%s')",
-                          $this->table, $this->owner,
-                          $this->dbh->quoteString($userdata['nickname']),
-                          $this->dbh->quoteString($userdata['firstname']), 
-                          $this->dbh->quoteString($userdata['lastname']),
-                          $this->dbh->quoteString($userdata['email']), 
-                          $this->dbh->quoteString($userdata['label']) );
-
-         // Do the insert
+        }
+
+        /* Create query */
+        $query = sprintf("INSERT INTO %s (owner, nickname, firstname, " .
+                         "lastname, email, label) VALUES('%s','%s','%s'," .
+                         "'%s','%s','%s')",
+                         $this->table, $this->owner,
+                         $this->dbh->quoteString($userdata['nickname']),
+                         $this->dbh->quoteString($userdata['firstname']), 
+                         $this->dbh->quoteString($userdata['lastname']),
+                         $this->dbh->quoteString($userdata['email']), 
+                         $this->dbh->quoteString($userdata['label']) );
+
+         /* Do the insert */
          $r = $this->dbh->simpleQuery($query);
-         if($r == DB_OK) return true;
+         if ($r == DB_OK) {
+             return true;
+         }
 
-         // Fail
+         /* Fail */
          return $this->set_error(sprintf(_("Database error: %s"),
                                          DB::errorMessage($r)));
-      }
+    }
 
-      // Delete address
-      function remove($alias) {
-         if(!$this->writeable) 
+    /* Delete address */
+    function remove($alias) {
+        if (!$this->writeable) {
             return $this->set_error(_("Addressbook is read-only"));
+        }
 
-         if(!$this->open())
+        if (!$this->open()) {
             return false;
+        }
          
-         // Create query
-         $query = sprintf("DELETE FROM %s WHERE owner='%s' AND (",
-                          $this->table, $this->owner);
+        /* Create query */
+        $query = sprintf("DELETE FROM %s WHERE owner='%s' AND (",
+                         $this->table, $this->owner);
 
-         $sepstr = '';
-         while(list($undef, $nickname) = each($alias)) {
+        $sepstr = '';
+        while (list($undef, $nickname) = each($alias)) {
             $query .= sprintf("%s nickname='%s' ", $sepstr,
                               $this->dbh->quoteString($nickname));
             $sepstr = 'OR';
-         }
-         $query .= ')';
+        }
+        $query .= ')';
 
-         // Delete entry
-         $r = $this->dbh->simpleQuery($query);
-         if($r == DB_OK) return true;
+        /* Delete entry */
+        $r = $this->dbh->simpleQuery($query);
+        if ($r == DB_OK) {
+            return true;
+        }
 
-         // Fail
-         return $this->set_error(sprintf(_("Database error: %s"),
+        /* Fail */
+        return $this->set_error(sprintf(_("Database error: %s"),
                                          DB::errorMessage($r)));
-      }
+    }
 
-      // Modify address
-      function modify($alias, $userdata) {
-         if(!$this->writeable) 
+    /* Modify address */
+    function modify($alias, $userdata) {
+        if (!$this->writeable) {
             return $this->set_error(_("Addressbook is read-only"));
+        }
 
-         if(!$this->open())
+        if (!$this->open()) {
             return false;
+        }
          
-         // See if user exist
-         $ret = $this->lookup($alias);
-         if(empty($ret))
+         /* See if user exist */
+        $ret = $this->lookup($alias);
+        if (empty($ret)) {
             return $this->set_error(sprintf(_("User '%s' does not exist"),
                                             $alias));
+        }
+
+        /* Create query */
+        $query = sprintf("UPDATE %s SET nickname='%s', firstname='%s', ".
+                         "lastname='%s', email='%s', label='%s' ".
+                         "WHERE owner='%s' AND nickname='%s'",
+                         $this->table, 
+                         $this->dbh->quoteString($userdata['nickname']),
+                         $this->dbh->quoteString($userdata['firstname']), 
+                         $this->dbh->quoteString($userdata['lastname']),
+                         $this->dbh->quoteString($userdata['email']), 
+                         $this->dbh->quoteString($userdata['label']),
+                         $this->owner,
+                         $this->dbh->quoteString($alias) );
+
+        /* Do the insert */
+        $r = $this->dbh->simpleQuery($query);
+        if ($r == DB_OK) {
+            return true;
+        }
 
-         // Create query
-         $query = sprintf("UPDATE %s SET nickname='%s', firstname='%s', ".
-                          "lastname='%s', email='%s', label='%s' ".
-                          "WHERE owner='%s' AND nickname='%s'",
-                          $this->table, 
-                          $this->dbh->quoteString($userdata['nickname']),
-                          $this->dbh->quoteString($userdata['firstname']), 
-                          $this->dbh->quoteString($userdata['lastname']),
-                          $this->dbh->quoteString($userdata['email']), 
-                          $this->dbh->quoteString($userdata['label']),
-                          $this->owner,
-                          $this->dbh->quoteString($alias) );
-
-         // Do the insert
-         $r = $this->dbh->simpleQuery($query);
-         if($r == DB_OK) return true;
-
-         // Fail
-         return $this->set_error(sprintf(_("Database error: %s"),
-                                         DB::errorMessage($r)));
-      }
-   } // End of class abook_database
+        /* Fail */
+        return $this->set_error(sprintf(_("Database error: %s"),
+                                        DB::errorMessage($r)));
+    }
+} /* End of class abook_database */
 
-} ?>
+?>