Naming stuff GNUsocial rather than StatusNet

[quix0rs-gnu-social.git] / actions / apignusocialversion.php

diff --git a/actions/apignusocialversion.php b/actions/apignusocialversion.php
new file mode 100644 (file)
index 0000000..e50e2d5
--- /dev/null
+++ b/actions/apignusocialversion.php
@@ -0,0 +1,87 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * A version stamp for the API
+ *
+ * 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  API
+ * @package   GNUsocial
+ * @author    Evan Prodromou <evan@status.net>
+ * @author    Zach Copley <zach@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://www.gnu.org/software/social/
+ */
+
+if (!defined('GNUSOCIAL')) { exit(1); }
+
+/**
+ * Returns a version number for this version of GNU social, which
+ * should make things a bit easier for upgrades.
+ * URL: http://identi.ca/api/statusnet/version.(xml|json)
+ * Formats: xml, js
+ *
+ * @category API
+ * @package  GNUsocial
+ * @author   Evan Prodromou <evan@status.net>
+ * @author   Zach Copley <zach@status.net>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://www.gnu.org/software/social/
+ */
+class ApiGNUsocialVersionAction extends ApiPrivateAuthAction
+{
+    protected function handle()
+    {
+        parent::handle();
+
+        switch ($this->format) {
+        case 'xml':
+            $this->initDocument('xml');
+            $this->element('version', null, STATUSNET_VERSION);
+            $this->endDocument('xml');
+            break;
+        case 'json':
+            $this->initDocument('json');
+            print '"'.STATUSNET_VERSION.'"';
+            $this->endDocument('json');
+            break;
+        default:
+            $this->clientError(
+                // TRANS: Client error displayed when coming across a non-supported API method.
+                _('API method not found.'),
+                404,
+                $this->format
+            );
+            break;
+        }
+    }
+
+    /**
+     * Return true if read only.
+     *
+     * MAY override
+     *
+     * @param array $args other arguments
+     *
+     * @return boolean is read only action?
+     */
+    function isReadOnly($args)
+    {
+        return true;
+    }
+}