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   = 50000;
  51     const NOTICES_PER_MAP = 50000;
  52
  53     /**
  54      * Load related modules when needed
  55      *
  56      * @param string $cls Name of the class to be loaded
  57      *
  58      * @return boolean hook value; true means continue processing, false means stop.
  59      */
  60
  61     function onAutoload($cls)
  62     {
  63         $dir = dirname(__FILE__);
  64
  65         switch ($cls)
  66         {
  67         case 'Sitemap_user_count':
  68         case 'Sitemap_notice_count':
  69             require_once $dir . '/' . $cls . '.php';
  70             return false;
  71         case 'SitemapindexAction':
  72         case 'NoticesitemapAction':
  73         case 'UsersitemapAction':
  74             require_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
  75             return false;
  76         case 'SitemapAction':
  77             require_once $dir . '/' . strtolower($cls) . '.php';
  78             return false;
  79         default:
  80             return true;
  81         }
  82     }
  83
  84     /**
  85      * Add sitemap-related information at the end of robots.txt
  86      *
  87      * @param Action $action Action being run
  88      *
  89      * @return boolean hook value.
  90      */
  91
  92     function onEndRobotsTxt($action)
  93     {
  94         $url = common_local_url('sitemapindex');
  95
  96         print "\nSitemap: $url\n";
  97
  98         return true;
  99     }
 100
 101     /**
 102      * Map URLs to actions
 103      *
 104      * @param Net_URL_Mapper $m path-to-action mapper
 105      *
 106      * @return boolean hook value; true means continue processing, false means stop.
 107      */
 108
 109     function onRouterInitialized($m)
 110     {
 111         $m->connect('sitemapindex.xml',
 112                     array('action' => 'sitemapindex'));
 113
 114         $m->connect('/notice-sitemap-:year-:month-:day-:index.xml',
 115                     array('action' => 'noticesitemap'),
 116                     array('year' => '[0-9]{4}',
 117                           'month' => '[01][0-9]',
 118                           'day' => '[0123][0-9]',
 119                           'index' => '[1-9][0-9]*'));
 120
 121         $m->connect('/user-sitemap-:year-:month-:day-:index.xml',
 122                     array('action' => 'usersitemap'),
 123                     array('year' => '[0-9]{4}',
 124                           'month' => '[01][0-9]',
 125                           'day' => '[0123][0-9]',
 126                           'index' => '[1-9][0-9]*'));
 127         return true;
 128     }
 129
 130     /**
 131      * Database schema setup
 132      *
 133      * We cache some data persistently to avoid overlong queries.
 134      *
 135      * @see Sitemap_user_count
 136      * @see Sitemap_notice_count
 137      *
 138      * @return boolean hook value; true means continue processing, false means stop.
 139      */
 140
 141     function onCheckSchema()
 142     {
 143         $schema = Schema::get();
 144
 145         $schema->ensureTable('sitemap_user_count',
 146                              array(new ColumnDef('registration_date', 'date', null,
 147                                                  true, 'PRI'),
 148                                    new ColumnDef('user_count', 'integer'),
 149                                    new ColumnDef('created', 'datetime',
 150                                                  null, false),
 151                                    new ColumnDef('modified', 'timestamp')));
 152
 153         $schema->ensureTable('sitemap_notice_count',
 154                              array(new ColumnDef('notice_date', 'date', null,
 155                                                  true, 'PRI'),
 156                                    new ColumnDef('notice_count', 'integer'),
 157                                    new ColumnDef('created', 'datetime',
 158                                                  null, false),
 159                                    new ColumnDef('modified', 'timestamp')));
 160
 161         return true;
 162     }
 163 }