SitemapPlugin.php 5.07 KB
Newer Older
Evan Prodromou's avatar
Evan Prodromou committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
<?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
{
50 51
    const USERS_PER_MAP   = 50000;
    const NOTICES_PER_MAP = 50000;
Evan Prodromou's avatar
Evan Prodromou committed
52

Evan Prodromou's avatar
Evan Prodromou committed
53 54 55 56 57 58 59 60 61 62 63 64 65 66
    /**
     * Load related modules when needed
     *
     * @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)
        {
67
        case 'Sitemap_user_count':
Evan Prodromou's avatar
Evan Prodromou committed
68
        case 'Sitemap_notice_count':
69 70
            require_once $dir . '/' . $cls . '.php';
            return false;
Evan Prodromou's avatar
Evan Prodromou committed
71 72 73 74 75 76 77
        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';
78
            return false;
Evan Prodromou's avatar
Evan Prodromou committed
79 80 81 82 83
        default:
            return true;
        }
    }

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
    /**
     * Add sitemap-related information at the end of robots.txt
     *
     * @param Action $action Action being run
     *
     * @return boolean hook value.
     */

    function onEndRobotsTxt($action)
    {
        $url = common_local_url('sitemapindex');

        print "\nSitemap: $url\n";

        return true;
    }

Evan Prodromou's avatar
Evan Prodromou committed
101 102 103 104 105 106 107 108 109 110 111 112
    /**
     * 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'));
Evan Prodromou's avatar
Evan Prodromou committed
113

114
        $m->connect('/notice-sitemap-:year-:month-:day-:index.xml',
Evan Prodromou's avatar
Evan Prodromou committed
115 116
                    array('action' => 'noticesitemap'),
                    array('year' => '[0-9]{4}',
117 118 119
                          'month' => '[01][0-9]',
                          'day' => '[0123][0-9]',
                          'index' => '[1-9][0-9]*'));
Evan Prodromou's avatar
Evan Prodromou committed
120

121
        $m->connect('/user-sitemap-:year-:month-:day-:index.xml',
Evan Prodromou's avatar
Evan Prodromou committed
122
                    array('action' => 'usersitemap'),
Evan Prodromou's avatar
Evan Prodromou committed
123 124 125 126
                    array('year' => '[0-9]{4}',
                          'month' => '[01][0-9]',
                          'day' => '[0123][0-9]',
                          'index' => '[1-9][0-9]*'));
Evan Prodromou's avatar
Evan Prodromou committed
127 128
        return true;
    }
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162

    /**
     * Database schema setup
     *
     * We cache some data persistently to avoid overlong queries.
     *
     * @see Sitemap_user_count
     * @see Sitemap_notice_count
     *
     * @return boolean hook value; true means continue processing, false means stop.
     */

    function onCheckSchema()
    {
        $schema = Schema::get();

        $schema->ensureTable('sitemap_user_count',
                             array(new ColumnDef('registration_date', 'date', null,
                                                 true, 'PRI'),
                                   new ColumnDef('user_count', 'integer'),
                                   new ColumnDef('created', 'datetime',
                                                 null, false),
                                   new ColumnDef('modified', 'timestamp')));

        $schema->ensureTable('sitemap_notice_count',
                             array(new ColumnDef('notice_date', 'date', null,
                                                 true, 'PRI'),
                                   new ColumnDef('notice_count', 'integer'),
                                   new ColumnDef('created', 'datetime',
                                                 null, false),
                                   new ColumnDef('modified', 'timestamp')));

        return true;
    }
Evan Prodromou's avatar
Evan Prodromou committed
163
}