plugins/Sitemap/SitemapPlugin.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * Creates a dynamic sitemap for a StatusNet site
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Sample
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Sitemap plugin
  39  *
  40  * @category  Sample
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2010 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47
  48 class SitemapPlugin extends Plugin
  49 {
  50     const USERS_PER_MAP = 25000;
  51
  52     /**
  53      * Load related modules when needed
  54      *
  55      * @param string $cls Name of the class to be loaded
  56      *
  57      * @return boolean hook value; true means continue processing, false means stop.
  58      */
  59
  60     function onAutoload($cls)
  61     {
  62         $dir = dirname(__FILE__);
  63
  64         switch ($cls)
  65         {
  66         case 'SitemapindexAction':
  67         case 'NoticesitemapAction':
  68         case 'UsersitemapAction':
  69             require_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
  70             return false;
  71         case 'SitemapAction':
  72             require_once $dir . '/' . strtolower($cls) . '.php';
  73         default:
  74             return true;
  75         }
  76     }
  77
  78     /**
  79      * Map URLs to actions
  80      *
  81      * @param Net_URL_Mapper $m path-to-action mapper
  82      *
  83      * @return boolean hook value; true means continue processing, false means stop.
  84      */
  85
  86     function onRouterInitialized($m)
  87     {
  88         $m->connect('sitemapindex.xml',
  89                     array('action' => 'sitemapindex'));
  90
  91         $m->connect('/sitemaps/notice/:year/:month/:day/:index.xml',
  92                     array('action' => 'noticesitemap'),
  93                     array('year' => '[0-9]{4}',
  94                           'month' => '[01][0-9]',
  95                           'day' => '[0123][0-9]',
  96                           'index' => '[1-9][0-9]*'));
  97
  98         $m->connect('/sitemaps/user/:index.xml',
  99                     array('action' => 'usersitemap'),
 100                     array('index' => '[0-9]+',
 101                           'month' => '[1]?[0-9]',
 102                           'day' => '[123]?[0-9]'));
 103         return true;
 104     }
 105 }