]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/Sample/SamplePlugin.php
OStatus: fix regressions from merge
[quix0rs-gnu-social.git] / plugins / Sample / SamplePlugin.php
1 <?php
2 /**
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2009, StatusNet, Inc.
5  *
6  * A sample module to show best practices for StatusNet plugins
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    Brion Vibber <brionv@status.net>
26  * @author    Evan Prodromou <evan@status.net>
27  * @copyright 2009 StatusNet, Inc.
28  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
29  * @link      http://status.net/
30  */
31
32 if (!defined('STATUSNET')) {
33     // This check helps protect against security problems;
34     // your code file can't be executed directly from the web.
35     exit(1);
36 }
37
38 /**
39  * Sample plugin main class
40  *
41  * Each plugin requires a main class to interact with the StatusNet system.
42  *
43  * The main class usually extends the Plugin class that comes with StatusNet.
44  *
45  * The class has standard-named methods that will be called when certain events
46  * happen in the code base. These methods have names like 'onX' where X is an
47  * event name (see EVENTS.txt for the list of available events). Event handlers
48  * have pre-defined arguments, based on which event they're handling. A typical
49  * event handler:
50  *
51  *    function onSomeEvent($paramA, &$paramB)
52  *    {
53  *        if ($paramA == 'jed') {
54  *            throw new Exception(sprintf(_m("Invalid parameter %s"), $paramA));
55  *        }
56  *        $paramB = 'spock';
57  *        return true;
58  *    }
59  *
60  * Event handlers must return a boolean value. If they return false, all other
61  * event handlers for this event (in other plugins) will be skipped, and in some
62  * cases the default processing for that event would be skipped. This is great for
63  * replacing the default action of an event.
64  *
65  * If the handler returns true, processing of other event handlers and the default
66  * processing will continue. This is great for extending existing functionality.
67  *
68  * If the handler throws an exception, processing will stop, and the exception's
69  * error will be shown to the user.
70  *
71  * To install a plugin (like this one), site admins add the following code to
72  * their config.php file:
73  *
74  *     addPlugin('Sample');
75  *
76  * Plugins must be installed in one of the following directories:
77  *
78  *     local/plugins/{$pluginclass}.php
79  *     local/plugins/{$name}/{$pluginclass}.php
80  *     local/{$pluginclass}.php
81  *     local/{$name}/{$pluginclass}.php
82  *     plugins/{$pluginclass}.php
83  *     plugins/{$name}/{$pluginclass}.php
84  *
85  * Here, {$name} is the name of the plugin, like 'Sample', and {$pluginclass} is
86  * the name of the main class, like 'SamplePlugin'. Plugins that are part of the
87  * main StatusNet distribution go in 'plugins' and third-party or local ones go
88  * in 'local'.
89  *
90  * Simple plugins can be implemented as a single module. Others are more complex
91  * and require additional modules; these should use their own directory, like
92  * 'local/plugins/{$name}/'. All files related to the plugin, including images,
93  * JavaScript, CSS, external libraries or PHP modules should go in the plugin
94  * directory.
95  *
96  * @category  Sample
97  * @package   StatusNet
98  * @author    Brion Vibber <brionv@status.net>
99  * @author    Evan Prodromou <evan@status.net>
100  * @copyright 2009 StatusNet, Inc.
101  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
102  * @link      http://status.net/
103  */
104
105 class SamplePlugin extends Plugin
106 {
107     /**
108      * Plugins are configured using public instance attributes. To set
109      * their values, site administrators use this syntax:
110      *
111      * addPlugin('Sample', array('attr1' => 'foo', 'attr2' => 'bar'));
112      *
113      * The same plugin class can be initialized multiple times with different
114      * arguments:
115      *
116      * addPlugin('EmailNotify', array('sendTo' => 'evan@status.net'));
117      * addPlugin('EmailNotify', array('sendTo' => 'brionv@status.net'));
118      *
119      */
120
121     public $attr1 = null;
122     public $attr2 = null;
123
124     /**
125      * Initializer for this plugin
126      *
127      * Plugins overload this method to do any initialization they need,
128      * like connecting to remote servers or creating paths or so on.
129      *
130      * @return boolean hook value; true means continue processing, false means stop.
131      */
132
133     function initialize()
134     {
135         return true;
136     }
137
138     /**
139      * Cleanup for this plugin
140      *
141      * Plugins overload this method to do any cleanup they need,
142      * like disconnecting from remote servers or deleting temp files or so on.
143      *
144      * @return boolean hook value; true means continue processing, false means stop.
145      */
146
147     function cleanup()
148     {
149         return true;
150     }
151
152     /**
153      * Database schema setup
154      *
155      * Plugins can add their own tables to the StatusNet database. Plugins
156      * should use StatusNet's schema interface to add or delete tables. The
157      * ensureTable() method provides an easy way to ensure a table's structure
158      * and availability.
159      *
160      * By default, the schema is checked every time StatusNet is run (say, when
161      * a Web page is hit). Admins can configure their systems to only check the
162      * schema when the checkschema.php script is run, greatly improving performance.
163      * However, they need to remember to run that script after installing or
164      * upgrading a plugin!
165      *
166      * @see Schema
167      * @see ColumnDef
168      *
169      * @return boolean hook value; true means continue processing, false means stop.
170      */
171
172     function onCheckSchema()
173     {
174         $schema = Schema::get();
175
176         // For storing user-submitted flags on profiles
177
178         $schema->ensureTable('user_greeting_count',
179                              array(new ColumnDef('user_id', 'integer', null,
180                                                  true, 'PRI'),
181                                    new ColumnDef('greeting_count', 'integer')));
182
183         return true;
184     }
185
186     /**
187      * Load related modules when needed
188      *
189      * Most non-trivial plugins will require extra modules to do their work. Typically
190      * these include data classes, action classes, widget classes, or external libraries.
191      *
192      * This method receives a class name and loads the PHP file related to that class. By
193      * tradition, action classes typically have files named for the action, all lower-case.
194      * Data classes are in files with the data class name, initial letter capitalized.
195      *
196      * Note that this method will be called for *all* overloaded classes, not just ones
197      * in this plugin! So, make sure to return true by default to let other plugins, and
198      * the core code, get a chance.
199      *
200      * @param string $cls Name of the class to be loaded
201      *
202      * @return boolean hook value; true means continue processing, false means stop.
203      */
204
205     function onAutoload($cls)
206     {
207         $dir = dirname(__FILE__);
208
209         switch ($cls)
210         {
211         case 'HelloAction':
212             include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
213             return false;
214         case 'User_greeting_count':
215             include_once $dir . '/'.$cls.'.php';
216             return false;
217         default:
218             return true;
219         }
220     }
221
222     /**
223      * Map URLs to actions
224      *
225      * This event handler lets the plugin map URLs on the site to actions (and
226      * thus an action handler class). Note that the action handler class for an
227      * action will be named 'FoobarAction', where action = 'foobar'. The class
228      * must be loaded in the onAutoload() method.
229      *
230      * @param Net_URL_Mapper $m path-to-action mapper
231      *
232      * @return boolean hook value; true means continue processing, false means stop.
233      */
234
235     function onRouterInitialized($m)
236     {
237         $m->connect('main/hello',
238                     array('action' => 'hello'));
239         return true;
240     }
241
242     /**
243      * Modify the default menu to link to our custom action
244      *
245      * Using event handlers, it's possible to modify the default UI for pages
246      * almost without limit. In this method, we add a menu item to the default
247      * primary menu for the interface to link to our action.
248      *
249      * The Action class provides a rich set of events to hook, as well as output
250      * methods.
251      *
252      * @param Action $action The current action handler. Use this to
253      *                       do any output.
254      *
255      * @return boolean hook value; true means continue processing, false means stop.
256      *
257      * @see Action
258      */
259
260     function onEndPrimaryNav($action)
261     {
262         // common_local_url() gets the correct URL for the action name
263         // we provide
264
265         $action->menuItem(common_local_url('hello'),
266                           _m('Hello'), _m('A warm greeting'), false, 'nav_hello');
267         return true;
268     }
269
270     function onPluginVersion(&$versions)
271     {
272         $versions[] = array('name' => 'Sample',
273                             'version' => STATUSNET_VERSION,
274                             'author' => 'Brion Vibber, Evan Prodromou',
275                             'homepage' => 'http://status.net/wiki/Plugin:Sample',
276                             'rawdescription' =>
277                             _m('A sample plugin to show basics of development for new hackers.'));
278         return true;
279     }
280 }
281