outline for plugin

1 files changed, 124 insertions, 0 deletions

diff --git a/plugins/UserFlag/UserFlagPlugin.php b/plugins/UserFlag/UserFlagPlugin.php
new file mode 100644
index 000000000..600ed4271
--- /dev/null
+++ b/plugins/UserFlag/UserFlagPlugin.php
@@ -0,0 +1,124 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Allows users to flag content and accounts as offensive/spam/whatever
+ *
+ * PHP version 5
+ *
+ * LICENCE: 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/>.
+ *
+ * @category  Plugin
+ * @package   StatusNet
+ * @author    Evan Prodromou <evan@status.net>
+ * @copyright 2009 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://status.net/
+ */
+
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+    exit(1);
+}
+
+/**
+ * Allows users to flag content and accounts as offensive/spam/whatever
+ *
+ * @category Plugin
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://status.net/
+ */
+
+class UserFlagPlugin extends Plugin
+{
+    function onCheckSchema()
+    {
+        $schema = Schema::get();
+
+        // For storing user-submitted flags on notices
+
+        $schema->ensureTable('user_flag_notice',
+                             array(new ColumnDef('notice_id', 'integer', null,
+                                                 null, 'PRI'),
+                                   new ColumnDef('user_id', 'integer', null,
+                                                 null, 'PRI'),
+                                   new ColumnDef('flag', 'varchar', '8'),
+                                   new ColumnDef('created', 'datetime', null,
+                                                 null, 'MUL')));
+
+        // Allowable values for user_flag_notice
+
+        $schema->ensureTable('notice_flag',
+                             array(new ColumnDef('flag', 'varchar', '8', null, null, 'PRI'),
+                                   new ColumnDef('display', 'varchar', '255'),
+                                   new ColumnDef('created', 'datetime', null,
+                                                 null, 'MUL')));
+
+        // For storing user-submitted flags on profiles
+
+        $schema->ensureTable('user_flag_profile',
+                             array(new ColumnDef('profile_id', 'integer', null,
+                                                 null, 'PRI'),
+                                   new ColumnDef('user_id', 'integer', null,
+                                                 null, 'PRI'),
+                                   new ColumnDef('flag', 'varchar', '8'),
+                                   new ColumnDef('created', 'datetime', null,
+                                                 null, 'MUL')));
+
+        // Allowable values for user_flag_notice
+
+        $schema->ensureTable('profile_flag',
+                             array(new ColumnDef('flag', 'varchar', '8', null, null, 'PRI'),
+                                   new ColumnDef('display', 'varchar', '255'),
+                                   new ColumnDef('created', 'datetime', null,
+                                                 null, 'MUL')));
+        return true;
+    }
+
+    function onInitializePlugin()
+    {
+        // XXX: do something here?
+        return true;
+    }
+
+    function onRouterInitialized(&$m) {
+        $m->connect('main/flag/notice', array('action' => 'flagnotice'));
+        $m->connect('main/flag/profile', array('action' => 'flagprofile'));
+        $m->connect('admin/notice/flag', array('action' => 'adminnoticeflag'));
+        $m->connect('admin/profile/flag', array('action' => 'adminprofileflag'));
+        return true;
+    }
+
+    function onAutoload($cls)
+    {
+        switch ($cls)
+        {
+         case 'FlagnoticeAction':
+         case 'FlagprofileAction':
+         case 'AdminnoticeflagAction':
+         case 'AdminprofileflagAction':
+            require_once(INSTALLDIR.'/plugins/UserFlag/' . strtolower(mb_substr($cls, 0, -6)) . '.php');
+            return false;
+         case 'User_flag_notice':
+         case 'Notice_flag':
+         case 'User_flag_profile':
+         case 'Profile_flag':
+            require_once(INSTALLDIR.'/plugins/UserFlag/'.$cls.'.php');
+            return false;
+         default:
+            return true;
+        }
+    }
+}