4 * Description: Blackout your ~friendica node during a given period, requires PHP >= 5.3
7 * Author: Tobias Diekershoff <https://f.diekershoff.de/~tobias>
12 * This plugin will allow you to enter a date/time period during which
13 * all your ~friendica visitors from the web will be redirected to a page
14 * you can configure in the admin panel as well.
16 * Calls to the API and the communication with other ~friendica nodes is
17 * not effected from this plugin.
19 * If you enter a period the current date would be affected none of the
20 * currently logged in users will be effected as well. But if they log
21 * out they can't login again. That way you dear admin can double check
22 * the entered time periode and fix typos without having to hack the
28 * THIS ADDON REQUIRES PHP VERSION 5.3 OR HIGHER.
33 * Permission is hereby granted, free of charge, to any person obtaining a copy
34 * of this software and associated documentation files (the "Software"), to deal
35 * in the Software without restriction, including without limitation the rights
36 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
37 * copies of the Software, and to permit persons to whom the Software is
38 * furnished to do so, subject to the following conditions:
40 * The above copyright notice and this permission notice shall be included in
41 * all copies or substantial portions of the Software.
43 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
44 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
45 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
46 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
47 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
48 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
53 function blackout_install() {
54 register_hook('page_header', 'addon/blackout/blackout.php', 'blackout_redirect');
57 function blackout_uninstall() {
58 unregister_hook('page_header', 'addon/blackout/blackout.php', 'blackout_redirect');
60 function blackout_redirect ($a, $b) {
61 // if we have a logged in user, don't throw her out
66 if (! (version_compare(PHP_VERSION, '5.3.0') >= 0))
70 $mystart = get_config('blackout','begindate');
71 $myend = get_config('blackout','enddate');
72 $myurl = get_config('blackout','url');
74 $date1 = DateTime::createFromFormat('Y-m-d G:i', $mystart);
75 $date2 = DateTime::createFromFormat('Y-m-d G:i', $myend);
76 if ( $date1 && $date2 ) {
77 $date1 = DateTime::createFromFormat('Y-m-d G:i', $mystart)->format('U');
78 $date2 = DateTime::createFromFormat('Y-m-d G:i', $myend)->format('U');
83 if (( $date1 <= $now ) && ( $now <= $date2 )) {
84 logger('redirecting user to blackout page');
89 function blackout_plugin_admin(&$a, &$o) {
90 $mystart = get_config('blackout','begindate');
91 if (! is_string($mystart)) { $mystart = "YYYY-MM-DD:hhmm"; }
92 $myend = get_config('blackout','enddate');
93 if (! is_string($myend)) { $myend = "YYYY-MM-DD:hhmm"; }
94 $myurl = get_config('blackout','url');
95 if (! is_string($myurl)) { $myurl = "http://www.example.com"; }
96 $t = get_markup_template( "admin.tpl", "addon/blackout/" );
98 $o = replace_macros($t, array(
99 '$submit' => t('Save Settings'),
100 '$rurl' => array("rurl", "Redirect URL", $myurl, "all your visitors from the web will be redirected to this URL"),
101 '$startdate' => array("startdate", "Begin of the Blackout<br />(YYYY-MM-DD hh:mm)", $mystart, "format is <em>YYYY</em> year, <em>MM</em> month, <em>DD</em> day, <em>hh</em> hour and <em>mm</em> minute"),
102 '$enddate' => array("enddate", "End of the Blackout<br />(YYYY-MM-DD hh:mm)", $myend, ""),
105 $date1 = DateTime::createFromFormat('Y-m-d G:i', $mystart);
106 $date2 = DateTime::createFromFormat('Y-m-d G:i', $myend);
107 if ($date2 < $date1) {
108 $o = "<div style='border: 2px solid #f00; bakckground: #b00; text-align: center; padding: 10px; margin: 30px;'>The end-date is prior to the start-date of the blackout, you should fix this.</div>" . $o;
110 $o = '<p>Please double check that the current settings for the blackout. Begin will be <strong>'.$mystart.'</strong> and it will end <strong>'.$myend.'</strong>.</p>' . $o;
113 function blackout_plugin_admin_post (&$a) {
114 $begindate = trim($_POST['startdate']);
115 $enddate = trim($_POST['enddate']);
116 $url = trim($_POST['rurl']);
117 set_config('blackout','begindate',$begindate);
118 set_config('blackout','enddate',$enddate);
119 set_config('blackout','url',$url);