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 addon 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 addon.
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
52 use Friendica\Core\Config;
53 use Friendica\Core\Hook;
54 use Friendica\Core\L10n;
55 use Friendica\Core\Logger;
56 use Friendica\Core\Renderer;
57 use Friendica\Core\System;
59 function blackout_install() {
60 Hook::register('page_header', 'addon/blackout/blackout.php', 'blackout_redirect');
63 function blackout_uninstall() {
64 Hook::unregister('page_header', 'addon/blackout/blackout.php', 'blackout_redirect');
66 function blackout_redirect ($a, $b) {
67 // if we have a logged in user, don't throw her out
72 if (! (version_compare(PHP_VERSION, '5.3.0') >= 0))
76 $mystart = Config::get('blackout','begindate');
77 $myend = Config::get('blackout','enddate');
78 $myurl = Config::get('blackout','url');
80 $date1 = DateTime::createFromFormat('Y-m-d G:i', $mystart);
81 $date2 = DateTime::createFromFormat('Y-m-d G:i', $myend);
82 if ( $date1 && $date2 ) {
83 $date1 = DateTime::createFromFormat('Y-m-d G:i', $mystart)->format('U');
84 $date2 = DateTime::createFromFormat('Y-m-d G:i', $myend)->format('U');
89 if (( $date1 <= $now ) && ( $now <= $date2 )) {
90 Logger::log('redirecting user to blackout page');
91 System::externalRedirect($myurl);
95 function blackout_addon_admin(&$a, &$o) {
96 $mystart = Config::get('blackout','begindate');
97 if (! is_string($mystart)) { $mystart = "YYYY-MM-DD:hhmm"; }
98 $myend = Config::get('blackout','enddate');
99 if (! is_string($myend)) { $myend = "YYYY-MM-DD:hhmm"; }
100 $myurl = Config::get('blackout','url');
101 if (! is_string($myurl)) { $myurl = "http://www.example.com"; }
102 $t = Renderer::getMarkupTemplate( "admin.tpl", "addon/blackout/" );
104 $o = Renderer::replaceMacros($t, [
105 '$submit' => L10n::t('Save Settings'),
106 '$rurl' => ["rurl", "Redirect URL", $myurl, "all your visitors from the web will be redirected to this URL"],
107 '$startdate' => ["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"],
108 '$enddate' => ["enddate", "End of the Blackout<br />(YYYY-MM-DD hh:mm)", $myend, ""],
111 $date1 = DateTime::createFromFormat('Y-m-d G:i', $mystart);
112 $date2 = DateTime::createFromFormat('Y-m-d G:i', $myend);
113 if ($date2 < $date1) {
114 $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;
116 $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;
119 function blackout_addon_admin_post (&$a) {
120 $begindate = trim($_POST['startdate']);
121 $enddate = trim($_POST['enddate']);
122 $url = trim($_POST['rurl']);
123 Config::set('blackout','begindate',$begindate);
124 Config::set('blackout','enddate',$enddate);
125 Config::set('blackout','url',$url);