]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/Sitemap/SitemapPlugin.php
Let DB_DataObject find Spam_score
[quix0rs-gnu-social.git] / 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 class SitemapPlugin extends Plugin
48 {
49     const USERS_PER_MAP   = 50000;
50     const NOTICES_PER_MAP = 50000;
51
52     /**
53      * Load related modules when needed
54      *
55      * @param string $cls Name of the class to be loaded
56      *
57      * @return boolean hook value; true means continue processing, false means stop.
58      */
59     function onAutoload($cls)
60     {
61         $dir = dirname(__FILE__);
62
63         switch ($cls)
64         {
65         case 'Sitemap_user_count':
66         case 'Sitemap_notice_count':
67             require_once $dir . '/' . $cls . '.php';
68             return false;
69         case 'SitemapindexAction':
70         case 'NoticesitemapAction':
71         case 'UsersitemapAction':
72         case 'SitemapadminpanelAction':
73             require_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
74             return false;
75         case 'SitemapAction':
76             require_once $dir . '/' . strtolower($cls) . '.php';
77             return false;
78         default:
79             return true;
80         }
81     }
82
83     /**
84      * Add sitemap-related information at the end of robots.txt
85      *
86      * @param Action $action Action being run
87      *
88      * @return boolean hook value.
89      */
90     function onEndRobotsTxt($action)
91     {
92         $url = common_local_url('sitemapindex');
93
94         print "\nSitemap: $url\n";
95
96         return true;
97     }
98
99     /**
100      * Map URLs to actions
101      *
102      * @param Net_URL_Mapper $m path-to-action mapper
103      *
104      * @return boolean hook value; true means continue processing, false means stop.
105      */
106     function onRouterInitialized($m)
107     {
108         $m->connect('sitemapindex.xml',
109                     array('action' => 'sitemapindex'));
110
111         $m->connect('notice-sitemap-:year-:month-:day-:index.xml',
112                     array('action' => 'noticesitemap'),
113                     array('year' => '[0-9]{4}',
114                           'month' => '[01][0-9]',
115                           'day' => '[0123][0-9]',
116                           'index' => '[1-9][0-9]*'));
117
118         $m->connect('user-sitemap-:year-:month-:day-:index.xml',
119                     array('action' => 'usersitemap'),
120                     array('year' => '[0-9]{4}',
121                           'month' => '[01][0-9]',
122                           'day' => '[0123][0-9]',
123                           'index' => '[1-9][0-9]*'));
124
125         $m->connect('panel/sitemap',
126                     array('action' => 'sitemapadminpanel'));
127
128         return true;
129     }
130
131     /**
132      * Meta tags for "claiming" a site
133      *
134      * We add extra meta tags that search engines like Yahoo!, Google, and Bing
135      * require to let you claim your site.
136      *
137      * @param Action $action Action being executed
138      *
139      * @return boolean hook value.
140      */
141     function onStartShowHeadElements($action)
142     {
143         $actionName = $action->trimmed('action');
144
145         $singleUser = common_config('singleuser', 'enabled');
146
147         // Different "top" pages if it's single user or not
148
149         if (($singleUser && $actionName == 'showstream') ||
150             (!$singleUser && $actionName == 'public')) {
151
152             $keys = array('googlekey' => 'google-site-verification',
153                           'yahookey' => 'y_key',
154                           'bingkey' => 'msvalidate.01'); // XXX: is this the same for all sites?
155
156             foreach ($keys as $config => $metaname) {
157                 $content = common_config('sitemap', $config);
158
159                 if (!empty($content)) {
160                     $action->element('meta', array('name' => $metaname,
161                                                    'content' => $content));
162                 }
163             }
164         }
165
166         return true;
167     }
168
169     /**
170      * Database schema setup
171      *
172      * We cache some data persistently to avoid overlong queries.
173      *
174      * @see Sitemap_user_count
175      * @see Sitemap_notice_count
176      *
177      * @return boolean hook value; true means continue processing, false means stop.
178      */
179     function onCheckSchema()
180     {
181         $schema = Schema::get();
182
183         $schema->ensureTable('sitemap_user_count',
184                              array(new ColumnDef('registration_date', 'date', null,
185                                                  true, 'PRI'),
186                                    new ColumnDef('user_count', 'integer'),
187                                    new ColumnDef('created', 'datetime',
188                                                  null, false),
189                                    new ColumnDef('modified', 'timestamp')));
190
191         $schema->ensureTable('sitemap_notice_count',
192                              array(new ColumnDef('notice_date', 'date', null,
193                                                  true, 'PRI'),
194                                    new ColumnDef('notice_count', 'integer'),
195                                    new ColumnDef('created', 'datetime',
196                                                  null, false),
197                                    new ColumnDef('modified', 'timestamp')));
198
199         return true;
200     }
201
202     function onEndAdminPanelNav($menu) {
203         if (AdminPanelAction::canAdmin('sitemap')) {
204             // TRANS: Menu item title/tooltip
205             $menu_title = _m('Sitemap configuration');
206             // TRANS: Menu item for site administration
207             $menu->out->menuItem(common_local_url('sitemapadminpanel'), _m('MENU','Sitemap'),
208                                  $menu_title, $action_name == 'sitemapadminpanel', 'nav_sitemap_admin_panel');
209         }
210         return true;
211     }
212
213     /**
214      * Provide plugin version information.
215      *
216      * This data is used when showing the version page.
217      *
218      * @param array &$versions array of version data arrays; see EVENTS.txt
219      *
220      * @return boolean hook value
221      */
222     function onPluginVersion(&$versions)
223     {
224         $url = 'http://status.net/wiki/Plugin:Sitemap';
225
226         $versions[] = array('name' => 'Sitemap',
227             'version' => STATUSNET_VERSION,
228             'author' => 'Evan Prodromou',
229             'homepage' => $url,
230             'rawdescription' =>
231             // TRANS: Plugin description.
232             _m('This plugin allows creation of sitemaps for Bing, Yahoo! and Google.'));
233
234         return true;
235     }
236 }