refactor the common parts of usermap and allmap into a common base class

4 files changed, 189 insertions, 237 deletions

diff --git a/plugins/Mapstraction/MapstractionPlugin.php b/plugins/Mapstraction/MapstractionPlugin.php
index a0dbf5204..ca1a3bf20 100644
--- a/plugins/Mapstraction/MapstractionPlugin.php
+++ b/plugins/Mapstraction/MapstractionPlugin.php
@@ -90,6 +90,7 @@ class MapstractionPlugin extends Plugin
         {
         case 'AllmapAction':
         case 'UsermapAction':
+        case 'MapAction':
             include_once INSTALLDIR.'/plugins/Mapstraction/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
             return false;
         default:
diff --git a/plugins/Mapstraction/allmap.php b/plugins/Mapstraction/allmap.php
index 3a78ac0d4..0c4f03b31 100644
--- a/plugins/Mapstraction/allmap.php
+++ b/plugins/Mapstraction/allmap.php
@@ -37,59 +37,26 @@ if (!defined('STATUSNET')) {
  * @category Mapstraction
  * @package  StatusNet
  * @author   Evan Prodromou <evan@status.net>
+ * @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/
  */
 
-class AllmapAction extends OwnerDesignAction
+class AllmapAction extends MapAction
 {
-    var $profile = null;
-    var $page    = null;
-    var $notices = null;
-
-    public $plugin  = null;
-
     function prepare($args)
     {
-        parent::prepare($args);
-
-        $nickname_arg = $this->arg('nickname');
-        $nickname     = common_canonical_nickname($nickname_arg);
-
-        // Permanent redirect on non-canonical nickname
-
-        if ($nickname_arg != $nickname) {
-            $args = array('nickname' => $nickname);
-            if ($this->arg('page') && $this->arg('page') != 1) {
-                $args['page'] = $this->arg['page'];
+        if(parent::prepare($args)) {
+            $cur = common_current_user();
+            if (!empty($cur) && $cur->id == $this->user->id) {
+                $this->notice = $this->user->noticeInbox(($this->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1);
+            } else {
+                $this->notice = $this->user->noticesWithFriends(($this->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1);
             }
-            common_redirect(common_local_url($this->trimmed('action'), $args), 301);
-            return false;
-        }
-
-        $this->user = User::staticGet('nickname', $nickname);
-
-        if (!$this->user) {
-            $this->clientError(_('No such user.'), 404);
+            return true;
+        }else{
             return false;
         }
-
-        $this->profile = $this->user->getProfile();
-
-        if (!$this->profile) {
-            $this->serverError(_('User has no profile.'));
-            return false;
-        }
-
-        $page = $this->trimmed('page');
-
-        if (!empty($page) && Validate::number($page)) {
-            $this->page = $page+0;
-        } else {
-            $this->page = 1;
-        }
-
-        return true;
     }
 
     function title()
@@ -109,76 +76,4 @@ class AllmapAction extends OwnerDesignAction
                            $this->page);
         }
     }
-
-    function handle($args)
-    {
-        parent::handle($args);
-        $this->showPage();
-    }
-
-    function showContent()
-    {
-        $this->element('div', array('id' => 'map_canvas',
-                                    'class' => 'gray smallmap',
-                                    'style' => "width: 100%; height: 400px"));
-    }
-
-    function showScripts()
-    {
-        parent::showScripts();
-        $cur = common_current_user();
-        if (!empty($cur) && $cur->id == $this->user->id) {
-            $notice = $this->user->noticeInbox(($this->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1);
-        } else {
-            $notice = $this->user->noticesWithFriends(($this->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1);
-        }
-
-        $jsonArray = array();
-
-        while ($notice->fetch()) {
-            if (!empty($notice->lat) && !empty($notice->lon)) {
-                $jsonNotice = $this->noticeAsJson($notice);
-                $jsonArray[] = $jsonNotice;
-            }
-        }
-
-        $this->elementStart('script', array('type' => 'text/javascript'));
-        $this->raw('/*<![CDATA[*/'); // XHTML compat for Safari
-        $this->raw('var _notices = ' . json_encode($jsonArray).'; ');
-        $this->raw('showMapstraction($("#map_canvas"),_notices);');
-        $this->raw('/*]]>*/'); // XHTML compat for Safari
-        $this->elementEnd('script');
-
-        return true;
-    }
-
-    function noticeAsJson($notice)
-    {
-        // FIXME: this code should be abstracted to a neutral third
-        // party, like Notice::asJson(). I'm not sure of the ethics
-        // of refactoring from within a plugin, so I'm just abusing
-        // the ApiAction method. Don't do this unless you're me!
-
-        require_once(INSTALLDIR.'/lib/api.php');
-
-        $act = new ApiAction('/dev/null');
-
-        $arr = $act->twitterStatusArray($notice, true);
-        $arr['url'] = $notice->bestUrl();
-        $arr['html'] = $notice->rendered;
-        $arr['source'] = $arr['source'];
-
-        if (!empty($notice->reply_to)) {
-            $reply_to = Notice::staticGet('id', $notice->reply_to);
-            if (!empty($reply_to)) {
-                $arr['in_reply_to_status_url'] = $reply_to->bestUrl();
-            }
-            $reply_to = null;
-        }
-
-        $profile = $notice->getProfile();
-        $arr['user']['profile_url'] = $profile->profileurl;
-
-        return $arr;
-    }
 }
diff --git a/plugins/Mapstraction/map.php b/plugins/Mapstraction/map.php
new file mode 100644
index 000000000..89723f43c
--- /dev/null
+++ b/plugins/Mapstraction/map.php
@@ -0,0 +1,170 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Show a map of user's notices
+ *
+ * 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  Mapstraction
+ * @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')) {
+    exit(1);
+}
+
+/**
+ * Show a map of notices
+ *
+ * @category Mapstraction
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @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/
+ */
+
+class MapAction extends OwnerDesignAction
+{
+    var $profile = null;
+    var $page    = null;
+    var $notices = null;
+
+    function prepare($args)
+    {
+        parent::prepare($args);
+
+        $nickname_arg = $this->arg('nickname');
+        $nickname     = common_canonical_nickname($nickname_arg);
+
+        // Permanent redirect on non-canonical nickname
+
+        if ($nickname_arg != $nickname) {
+            $args = array('nickname' => $nickname);
+            if ($this->arg('page') && $this->arg('page') != 1) {
+                $args['page'] = $this->arg['page'];
+            }
+            common_redirect(common_local_url($this->trimmed('action'), $args), 301);
+            return false;
+        }
+
+        $this->user = User::staticGet('nickname', $nickname);
+
+        if (!$this->user) {
+            $this->clientError(_('No such user.'), 404);
+            return false;
+        }
+
+        $this->profile = $this->user->getProfile();
+
+        if (!$this->profile) {
+            $this->serverError(_('User has no profile.'));
+            return false;
+        }
+
+        $page = $this->trimmed('page');
+
+        if (!empty($page) && Validate::number($page)) {
+            $this->page = $page+0;
+        } else {
+            $this->page = 1;
+        }
+
+        $this->notices = empty($this->tag)
+          ? $this->user->getNotices(($this->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1)
+            : $this->user->getTaggedNotices($this->tag, ($this->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1, 0, 0, null);
+
+        return true;
+    }
+
+    function handle($args)
+    {
+        parent::handle($args);
+        $this->showPage();
+    }
+
+    function showContent()
+    {
+        $this->element('div', array('id' => 'map_canvas',
+                                    'class' => 'gray smallmap',
+                                    'style' => "width: 100%; height: 400px"));
+    }
+
+    /**
+     * Hook for adding extra JavaScript
+     *
+     * @param Action $action Action object for the page
+     *
+     * @return boolean event handler return
+     */
+
+    function showScripts()
+    {
+        parent::showScripts();
+        $jsonArray = array();
+
+        while ($this->notice->fetch()) {
+            if (!empty($this->notice->lat) && !empty($this->notice->lon)) {
+                $jsonNotice = $this->noticeAsJson($this->notice);
+                $jsonArray[] = $jsonNotice;
+            }
+        }
+
+        $this->elementStart('script', array('type' => 'text/javascript'));
+        $this->raw('/*<![CDATA[*/'); // XHTML compat for Safari
+        $this->raw('var _notices = ' . json_encode($jsonArray).'; ');
+        $this->raw('showMapstraction($("#map_canvas"),_notices);');
+        $this->raw('/*]]>*/'); // XHTML compat for Safari
+        $this->elementEnd('script');
+
+        return true;
+    }
+
+    function noticeAsJson($notice)
+    {
+        // FIXME: this code should be abstracted to a neutral third
+        // party, like Notice::asJson(). I'm not sure of the ethics
+        // of refactoring from within a plugin, so I'm just abusing
+        // the ApiAction method. Don't do this unless you're me!
+
+        require_once(INSTALLDIR.'/lib/api.php');
+
+        $act = new ApiAction('/dev/null');
+
+        $arr = $act->twitterStatusArray($notice, true);
+        $arr['url'] = $notice->bestUrl();
+        $arr['html'] = $notice->rendered;
+        $arr['source'] = $arr['source'];
+
+        if (!empty($notice->reply_to)) {
+            $reply_to = Notice::staticGet('id', $notice->reply_to);
+            if (!empty($reply_to)) {
+                $arr['in_reply_to_status_url'] = $reply_to->bestUrl();
+            }
+            $reply_to = null;
+        }
+
+        $profile = $notice->getProfile();
+        $arr['user']['profile_url'] = $profile->profileurl;
+
+        return $arr;
+    }
+}
diff --git a/plugins/Mapstraction/usermap.php b/plugins/Mapstraction/usermap.php
index afa48b162..3e517ee86 100644
--- a/plugins/Mapstraction/usermap.php
+++ b/plugins/Mapstraction/usermap.php
@@ -37,61 +37,24 @@ if (!defined('STATUSNET')) {
  * @category Mapstraction
  * @package  StatusNet
  * @author   Evan Prodromou <evan@status.net>
+ * @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/
  */
 
-class UsermapAction extends OwnerDesignAction
+class UsermapAction extends MapAction
 {
-    var $profile = null;
-    var $page    = null;
-    var $notices = null;
-
-    public $plugin  = null;
 
     function prepare($args)
     {
-        parent::prepare($args);
-
-        $nickname_arg = $this->arg('nickname');
-        $nickname     = common_canonical_nickname($nickname_arg);
-
-        // Permanent redirect on non-canonical nickname
-
-        if ($nickname_arg != $nickname) {
-            $args = array('nickname' => $nickname);
-            if ($this->arg('page') && $this->arg('page') != 1) {
-                $args['page'] = $this->arg['page'];
-            }
-            common_redirect(common_local_url($this->trimmed('action'), $args), 301);
-            return false;
-        }
-
-        $this->user = User::staticGet('nickname', $nickname);
-
-        if (!$this->user) {
-            $this->clientError(_('No such user.'), 404);
-            return false;
-        }
-
-        $this->profile = $this->user->getProfile();
-
-        if (!$this->profile) {
-            $this->serverError(_('User has no profile.'));
+        if(parent::prepare($args)) {
+            $this->notice = empty($this->tag)
+              ? $this->user->getNotices(($this->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1)
+                : $this->user->getTaggedNotices($this->tag, ($this->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1, 0, 0, null);
+            return true;
+        }else{
             return false;
         }
-
-        $page = $this->trimmed('page');
-
-        if (!empty($page) && Validate::number($page)) {
-            $this->page = $page+0;
-        } else {
-            $this->page = 1;
-        }
-
-        $this->notices = $this->user->getNotices(($this->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1);
-
-        return true;
     }
 
     function title()
@@ -110,81 +73,4 @@ class UsermapAction extends OwnerDesignAction
                            $this->page);
         }
     }
-
-    function handle($args)
-    {
-        parent::handle($args);
-        $this->showPage();
-    }
-
-    function showContent()
-    {
-        $this->element('div', array('id' => 'map_canvas',
-                                    'class' => 'gray smallmap',
-                                    'style' => "width: 100%; height: 400px"));
-    }
-
-    /**
-     * Hook for adding extra JavaScript
-     *
-     * @param Action $action Action object for the page
-     *
-     * @return boolean event handler return
-     */
-
-    function showScripts()
-    {
-        parent::showScripts();
-        $notice = empty($this->tag)
-          ? $this->user->getNotices(($this->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1)
-            : $this->user->getTaggedNotices($this->tag, ($this->page-1)*NOTICES_PER_PAGE, NOTICES_PER_PAGE + 1, 0, 0, null);
-
-        $jsonArray = array();
-
-        while ($notice->fetch()) {
-            if (!empty($notice->lat) && !empty($notice->lon)) {
-                $jsonNotice = $this->noticeAsJson($notice);
-                $jsonArray[] = $jsonNotice;
-            }
-        }
-
-        $this->elementStart('script', array('type' => 'text/javascript'));
-        $this->raw('/*<![CDATA[*/'); // XHTML compat for Safari
-        $this->raw('var _notices = ' . json_encode($jsonArray).'; ');
-        $this->raw('showMapstraction($("#map_canvas"),_notices);');
-        $this->raw('/*]]>*/'); // XHTML compat for Safari
-        $this->elementEnd('script');
-
-        return true;
-    }
-
-    function noticeAsJson($notice)
-    {
-        // FIXME: this code should be abstracted to a neutral third
-        // party, like Notice::asJson(). I'm not sure of the ethics
-        // of refactoring from within a plugin, so I'm just abusing
-        // the ApiAction method. Don't do this unless you're me!
-
-        require_once(INSTALLDIR.'/lib/api.php');
-
-        $act = new ApiAction('/dev/null');
-
-        $arr = $act->twitterStatusArray($notice, true);
-        $arr['url'] = $notice->bestUrl();
-        $arr['html'] = $notice->rendered;
-        $arr['source'] = $arr['source'];
-
-        if (!empty($notice->reply_to)) {
-            $reply_to = Notice::staticGet('id', $notice->reply_to);
-            if (!empty($reply_to)) {
-                $arr['in_reply_to_status_url'] = $reply_to->bestUrl();
-            }
-            $reply_to = null;
-        }
-
-        $profile = $notice->getProfile();
-        $arr['user']['profile_url'] = $profile->profileurl;
-
-        return $arr;
-    }
 }