]> git.mxchange.org Git - quix0rs-gnu-social.git/commitdiff
redo the group dm schema, again
authorEvan Prodromou <evan@status.net>
Thu, 3 Feb 2011 20:28:41 +0000 (15:28 -0500)
committerEvan Prodromou <evan@status.net>
Thu, 3 Feb 2011 20:28:41 +0000 (15:28 -0500)
plugins/PrivateGroup/Group_message.php
plugins/PrivateGroup/Group_message_profile.php [new file with mode: 0644]
plugins/PrivateGroup/PrivateGroupPlugin.php

index 404f663a1ff57b11d4e6069bf9d44b8702c58b02..27f4cff0ed60dbe821d77fa1403633f782a54941 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * Data class for group inbox info
+ * Data class for group direct messages
  *
  * PHP version 5
  *
@@ -34,17 +34,9 @@ if (!defined('STATUSNET')) {
 require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
 
 /**
- * Data class for counting greetings
+ * Data class for group direct messages
  *
- * We use the DB_DataObject framework for data classes in StatusNet. Each
- * table maps to a particular data class, making it easier to manipulate
- * data.
- *
- * Data classes should extend Memcached_DataObject, the (slightly misnamed)
- * extension of DB_DataObject that provides caching, internationalization,
- * and other bits of good functionality to StatusNet-specific data classes.
- *
- * @category Action
+ * @category PrivateGroup
  * @package  StatusNet
  * @author   Evan Prodromou <evan@status.net>
  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
@@ -55,9 +47,15 @@ require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
 
 class Group_message extends Memcached_DataObject
 {
-    public $__table = 'user_greeting_count'; // table name
-    public $user_id;                         // int(4)  primary_key not_null
-    public $greeting_count;                  // int(4)
+    public $__table = 'group_message'; // table name
+    public $id;                        // char(36)  primary_key not_null
+    public $uri;                       // varchar(255)
+    public $from_profile;              // int
+    public $to_group;                  // int
+    public $content;
+    public $rendered;
+    public $url;
+    public $created;
 
     /**
      * Get an instance by key
@@ -85,8 +83,14 @@ class Group_message extends Memcached_DataObject
      */
     function table()
     {
-        return array('user_id' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
-                     'greeting_count' => DB_DATAOBJECT_INT);
+        return array('id' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
+                     'uri' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
+                     'from_profile' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
+                     'to_group' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
+                     'content' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
+                     'rendered' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
+                     'url' => DB_DATAOBJECT_STR,
+                     'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
     }
 
     /**
@@ -106,79 +110,12 @@ class Group_message extends Memcached_DataObject
     /**
      * return key definitions for Memcached_DataObject
      *
-     * Our caching system uses the same key definitions, but uses a different
-     * method to get them. This key information is used to store and clear
-     * cached data, so be sure to list any key that will be used for static
-     * lookups.
-     *
      * @return array associative array of key definitions, field name to type:
      *         'K' for primary key: for compound keys, add an entry for each component;
      *         'U' for unique keys: compound keys are not well supported here.
      */
     function keyTypes()
     {
-        return array('user_id' => 'K');
-    }
-
-    /**
-     * Magic formula for non-autoincrementing integer primary keys
-     *
-     * If a table has a single integer column as its primary key, DB_DataObject
-     * assumes that the column is auto-incrementing and makes a sequence table
-     * to do this incrementation. Since we don't need this for our class, we
-     * overload this method and return the magic formula that DB_DataObject needs.
-     *
-     * @return array magic three-false array that stops auto-incrementing.
-     */
-    function sequenceKey()
-    {
-        return array(false, false, false);
-    }
-
-    /**
-     * Increment a user's greeting count and return instance
-     *
-     * This method handles the ins and outs of creating a new greeting_count for a
-     * user or fetching the existing greeting count and incrementing its value.
-     *
-     * @param integer $user_id ID of the user to get a count for
-     *
-     * @return Group_message instance for this user, with count already incremented.
-     */
-    static function inc($user_id)
-    {
-        $gc = Group_message::staticGet('user_id', $user_id);
-
-        if (empty($gc)) {
-
-            $gc = new Group_message();
-
-            $gc->user_id        = $user_id;
-            $gc->greeting_count = 1;
-
-            $result = $gc->insert();
-
-            if (!$result) {
-                // TRANS: Exception thrown when the user greeting count could not be saved in the database.
-                // TRANS: %d is a user ID (number).
-                throw Exception(sprintf(_m("Could not save new greeting count for %d."),
-                                        $user_id));
-            }
-        } else {
-            $orig = clone($gc);
-
-            $gc->greeting_count++;
-
-            $result = $gc->update($orig);
-
-            if (!$result) {
-                // TRANS: Exception thrown when the user greeting count could not be saved in the database.
-                // TRANS: %d is a user ID (number).
-                throw Exception(sprintf(_m("Could not increment greeting count for %d."),
-                                        $user_id));
-            }
-        }
-
-        return $gc;
+        return array('id' => 'K', 'uri' => 'U');
     }
 }
diff --git a/plugins/PrivateGroup/Group_message_profile.php b/plugins/PrivateGroup/Group_message_profile.php
new file mode 100644 (file)
index 0000000..b32341c
--- /dev/null
@@ -0,0 +1,111 @@
+<?php
+/**
+ * Who received a group message
+ *
+ * PHP version 5
+ *
+ * @category Data
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ *
+ * 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/>.
+ */
+
+if (!defined('STATUSNET')) {
+    exit(1);
+}
+
+require_once INSTALLDIR . '/classes/Memcached_DataObject.php';
+
+/**
+ * Data class for group direct messages for users
+ *
+ * @category PrivateGroup
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
+ * @link     http://status.net/
+ *
+ * @see      DB_DataObject
+ */
+
+class Group_message_profile extends Memcached_DataObject
+{
+    public $__table = 'group_message_profile'; // table name
+    public $to_profile;                        // int
+    public $group_message_id;                  // char(36)  primary_key not_null
+    public $created;
+
+    /**
+     * Get an instance by key
+     *
+     * This is a utility method to get a single instance with a given key value.
+     *
+     * @param string $k Key to use to lookup (usually 'user_id' for this class)
+     * @param mixed  $v Value to lookup
+     *
+     * @return Group_message object found, or null for no hits
+     *
+     */
+    function staticGet($k, $v=null)
+    {
+        return Memcached_DataObject::staticGet('Group_message_profile', $k, $v);
+    }
+
+    /**
+     * 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 array array of column definitions
+     */
+    function table()
+    {
+        return array('to_profile' => DB_DATAOBJECT_INT + DB_DATAOBJECT_NOTNULL,
+                     'group_message_id' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
+                     'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
+    }
+
+    /**
+     * return key definitions for DB_DataObject
+     *
+     * DB_DataObject needs to know about keys that the table has, since it
+     * won't appear in StatusNet's own keys list. In most cases, this will
+     * simply reference your keyTypes() function.
+     *
+     * @return array list of key field names
+     */
+    function keys()
+    {
+        return array_keys($this->keyTypes());
+    }
+
+    /**
+     * return key definitions for Memcached_DataObject
+     *
+     * @return array associative array of key definitions, field name to type:
+     *         'K' for primary key: for compound keys, add an entry for each component;
+     *         'U' for unique keys: compound keys are not well supported here.
+     */
+    function keyTypes()
+    {
+        return array('to_profile' => 'K', 'group_message_id' => 'K');
+    }
+}
index 9851313ff40955568241caad9c7a089459c26141..cd0ef0a22d513556e95fc0689b2e68ffba82b955 100644 (file)
@@ -110,26 +110,21 @@ class PrivateGroupPlugin extends Plugin
                                                  false,
                                                  'UNI'),
                                    new ColumnDef('created',
-                                                 'datetime'),
-                                   new ColumnDef('modified',
-                                                 'timestamp')));
+                                                 'datetime')));
 
