git.gnu.io has moved to IP address 209.51.188.249 -- please double check where you are logging in.

SitemapPlugin.php 5.93 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
<?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
{
49 50
    const USERS_PER_MAP   = 50000;
    const NOTICES_PER_MAP = 50000;
51

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
    /**
     * 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
68 69 70
    /**
     * Map URLs to actions
     *
71
     * @param URLMapper $m path-to-action mapper
Evan Prodromou's avatar
Evan Prodromou committed
72 73 74
     *
     * @return boolean hook value; true means continue processing, false means stop.
     */
75
    public function onRouterInitialized(URLMapper $m)
Evan Prodromou's avatar
Evan Prodromou committed
76 77 78
    {
        $m->connect('sitemapindex.xml',
                    array('action' => 'sitemapindex'));
79

80
        $m->connect('notice-sitemap-:year-:month-:day-:index.xml',
Evan Prodromou's avatar
Evan Prodromou committed
81 82
                    array('action' => 'noticesitemap'),
                    array('year' => '[0-9]{4}',
83 84 85
                          'month' => '[01][0-9]',
                          'day' => '[0123][0-9]',
                          'index' => '[1-9][0-9]*'));
Evan Prodromou's avatar
Evan Prodromou committed
86

87
        $m->connect('user-sitemap-:year-:month-:day-:index.xml',
Evan Prodromou's avatar
Evan Prodromou committed
88
                    array('action' => 'usersitemap'),
89 90 91 92
                    array('year' => '[0-9]{4}',
                          'month' => '[01][0-9]',
                          'day' => '[0123][0-9]',
                          'index' => '[1-9][0-9]*'));
93

94
        $m->connect('panel/sitemap',
95 96
                    array('action' => 'sitemapadminpanel'));

Evan Prodromou's avatar
Evan Prodromou committed
97 98
        return true;
    }
99

100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
    /**
     * 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;
    }

138 139 140 141 142 143 144 145 146 147 148 149 150 151
    /**
     * 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();

152 153
        $schema->ensureTable('sitemap_user_count', Sitemap_user_count::schemaDef());
        $schema->ensureTable('sitemap_notice_count', Sitemap_notice_count::schemaDef());
154 155
        return true;
    }
156 157 158 159

    function onEndAdminPanelNav($menu) {
        if (AdminPanelAction::canAdmin('sitemap')) {
            // TRANS: Menu item title/tooltip
160
            $menu_title = _m('Sitemap configuration');
161
            // TRANS: Menu item for site administration
162
            $menu->out->menuItem(common_local_url('sitemapadminpanel'), _m('MENU','Sitemap'),
163 164 165 166
                                 $menu_title, $action_name == 'sitemapadminpanel', 'nav_sitemap_admin_panel');
        }
        return true;
    }
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181

    /**
     * Provide plugin version information.
     *
     * This data is used when showing the version page.
     *
     * @param array &$versions array of version data arrays; see EVENTS.txt
     *
     * @return boolean hook value
     */
    function onPluginVersion(&$versions)
    {
        $url = 'http://status.net/wiki/Plugin:Sitemap';

        $versions[] = array('name' => 'Sitemap',
182
            'version' => GNUSOCIAL_VERSION,
183 184 185 186 187 188 189 190
            'author' => 'Evan Prodromou',
            'homepage' => $url,
            'rawdescription' =>
            // TRANS: Plugin description.
            _m('This plugin allows creation of sitemaps for Bing, Yahoo! and Google.'));

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