summaryrefslogtreecommitdiff
path: root/plugins/Sitemap
diff options
context:
space:
mode:
authorEvan Prodromou <evan@status.net>2010-03-22 00:25:49 -0400
committerEvan Prodromou <evan@status.net>2010-06-01 13:52:27 -0700
commitce0e6cb50d88c593db62edd8375c4414e8a8ebf8 (patch)
treea03fac83e5e310b7eb4524833506770349c49cc3 /plugins/Sitemap
parenta5de2152672f49ad95f114033ef6bf00ece9a0ab (diff)
user sitemap
Diffstat (limited to 'plugins/Sitemap')
-rw-r--r--plugins/Sitemap/SitemapPlugin.php111
-rw-r--r--plugins/Sitemap/sitemapaction.php90
-rw-r--r--plugins/Sitemap/usersitemap.php79
3 files changed, 280 insertions, 0 deletions
diff --git a/plugins/Sitemap/SitemapPlugin.php b/plugins/Sitemap/SitemapPlugin.php
new file mode 100644
index 000000000..42ea1dbe6
--- /dev/null
+++ b/plugins/Sitemap/SitemapPlugin.php
@@ -0,0 +1,111 @@
+<?php
+/**
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2010, StatusNet, Inc.
+ *
+ * Creates a dynamic sitemap for a StatusNet site
+ *
+ * PHP version 5
+ *
+ * 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 Sample
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
+ * @copyright 2010 StatusNet, Inc.
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
+ * @link http://status.net/
+ */
+
+if (!defined('STATUSNET')) {
+ // This check helps protect against security problems;
+ // your code file can't be executed directly from the web.
+ exit(1);
+}
+
+/**
+ * Sitemap plugin
+ *
+ * @category Sample
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
+ * @copyright 2010 StatusNet, Inc.
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
+ * @link http://status.net/
+ */
+
+class SitemapPlugin extends Plugin
+{
+ /**
+ * Load related modules when needed
+ *
+ * Most non-trivial plugins will require extra modules to do their work. Typically
+ * these include data classes, action classes, widget classes, or external libraries.
+ *
+ * This method receives a class name and loads the PHP file related to that class. By
+ * tradition, action classes typically have files named for the action, all lower-case.
+ * Data classes are in files with the data class name, initial letter capitalized.
+ *
+ * Note that this method will be called for *all* overloaded classes, not just ones
+ * in this plugin! So, make sure to return true by default to let other plugins, and
+ * the core code, get a chance.
+ *
+ * @param string $cls Name of the class to be loaded
+ *
+ * @return boolean hook value; true means continue processing, false means stop.
+ */
+
+ function onAutoload($cls)
+ {
+ $dir = dirname(__FILE__);
+
+ switch ($cls)
+ {
+ case 'SitemapindexAction':
+ case 'NoticesitemapAction':
+ case 'UsersitemapAction':
+ require_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
+ return false;
+ case 'SitemapAction':
+ require_once $dir . '/' . strtolower($cls) . '.php';
+ default:
+ return true;
+ }
+ }
+
+ /**
+ * Map URLs to actions
+ *
+ * @param Net_URL_Mapper $m path-to-action mapper
+ *
+ * @return boolean hook value; true means continue processing, false means stop.
+ */
+
+ function onRouterInitialized($m)
+ {
+ $m->connect('sitemapindex.xml',
+ array('action' => 'sitemapindex'));
+ $m->connect('/sitemaps/notice/:year/:month/:day.xml',
+ array('action' => 'noticesitemap'),
+ array('year' => '[0-9]{4}',
+ 'month' => '[1]?[0-9]',
+ 'day' => '[123]?[0-9]'));
+ $m->connect('/sitemaps/user/:index.xml',
+ array('action' => 'usersitemap'),
+ array('index' => '[0-9]+',
+ 'month' => '[1]?[0-9]',
+ 'day' => '[123]?[0-9]'));
+ return true;
+ }
+}
diff --git a/plugins/Sitemap/sitemapaction.php b/plugins/Sitemap/sitemapaction.php
new file mode 100644
index 000000000..ab80b85ea
--- /dev/null
+++ b/plugins/Sitemap/sitemapaction.php
@@ -0,0 +1,90 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Superclass for sitemap-generating actions
+ *
+ * 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 Sitemap
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
+ * @copyright 2010 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);
+}
+
+/**
+ * superclass for sitemap actions
+ *
+ * @category Sitemap
+ * @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 SitemapAction extends Action
+{
+ /**
+ * handle the action
+ *
+ * @param array $args unused.
+ *
+ * @return void
+ */
+
+ function handle($args)
+ {
+ header('Content-Type: text/xml; charset=UTF-8');
+ $this->startXML();
+
+ $this->elementStart('sitemap');
+
+ while (list($url, $lm, $cf, $p) = $this->nextUrl()) {
+ $this->showUrl($url, $lm, $cf, $p);
+ }
+
+ $this->elementEnd('sitemap');
+
+ $this->endXML();
+ }
+
+ function showUrl($url, $lastMod=null, $changeFreq=null, $priority=null)
+ {
+ $this->elementStart('url');
+ $this->element('loc', null, $url);
+ if (!is_null($lastMod)) {
+ $this->element('lastmod', null, $lastMod);
+ }
+ if (!is_null($changeFreq)) {
+ $this->element('changefreq', null, $changeFreq);
+ }
+ if (!is_null($priority)) {
+ $this->element('priority', null, $priority);
+ }
+ $this->elementEnd('url');
+ }
+
+ function nextUrl()
+ {
+ return null;
+ }
+}
diff --git a/plugins/Sitemap/usersitemap.php b/plugins/Sitemap/usersitemap.php
new file mode 100644
index 000000000..582a13b66
--- /dev/null
+++ b/plugins/Sitemap/usersitemap.php
@@ -0,0 +1,79 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Show list of user pages
+ *
+ * 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 Sitemap
+ * @package StatusNet
+ * @author Evan Prodromou <evan@status.net>
+ * @copyright 2010 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);
+}
+
+/**
+ * sitemap for users
+ *
+ * @category Sitemap
+ * @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 UsersitemapAction extends SitemapAction
+{
+ const USERS_PER_MAP = 25000;
+
+ var $user = null;
+
+ function prepare($args)
+ {
+ parent::prepare($args);
+
+ $i = $this->trimmed('index');
+
+ $i += 0;
+
+ $offset = ($i-1) * self::USERS_PER_MAP;
+ $limit = self::USERS_PER_MAP;
+
+ $this->user = new User();
+
+ $this->user->orderBy('id');
+ $this->user->limit($offset, $limit);
+
+ $this->user->find();
+
+ return true;
+ }
+
+ function nextUrl()
+ {
+ if ($this->user->fetch()) {
+ return array(common_profile_url($this->user->nickname), null, null, null);
+ } else {
+ return null;
+ }
+ }
+}