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         case 'SitemapadminpanelAction':
  75             require_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
  76             return false;
  77         case 'SitemapAction':
  78             require_once $dir . '/' . strtolower($cls) . '.php';
  79             return false;
  80         default:
  81             return true;
  82         }
  83     }
  84
  85     /**
  86      * Add sitemap-related information at the end of robots.txt
  87      *
  88      * @param Action $action Action being run
  89      *
  90      * @return boolean hook value.
  91      */
  92
  93     function onEndRobotsTxt($action)
  94     {
  95         $url = common_local_url('sitemapindex');
  96
  97         print "\nSitemap: $url\n";
  98
  99         return true;
 100     }
 101
 102     /**
 103      * Map URLs to actions
 104      *
 105      * @param Net_URL_Mapper $m path-to-action mapper
 106      *
 107      * @return boolean hook value; true means continue processing, false means stop.
 108      */
 109
 110     function onRouterInitialized($m)
 111     {
 112         $m->connect('sitemapindex.xml',
 113                     array('action' => 'sitemapindex'));
 114
 115         $m->connect('/notice-sitemap-:year-:month-:day-:index.xml',
 116                     array('action' => 'noticesitemap'),
 117                     array('year' => '[0-9]{4}',
 118                           'month' => '[01][0-9]',
 119                           'day' => '[0123][0-9]',
 120                           'index' => '[1-9][0-9]*'));
 121
 122         $m->connect('/user-sitemap-:year-:month-:day-:index.xml',
 123                     array('action' => 'usersitemap'),
 124                     array('year' => '[0-9]{4}',
 125                           'month' => '[01][0-9]',
 126                           'day' => '[0123][0-9]',
 127                           'index' => '[1-9][0-9]*'));
 128
 129         $m->connect('admin/sitemap',
 130                     array('action' => 'sitemapadminpanel'));
 131
 132         return true;
 133     }
 134
 135     /**
 136      * Meta tags for "claiming" a site
 137      *
 138      * We add extra meta tags that search engines like Yahoo!, Google, and Bing
 139      * require to let you claim your site.
 140      *
 141      * @param Action $action Action being executed
 142      *
 143      * @return boolean hook value.
 144      */
 145
 146     function onStartShowHeadElements($action)
 147     {
 148         $actionName = $action->trimmed('action');
 149
 150         $singleUser = common_config('singleuser', 'enabled');
 151
 152         // Different "top" pages if it's single user or not
 153
 154         if (($singleUser && $actionName == 'showstream') ||
 155             (!$singleUser && $actionName == 'public')) {
 156
 157             $keys = array('googlekey' => 'google-site-verification',
 158                           'yahookey' => 'y_key',
 159                           'bingkey' => 'msvalidate.01'); // XXX: is this the same for all sites?
 160
 161             foreach ($keys as $config => $metaname) {
 162                 $content = common_config('sitemap', $config);
 163
 164                 if (!empty($content)) {
 165                     $action->element('meta', array('name' => $metaname,
 166                                                    'content' => $content));
 167                 }
 168             }
 169         }
 170
 171         return true;
 172     }
 173
 174     /**
 175      * Database schema setup
 176      *
 177      * We cache some data persistently to avoid overlong queries.
 178      *
 179      * @see Sitemap_user_count
 180      * @see Sitemap_notice_count
 181      *
 182      * @return boolean hook value; true means continue processing, false means stop.
 183      */
 184
 185     function onCheckSchema()
 186     {
 187         $schema = Schema::get();
 188
 189         $schema->ensureTable('sitemap_user_count',
 190                              array(new ColumnDef('registration_date', 'date', null,
 191                                                  true, 'PRI'),
 192                                    new ColumnDef('user_count', 'integer'),
 193                                    new ColumnDef('created', 'datetime',
 194                                                  null, false),
 195                                    new ColumnDef('modified', 'timestamp')));
 196
 197         $schema->ensureTable('sitemap_notice_count',
 198                              array(new ColumnDef('notice_date', 'date', null,
 199                                                  true, 'PRI'),
 200                                    new ColumnDef('notice_count', 'integer'),
 201                                    new ColumnDef('created', 'datetime',
 202                                                  null, false),
 203                                    new ColumnDef('modified', 'timestamp')));
 204
 205         return true;
 206     }
 207
 208     function onEndAdminPanelNav($menu) {
 209         if (AdminPanelAction::canAdmin('sitemap')) {
 210             // TRANS: Menu item title/tooltip
 211             $menu_title = _('Sitemap configuration');
 212             // TRANS: Menu item for site administration
 213             $menu->out->menuItem(common_local_url('sitemapadminpanel'), _('Sitemap'),
 214                                  $menu_title, $action_name == 'sitemapadminpanel', 'nav_sitemap_admin_panel');
 215         }
 216         return true;
 217     }
 218 }