New actions for the account methods we have implemented

1 files changed, 132 insertions, 0 deletions

diff --git a/actions/apiaccountratelimitstatus.php b/actions/apiaccountratelimitstatus.php
new file mode 100644
index 000000000..3c6c3e714
--- /dev/null
+++ b/actions/apiaccountratelimitstatus.php
@@ -0,0 +1,132 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Dummy action that emulates Twitter's rate limit status API resource
+ *
+ * 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   StatusNet
+ * @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://status.net/
+ */
+
+if (!defined('STATUSNET')) {
+    exit(1);
+}
+
+require_once INSTALLDIR.'/lib/apibareauth.php';
+
+/**
+ * We don't have a rate limit, but some clients check this method.
+ * It always returns the same thing: 100 hits left.
+ *
+ * @category API
+ * @package  StatusNet
+ * @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://status.net/
+ */
+
+class ApiAccountRateLimitStatusAction extends ApiBareAuthAction
+{
+    var $format = null;
+
+    /**
+     * Take arguments for running
+     *
+     * @param array $args $_REQUEST args
+     *
+     * @return boolean success flag
+     *
+     */
+
+    function prepare($args)
+    {
+        parent::prepare($args);
+
+        if ($this->requiresAuth()) {
+            if ($this->checkBasicAuthUser() == false) {
+                return false;
+            }
+        }
+
+        $this->format = $this->arg('format');
+        return true;
+    }
+
+    /**
+     * Handle the request
+     *
+     * Return some Twitter-ish data about API limits
+     *
+     * @param array $args $_REQUEST data (unused)
+     *
+     * @return void
+     */
+
+    function handle($args)
+    {
+        parent::handle($args);
+
+        if (!in_array($this->format, array('xml', 'json'))) {
+            $this->clientError(
+                _('API method not found!'),
+                404,
+                $this->format
+            );
+            return;
+        }
+
+        $reset   = new DateTime();
+        $reset->modify('+1 hour');
+
+        $this->init_document($this->format);
+
+         if ($this->format == 'xml') {
+             $this->elementStart('hash');
+             $this->element('remaining-hits', array('type' => 'integer'), 150);
+             $this->element('hourly-limit', array('type' => 'integer'), 150);
+             $this->element(
+                 'reset-time', array('type' => 'datetime'),
+                 common_date_iso8601($reset->format('r'))
+             );
+             $this->element(
+                 'reset_time_in_seconds',
+                 array('type' => 'integer'),
+                 strtotime('+1 hour')
+             );
+             $this->elementEnd('hash');
+         } elseif ($this->format == 'json') {
+             $out = array(
+                 'reset_time_in_seconds' => strtotime('+1 hour'),
+                 'remaining_hits' => 150,
+                 'hourly_limit' => 150,
+                 'reset_time' => common_date_rfc2822(
+                     $reset->format('r')
+                  )
+             );
+             print json_encode($out);
+         }
+
+         $this->end_document($this->format);
+    }
+
+}
+