]> git.mxchange.org Git - quix0rs-gnu-social.git/commitdiff
Managed_DataObject initial sketches (pulling Drupal-style schema def into the data...
authorBrion Vibber <brion@pobox.com>
Mon, 16 Aug 2010 21:02:31 +0000 (14:02 -0700)
committerBrion Vibber <brion@pobox.com>
Mon, 16 Aug 2010 21:02:31 +0000 (14:02 -0700)
classes/Managed_DataObject.php [new file with mode: 0644]
db/core.php
plugins/OStatus/classes/Ostatus_profile.php

diff --git a/classes/Managed_DataObject.php b/classes/Managed_DataObject.php
new file mode 100644 (file)
index 0000000..3bc99c2
--- /dev/null
@@ -0,0 +1,156 @@
+<?php
+/*
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2010, StatusNet, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * Wrapper for Memcached_DataObject which knows its own schema definition.
+ * Builds its own damn settings from a schema definition.
+ *
+ * @author brion
+ */
+class Managed_DataObject extends Memcached_DataObject
+{
+    /**
+     * The One True Thingy that must be defined and declared.
+     */
+    public static abstract function schemaDef();
+
+    /**
+     * get/set an associative array of table columns
+     *
+     * @access public
+     * @return array (associative)
+     */
+    function table()
+    {
+        $table = self::schemaDef();
+        return array_map(array($this, 'columnBitmap'), $table['fields']);
+    }
+
+    /**
+     * get/set an  array of table primary keys
+     *
+     * Key info is pulled from the table definition array.
+     * 
+     * @access private
+     * @return array
+     */
+    function keys()
+    {
+        return array_keys($this->keyTypes());
+    }
+
+    /**
+     * Get a sequence key
+     *
+     * Returns the first serial column defined in the table, if any.
+     *
+     * @access private
+     * @return array (column,use_native,sequence_name)
+     */
+
+    function sequenceKey()
+    {
+        $table = self::schemaDef();
+        foreach ($table['fields'] as $name => $column) {
+            if ($column['type'] == 'serial') {
+                // We have a serial/autoincrement column.
+                // Declare it to be a native sequence!
+                return array($name, true, false);
+            }
+        }
+
+        // No sequence key on this table.
+        return array(false, false, false);
+    }
+
+    /**
+     * Return key definitions for DB_DataObject and Memcache_DataObject.
+     *
+     * DB_DataObject needs to know about keys that the table has; this function
+     * defines them.
+     *
+     * @return array key definitions
+     */
+
+    function keyTypes()
+    {
+        $keys = array();
+        $table = self::schemaDef();
+
+        if (!empty($table['unique keys'])) {
+            foreach ($table['unique keys'] as $idx => $fields) {
+                foreach ($fields as $name) {
+                    $keys[$name] = 'U';
+                }
+            }
+        }
+
+        if (!empty($table['primary key'])) {
+            foreach ($table['primary key'] as $name) {
+                $keys[$name] = 'K';
+            }
+        }
+        return $keys;
+    }
+
+    /**
+     * Build the appropriate DB_DataObject bitfield map for this field.
+     *
+     * @param array $column
+     * @return int
+     */
+    function columnBitmap($column)
+    {
+        $type = 0;
+
+        switch ($column['type']) {
+        case 'int':
+        case 'serial':
+        case 'numeric':
+            // Doesn't need quoting.
+            $type |= DB_DATAOBJECT_INT;
+            break;
+        default:
+            // Value needs quoting in SQL literal statements.
+            $type |= DB_DATAOBJECT_STR;
+        }
+
+        switch ($column['type']) {
+        case 'blob':
+            $type |= DB_DATAOBJECT_BLOB;
+            break;
+        case 'text':
+            $type |= DB_DATAOBJECT_TXT;
+            break;
+        case 'datetime':
+            $type |= DB_DATAOBJECT_DATE;
+            $type |= DB_DATAOBJECT_TIME;
+            break;
+        case 'timestamp':
+            $type |= DB_DATAOBJECT_MYSQLTIMESTAMP;
+            break;
+        }
+
+        if (!empty($column['not null'])) {
+            $type |= DB_DATAOBJECT_NOTNULL;
+        }
+
+        return $type;
+    }
+}
\ No newline at end of file
index 802d7158c1a8ad07955d5c2badd54059ebdeb365..04c53a585383c1b5473733ec19931887fc6fbf96 100644 (file)
@@ -942,7 +942,7 @@ $schema['user_im_prefs'] = array(
         'notify' => array('type' => 'bool', 'not null' => true, 'default' => 0, 'description' => 'Notify when a new notice is sent'),
         'replies' => array('type' => 'bool', 'not null' => true, 'default' => 0, 'description' => 'Send replies  from people not subscribed to'),
         'microid' => array('type' => 'bool', 'not null' => true, 'default' => 1, 'description' => 'Publish a MicroID'),
-        'updatefrompresence' => array('type' => 'bool', 'not null' => true, 'default' => 0, 'description' => 'Send replies  from people not subscribed to.'),
+        'updatefrompresence' => array('type' => 'bool', 'not null' => true, 'default' => 0, 'description' => 'Send replies from people not subscribed to.'),
         'created' => array('type' => 'timestamp', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was created'), // @fixme will that default work?
         'modified' => array('type' => 'timestamp', 'description' => 'date this record was modified'),
     ),
index 8f8eb773f87dfeec0701990db5a6dfd6c5f1fddd..176066ef6b11306d66da2fb3ae5a1b9a0b40f537 100644 (file)
@@ -22,7 +22,7 @@
  * @maintainer Brion Vibber <brion@status.net>
  */
 
-class Ostatus_profile extends Memcached_DataObject
+class Ostatus_profile extends Managed_DataObject
 {
     public $__table = 'ostatus_profile';
 
@@ -44,77 +44,35 @@ class Ostatus_profile extends Memcached_DataObject
     }
 
     /**
-     * return table definition for DB_DataObject
-     *
-     * DB_DataObject needs to know something about the table to manipulate
-     * instances. This method provides all the DB_DataObject needs to know.
+     * Return table definition for Schema setup and DB_DataObject usage.
      *
      * @return array array of column definitions
      */
 
-    function table()
-    {
-        return array('uri' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
-                     'profile_id' => DB_DATAOBJECT_INT,
-                     'group_id' => DB_DATAOBJECT_INT,
-                     'feeduri' => DB_DATAOBJECT_STR,
-                     'salmonuri' =>  DB_DATAOBJECT_STR,
-                     'avatar' =>  DB_DATAOBJECT_STR,
-                     'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
-                     'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
-    }
-
     static function schemaDef()
     {
-        return array(new ColumnDef('uri', 'varchar',
-                                   255, false, 'PRI'),
-                     new ColumnDef('profile_id', 'integer',
-                                   null, true, 'UNI'),
-                     new ColumnDef('group_id', 'integer',
-                                   null, true, 'UNI'),
-                     new ColumnDef('feeduri', 'varchar',
-                                   255, true, 'UNI'),
-                     new ColumnDef('salmonuri', 'text',
-                                   null, true),
-                     new ColumnDef('avatar', 'text',
-                                   null, true),
-                     new ColumnDef('created', 'datetime',
-                                   null, false),
-                     new ColumnDef('modified', 'datetime',
-                                   null, false));
-    }
-
-    /**
-     * return key definitions for DB_DataObject
-     *
-     * DB_DataObject needs to know about keys that the table has; this function
-     * defines them.
-     *
-     * @return array key definitions
-     */
-
-    function keys()
-    {
-        return array_keys($this->keyTypes());
-    }
-
-    /**
-     * return key definitions for Memcached_DataObject
-     *
-     * Our caching system uses the same key definitions, but uses a different
-     * method to get them.
-     *
-     * @return array key definitions
-     */
-
-    function keyTypes()
-    {
-        return array('uri' => 'K', 'profile_id' => 'U', 'group_id' => 'U', 'feeduri' => 'U');
-    }
-
-    function sequenceKey()
-    {
-        return array(false, false, false);
+        return array(
+            'fields' => array(
+                'uri' => array('type' => 'varchar', 'length' => 255, 'not null' => true),
+                'profile_id' => array('type' => 'integer'),
+                'group_id' => array('type' => 'integer'),
+                'feeduri' => array('type' => 'varchar', 'length' => 255),
+                'salmonuri' => array('type' => 'varchar', 'length' => 255),
+                'avatar' => array('type' => 'text'),
+                'created' => array('type' => 'datetime', 'not null' => true),
+                'modified' => array('type' => 'datetime', 'not null' => true),
+            ),
+            'primary key' => array('uri'),
+            'unique keys' => array(
+                'ostatus_profile_profile_id_idx' => array('profile_id'),
+                'ostatus_profile_group_id_idx' => array('group_id'),
+                'ostatus_profile_feeduri_idx' => array('feeduri'),
+            ),
+            'foreign keys' => array(
+                'profile_id' => array('profile' => 'id'),
+                'group_id' => array('user_group' => 'id'),
+            ),
+        );
     }
 
     /**