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     /**
  51      * Load related modules when needed
  52      *
  53      * @param string $cls Name of the class to be loaded
  54      *
  55      * @return boolean hook value; true means continue processing, false means stop.
  56      */
  57
  58     function onAutoload($cls)
  59     {
  60         $dir = dirname(__FILE__);
  61
  62         switch ($cls)
  63         {
  64         case 'SitemapindexAction':
  65         case 'NoticesitemapAction':
  66         case 'UsersitemapAction':
  67             require_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
  68             return false;
  69         case 'SitemapAction':
  70             require_once $dir . '/' . strtolower($cls) . '.php';
  71         default:
  72             return true;
  73         }
  74     }
  75
  76     /**
  77      * Map URLs to actions
  78      *
  79      * @param Net_URL_Mapper $m path-to-action mapper
  80      *
  81      * @return boolean hook value; true means continue processing, false means stop.
  82      */
  83
  84     function onRouterInitialized($m)
  85     {
  86         $m->connect('sitemapindex.xml',
  87                     array('action' => 'sitemapindex'));
  88         $m->connect('/sitemaps/notice/:year/:month/:day/:index.xml',
  89                     array('action' => 'noticesitemap'),
  90                     array('year' => '[0-9]{4}',
  91                           'month' => '[01][0-9]',
  92                           'day' => '[0123][0-9]',
  93                           'index' => '[1-9][0-9]*'));
  94
  95         $m->connect('/sitemaps/user/:index.xml',
  96                     array('action' => 'usersitemap'),
  97                     array('index' => '[0-9]+',
  98                           'month' => '[1]?[0-9]',
  99                           'day' => '[123]?[0-9]'));
 100         return true;
 101     }
 102 }