1 files changed, 105 insertions, 0 deletions
diff --git a/lib/authorizationplugin.php b/lib/authorizationplugin.php
new file mode 100644
index 000000000..733b0c065
--- /dev/null
+++ b/lib/authorizationplugin.php
@@ -0,0 +1,105 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Superclass for plugins that do authorization
+ *
+ * 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    Craig Andrews <candrews@integralblue.com>
+ * @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);
+}
+
+/**
+ * Superclass for plugins that do authorization
+ *
+ * @category Plugin
+ * @package  StatusNet
+ * @author   Craig Andrews <candrews@integralblue.com>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://status.net/
+ */
+
+abstract class AuthorizationPlugin extends Plugin
+{
+    //is this plugin authoritative for authorization?
+    public $authoritative = false;
+
+    //------------Auth plugin should implement some (or all) of these methods------------\\
+
+    /**
+    * Is a user allowed to log in?
+    * @param user
+    * @return boolean true if the user is allowed to login, false if explicitly not allowed to login, null if we don't explicitly allow or deny login
+    */
+    function loginAllowed($user) {
+        return null;
+    }
+
+    /**
+    * Does a profile grant the user a named role?
+    * @param profile
+    * @return boolean true if the profile has the role, false if not
+    */
+    function hasRole($profile, $name) {
+        return false;
+    }
+
+    //------------Below are the methods that connect StatusNet to the implementing Auth plugin------------\\
+
+    function onStartSetUser(&$user) {
+        $loginAllowed = $this->loginAllowed($user);
+        if($loginAllowed === true){
+            return;
+        }else if($loginAllowed === false){
+            $user = null;
+            return false;
+        }else{
+            if($this->authoritative) {
+                $user = null;
+                return false;
+            }else{
+                return;
+            }
+        }
+    }
+
+    function onStartSetApiUser(&$user) {
+        return $this->onStartSetUser(&$user);
+    }
+
+    function onStartHasRole($profile, $name, &$has_role) {
+        if($this->hasRole($profile, $name)){
+            $has_role = true;
+            return false;
+        }else{
+            if($this->authoritative) {
+                $has_role = false;
+                return false;
+            }else{
+                return;
+            }
+        }
+    }
+}
+