2012-02-08 08:22:11 +00:00
< ? php
/**
* Name : blackout
2012-05-11 10:39:29 +00:00
* Description : Blackout your ~ friendica node during a given period , requires PHP >= 5.3
2012-02-08 08:22:11 +00:00
* License : MIT
* Version : 1.0
2013-06-14 17:40:10 +00:00
* Author : Tobias Diekershoff < https :// f . diekershoff . de /~ tobias >
2012-02-08 08:22:11 +00:00
*
* About
* =====
*
2018-01-20 13:57:41 +00:00
* This addon will allow you to enter a date / time period during which
2012-02-08 08:22:11 +00:00
* all your ~ friendica visitors from the web will be redirected to a page
* you can configure in the admin panel as well .
*
* Calls to the API and the communication with other ~ friendica nodes is
2018-01-20 13:57:41 +00:00
* not effected from this addon .
2012-02-08 08:22:11 +00:00
*
* If you enter a period the current date would be affected none of the
* currently logged in users will be effected as well . But if they log
* out they can ' t login again . That way you dear admin can double check
* the entered time periode and fix typos without having to hack the
* database directly .
*
* Requirements
* ============
*
* THIS ADDON REQUIRES PHP VERSION 5.3 OR HIGHER .
*
* License
* =======
*
* Permission is hereby granted , free of charge , to any person obtaining a copy
* of this software and associated documentation files ( the " Software " ), to deal
* in the Software without restriction , including without limitation the rights
* to use , copy , modify , merge , publish , distribute , sublicense , and / or sell
* copies of the Software , and to permit persons to whom the Software is
* furnished to do so , subject to the following conditions :
2018-01-15 13:15:33 +00:00
*
2012-02-08 08:22:11 +00:00
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software .
2018-01-15 13:15:33 +00:00
*
2012-02-08 08:22:11 +00:00
* THE SOFTWARE IS PROVIDED " AS IS " , WITHOUT WARRANTY OF ANY KIND , EXPRESS OR
* IMPLIED , INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY ,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT . IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM , DAMAGES OR OTHER
* LIABILITY , WHETHER IN AN ACTION OF CONTRACT , TORT OR OTHERWISE , ARISING FROM ,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE .
*/
2017-11-06 23:55:24 +00:00
use Friendica\Core\Config ;
2018-12-26 07:28:16 +00:00
use Friendica\Core\Hook ;
2018-01-22 19:03:11 +00:00
use Friendica\Core\L10n ;
2018-10-29 23:40:18 +00:00
use Friendica\Core\Logger ;
2018-10-31 14:55:15 +00:00
use Friendica\Core\Renderer ;
2018-10-13 18:05:05 +00:00
use Friendica\Core\System ;
2012-02-08 08:22:11 +00:00
function blackout_install () {
2018-12-26 07:28:16 +00:00
Hook :: register ( 'page_header' , 'addon/blackout/blackout.php' , 'blackout_redirect' );
2012-02-08 08:22:11 +00:00
}
function blackout_uninstall () {
2018-12-26 07:28:16 +00:00
Hook :: unregister ( 'page_header' , 'addon/blackout/blackout.php' , 'blackout_redirect' );
2012-02-08 08:22:11 +00:00
}
function blackout_redirect ( $a , $b ) {
// if we have a logged in user, don't throw her out
if ( local_user ()) {
return true ;
}
2012-05-11 10:39:29 +00:00
if ( ! ( version_compare ( PHP_VERSION , '5.3.0' ) >= 0 ))
return true ;
2012-02-08 08:22:11 +00:00
// else...
2017-11-06 23:55:24 +00:00
$mystart = Config :: get ( 'blackout' , 'begindate' );
$myend = Config :: get ( 'blackout' , 'enddate' );
$myurl = Config :: get ( 'blackout' , 'url' );
2012-02-08 08:22:11 +00:00
$now = time ();
$date1 = DateTime :: createFromFormat ( 'Y-m-d G:i' , $mystart );
$date2 = DateTime :: createFromFormat ( 'Y-m-d G:i' , $myend );
if ( $date1 && $date2 ) {
$date1 = DateTime :: createFromFormat ( 'Y-m-d G:i' , $mystart ) -> format ( 'U' );
$date2 = DateTime :: createFromFormat ( 'Y-m-d G:i' , $myend ) -> format ( 'U' );
} else {
$date1 = 0 ;
$date2 = 0 ;
}
if (( $date1 <= $now ) && ( $now <= $date2 )) {
2018-10-13 18:05:05 +00:00
logger ( 'redirecting user to blackout page' );
System :: redirectTo ( $myurl );
2012-02-08 08:22:11 +00:00
}
}
2018-01-20 13:57:41 +00:00
function blackout_addon_admin ( & $a , & $o ) {
2017-11-06 23:55:24 +00:00
$mystart = Config :: get ( 'blackout' , 'begindate' );
2012-02-08 08:22:11 +00:00
if ( ! is_string ( $mystart )) { $mystart = " YYYY-MM-DD:hhmm " ; }
2017-11-06 23:55:24 +00:00
$myend = Config :: get ( 'blackout' , 'enddate' );
2012-02-08 08:22:11 +00:00
if ( ! is_string ( $myend )) { $myend = " YYYY-MM-DD:hhmm " ; }
2017-11-06 23:55:24 +00:00
$myurl = Config :: get ( 'blackout' , 'url' );
2012-02-08 08:22:11 +00:00
if ( ! is_string ( $myurl )) { $myurl = " http://www.example.com " ; }
2018-10-31 14:55:15 +00:00
$t = Renderer :: getMarkupTemplate ( " admin.tpl " , " addon/blackout/ " );
2018-01-15 13:15:33 +00:00
2018-10-31 14:55:15 +00:00
$o = Renderer :: replaceMacros ( $t , [
2018-01-22 19:03:11 +00:00
'$submit' => L10n :: t ( 'Save Settings' ),
2018-01-15 13:15:33 +00:00
'$rurl' => [ " rurl " , " Redirect URL " , $myurl , " all your visitors from the web will be redirected to this URL " ],
'$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 " ],
'$enddate' => [ " enddate " , " End of the Blackout<br />(YYYY-MM-DD hh:mm) " , $myend , " " ],
2012-02-08 08:22:11 +00:00
2018-01-15 13:15:33 +00:00
]);
2012-02-08 08:22:11 +00:00
$date1 = DateTime :: createFromFormat ( 'Y-m-d G:i' , $mystart );
$date2 = DateTime :: createFromFormat ( 'Y-m-d G:i' , $myend );
if ( $date2 < $date1 ) {
$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 ;
} else {
$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 ;
}
}
2018-01-20 13:57:41 +00:00
function blackout_addon_admin_post ( & $a ) {
2012-02-08 08:22:11 +00:00
$begindate = trim ( $_POST [ 'startdate' ]);
$enddate = trim ( $_POST [ 'enddate' ]);
$url = trim ( $_POST [ 'rurl' ]);
2017-11-06 23:55:24 +00:00
Config :: set ( 'blackout' , 'begindate' , $begindate );
Config :: set ( 'blackout' , 'enddate' , $enddate );
Config :: set ( 'blackout' , 'url' , $url );
2012-02-08 08:22:11 +00:00
}