SitemapPlugin.php 7.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
        case 'SitemapindexAction':
        case 'NoticesitemapAction':
        case 'UsersitemapAction':
74
        case 'SitemapadminpanelAction':
Evan Prodromou's avatar
Evan Prodromou committed
75 76 77 78
            require_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
            return false;
        case 'SitemapAction':
            require_once $dir . '/' . strtolower($cls) . '.php';
79
            return false;
Evan Prodromou's avatar
Evan Prodromou committed
80 81 82 83 84
        default:
            return true;
        }
    }

85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
    /**
     * 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
102 103 104 105 106 107 108 109 110 111 112 113
    /**
     * 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
114

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

122
        $m->connect('/user-sitemap-:year-:month-:day-:index.xml',
Evan Prodromou's avatar
Evan Prodromou committed
123
                    array('action' => 'usersitemap'),
Evan Prodromou's avatar
Evan Prodromou committed
124 125 126 127
                    array('year' => '[0-9]{4}',
                          'month' => '[01][0-9]',
                          'day' => '[0123][0-9]',
                          'index' => '[1-9][0-9]*'));
128 129 130 131

        $m->connect('admin/sitemap',
                    array('action' => 'sitemapadminpanel'));

Evan Prodromou's avatar
Evan Prodromou committed
132 133
        return true;
    }
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 163 164 165 166 167 168 169 170 171 172 173
    /**
     * Meta tags for "claiming" a site
     *
     * We add extra meta tags that search engines like Yahoo!, Google, and Bing
     * require to let you claim your site.
     *
     * @param Action $action Action being executed
     *
     * @return boolean hook value.
     */

    function onStartShowHeadElements($action)
    {
        $actionName = $action->trimmed('action');

        $singleUser = common_config('singleuser', 'enabled');

        // Different "top" pages if it's single user or not

        if (($singleUser && $actionName == 'showstream') ||
            (!$singleUser && $actionName == 'public')) {

            $keys = array('googlekey' => 'google-site-verification',
                          'yahookey' => 'y_key',
                          'bingkey' => 'msvalidate.01'); // XXX: is this the same for all sites?

            foreach ($keys as $config => $metaname) {
                $content = common_config('sitemap', $config);

                if (!empty($content)) {
                    $action->element('meta', array('name' => $metaname,
                                                   'content' => $content));
                }
            }
        }

        return true;
    }

174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
    /**
     * 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')));

205 206 207 208 209 210
        $userCreated = $schema->getColumnDef('user', 'created');

        if (empty($userCreated) || $userCreated->key != 'MUL') {
            $schema->createIndex('user', 'created');
        }

211 212
        return true;
    }
213 214 215 216 217 218 219 220 221 222 223

    function onEndAdminPanelNav($menu) {
        if (AdminPanelAction::canAdmin('sitemap')) {
            // TRANS: Menu item title/tooltip
            $menu_title = _('Sitemap configuration');
            // TRANS: Menu item for site administration
            $menu->out->menuItem(common_local_url('sitemapadminpanel'), _('Sitemap'),
                                 $menu_title, $action_name == 'sitemapadminpanel', 'nav_sitemap_admin_panel');
        }
        return true;
    }
Evan Prodromou's avatar
Evan Prodromou committed
224
}