Merge branch 'tagprofile-ajax-fix' into 'nightly'

[quix0rs-gnu-social.git] / classes / Managed_DataObject.php

diff --git a/classes/Managed_DataObject.php b/classes/Managed_DataObject.php
index cc088249db1d2986b49237ce8670b4d72f87be0f..a69a957bcc0225bad8b4085312b1b73a53b9ea13 100644 (file)
--- a/classes/Managed_DataObject.php
+++ b/classes/Managed_DataObject.php
@@ -64,6 +64,11 @@ abstract class Managed_DataObject extends Memcached_DataObject
         return parent::pkeyGetClass(get_called_class(), $kv);
     }
 
+    static function pkeyCols()
+    {
+        return parent::pkeyColsClass(get_called_class());
+    }
+
     /**
      * Get multiple items from the database by key
      *
@@ -299,6 +304,58 @@ abstract class Managed_DataObject extends Memcached_DataObject
         return $ckeys;
     }
 
+    public function escapedTableName()
+    {
+        return common_database_tablename($this->tableName());
+    }
+
+    /**
+     * Returns an object by looking at the primary key column(s).
+     *
+     * Will require all primary key columns to be defined in an associative array
+     * and ignore any keys which are not part of the primary key.
+     *
+     * Will NOT accept NULL values as part of primary key.
+     *
+     * @param   array   $vals       Must match all primary key columns for the dataobject.
+     *
+     * @return  Managed_DataObject  of the get_called_class() type
+     * @throws  NoResultException   if no object with that primary key
+     */
+    static function getByPK(array $vals)
+    {
+        $classname = get_called_class();
+
+        $pkey = static::pkeyCols();
+        if (is_null($pkey)) {
+            throw new ServerException("Failed to get primary key columns for class '{$classname}'");
+        }
+
+        $object = new $classname();
+        foreach ($pkey as $col) {
+            if (!array_key_exists($col, $vals)) {
+                throw new ServerException("Missing primary key column '{$col}'");
+            } elseif (is_null($vals[$col])) {
+                throw new ServerException("NULL values not allowed in getByPK for column '{$col}'");
+            }
+            $object->$col = $vals[$col];
+        }
+        if (!$object->find(true)) {
+            throw new NoResultException($object);
+        }
+        return $object;
+    }
+
+    static function getByID($id)
+    {
+        if (empty($id)) {
+            throw new ServerException('Empty ID on lookup');
+        }
+        // getByPK throws exception if id is null
+        // or if the class does not have a single 'id' column as primary key
+        return static::getByPK(array('id' => $id));
+    }
+
     /**
      * Returns an ID, checked that it is set and reasonably valid
      *
@@ -323,7 +380,12 @@ abstract class Managed_DataObject extends Memcached_DataObject
 
     // 'update' won't write key columns, so we have to do it ourselves.
     // This also automatically calls "update" _before_ it sets the keys.
-    public function updateWithKeys(&$orig)
+    // FIXME: This only works with single-column primary keys so far! Beware!
+    /**
+     * @param DB_DataObject &$orig  Must be "instanceof" $this
+     * @param string         $pid   Primary ID column (no escaping is done on column name!)
+     */
+    public function updateWithKeys(&$orig, $pid='id')
     {
         if (!$orig instanceof $this) {
             throw new ServerException('Tried updating a DataObject with a different class than itself.');
@@ -339,15 +401,28 @@ abstract class Managed_DataObject extends Memcached_DataObject
             }
         }
         if (count($parts) == 0) {
-            // No changes, unless made in the ->update call
+            // No changes to keys, it's safe to run ->update(...)
+            if ($this->update($orig) === false) {
+                common_log_db_error($this, 'UPDATE', __FILE__);
+                // rollback as something bad occurred
+                $this->query('ROLLBACK');
+                throw new ServerException("Could not UPDATE non-keys for {$this->__table}");
+            }
+            $orig->decache();
+            $this->encache();
+
+            // commit our db transaction since we won't reach the COMMIT below
+            $this->query('COMMIT');
+            // @FIXME return true only if something changed (otherwise 0)
             return true;
         }
-        $toupdate = implode(', ', $parts);
 
-        $table = common_database_tablename($this->tableName());
-        $qry = 'UPDATE ' . $table . ' SET ' . $toupdate .
-          ' WHERE id = ' . $this->getID();
-        $orig->decache();
+        $qry = sprintf('UPDATE %1$s SET %2$s WHERE %3$s = %4$s',
+                            common_database_tablename($this->tableName()),
+                            implode(', ', $parts),
+                            $pid,
+                            $this->_quote($this->$pid));
+
         $result = $this->query($qry);
         if ($result === false) {
             common_log_db_error($this, 'UPDATE', __FILE__);
@@ -357,16 +432,25 @@ abstract class Managed_DataObject extends Memcached_DataObject
         }
 
         // Update non-keys too, if the previous endeavour worked.
+        // The ->update call uses "$this" values for keys, that's why we can't do this until
+        // the keys are updated (because they might differ from $orig and update the wrong entries).
         if ($this->update($orig) === false) {
             common_log_db_error($this, 'UPDATE', __FILE__);
             // rollback as something bad occurred
             $this->query('ROLLBACK');
             throw new ServerException("Could not UPDATE non-keys for {$this->__table}");
         }
+        $orig->decache();
         $this->encache();
 
         // commit our db transaction
         $this->query('COMMIT');
+        // @FIXME return true only if something changed (otherwise 0)
         return $result;
     }
+
+    static public function beforeSchemaUpdate()
+    {
+        // NOOP
+    }
 }