-
-        $schema->ensureTable('group_message_copy',
-                             array(new ColumnDef('group_message_id',
-                                                 'char',
-                                                 36,
+        $schema->ensureTable('group_message_profile',
+                             array(new ColumnDef('to_profile',
+                                                 'integer',
+                                                 null,
                                                  false,
                                                  'PRI'),
-                                   new ColumnDef('message_uri',
-                                                 'varchar',
-                                                 255,
+                                   new ColumnDef('group_message_id',
+                                                 'char',
+                                                 36,
                                                  false,
                                                  'PRI'),
                                    new ColumnDef('created',
-                                                 'datetime'),
-                                   new ColumnDef('modified',
-                                                 'timestamp')));
+                                                 'datetime')));
 
         return true;
     }
@@ -205,7 +200,7 @@ class PrivateGroupPlugin extends Plugin
     /**
      * Create default group privacy settings at group create time
      *
-     * @param $group Group that was just created
+     * @param User_group $group Group that was just created
      *
      * @result boolean hook value
      */
@@ -227,6 +222,14 @@ class PrivateGroupPlugin extends Plugin
         return true;
     }
 
+    /**
+     * Show group privacy controls on group edit form
+     *
+     * @param Action $action EditgroupAction being executed
+     *
+     * 
+     */
     function onPluginVersion(&$versions)
     {
         $versions[] = array('name' => 'PrivateGroup',