36 Commits

Author SHA1 Message Date
bdf9052535 fix state disable problem, see Forum #1106857 2021-01-04 14:57:08 +01:00
6c715e9b5d add support for synology station 2021-01-04 14:06:22 +01:00
48758f31ab change output string 2020-11-09 08:15:01 +01:00
631be8174f change notify log output 2020-11-09 08:11:54 +01:00
6d01e89d5b fix typo 2020-11-09 08:07:30 +01:00
2692c1bceb set output in double quots 2020-11-09 08:00:08 +01:00
a07173e5a9 add hooks 2020-11-09 06:44:28 +01:00
08a76d09a8 change age value for condition 2020-11-06 11:03:24 +01:00
da3582fb1e fix parsing regex 2020-11-05 05:58:20 +01:00
cbca8d4337 fix multiple calls fn _CheckIsDisabledAfterSetAttr by events from other
devices
2020-11-03 13:46:24 +01:00
ec4e32d2fb change version 2020-11-03 13:19:36 +01:00
f0da4a3e70 expand curl cmd for self signed certificate 2020-11-02 21:48:00 +01:00
c897299103 add mor support for disable and disabledForIntervals
add check IsDisabled function
2020-10-30 15:19:18 +01:00
4cd8b0ecea change error handling, add attributs disable and disabledForIntervals 2020-10-28 19:14:44 +01:00
c28ae2e245 add attributs disable and disabledForIntervals 2020-10-24 10:08:08 +02:00
7ae03846bf change state event then set active 2020-10-24 10:04:27 +02:00
1f3ab13b0c add condition for setter 2020-10-24 09:59:57 +02:00
0e1468a032 fix setter bug 2020-10-24 09:56:33 +02:00
37673b2da1 fix undefined fn 2020-10-24 09:53:39 +02:00
914c08850e add active,inactive setter for disable routine 2020-10-24 09:50:31 +02:00
c408ff36a2 fix little bug 2020-10-21 09:21:37 +02:00
b02ce13d59 change fn Log to print 2020-10-21 09:16:30 +02:00
674e9dce8f fix "Global symbol "$name" requires explicit package name" 2020-10-21 09:05:34 +02:00
138ee2145f add log output to FileUpload Fn 2020-10-21 09:01:15 +02:00
6dde3f7152 add asynchronous result in log output 2020-10-20 20:07:43 +02:00
8460bc4a3e change attribut for appclication transport protocol 2020-10-20 15:50:37 +02:00
dc0c072ab5 add application protocol attribut for HTTP 2020-10-20 15:45:33 +02:00
16f8bdbce8 change readings age condition 2020-10-19 19:32:14 +02:00
89b9d579c5 add more log output 2020-10-19 15:27:52 +02:00
8f8e306e85 add use Meta 2020-10-19 09:19:10 +02:00
1a0553b92d change version 2020-10-16 07:42:01 +02:00
d9bb3c4729 fix default value in ReadingsAge Fn 2020-10-15 14:09:37 +02:00
a5084429b0 fix ReadingsAge Fn deklaration 2020-10-15 14:04:19 +02:00
18801f0a8f fix syntax error 2020-10-15 14:00:25 +02:00
2aa7914642 add condition for readings age from fhemBackupFile
no backup to storage then backup befor update run
2020-10-15 13:53:24 +02:00
57d95d6141 fix logoutput typo 2020-10-15 13:37:22 +02:00
4 changed files with 233 additions and 80 deletions

View File

@ -34,6 +34,7 @@ package main;
use strict;
use warnings;
use utf8;
use FHEM::Meta;
use FHEM::backupToStorage;
@ -46,6 +47,7 @@ sub backupToStorage_Initialize {
$hash->{DefFn} = \&FHEM::backupToStorage::Define;
$hash->{NotifyFn} = \&FHEM::backupToStorage::Notify;
$hash->{UndefFn} = \&FHEM::backupToStorage::Undef;
$hash->{AttrFn} = \&FHEM::backupToStorage::Attr;
$hash->{RenameFn} = \&FHEM::backupToStorage::Rename;
$hash->{DeleteFn} = \&FHEM::backupToStorage::Delete;
$hash->{ShutdownFn} = \&FHEM::backupToStorage::Shutdown;
@ -54,7 +56,10 @@ sub backupToStorage_Initialize {
'bTS_Host '
. 'bTS_User '
. 'bTS_Path '
. 'bTS_Type:Nextcloud';
. 'bTS_Proto:http '
. 'bTS_Type:Nextcloud,SynologyFileStation '
. 'disable:1 '
. 'disabledForIntervals';
$hash->{parseParams} = 1;
return FHEM::Meta::InitMod( __FILE__, $hash );
@ -174,7 +179,7 @@ sub backupToStorage_Initialize {
],
"release_status": "devepolment",
"license": "GPL_2",
"version": "v1.0.0",
"version": "v1.2.3",
"author": [
"Marko Oldenburg <fhemsupport@cooltux.net>"
],

View File

@ -1,2 +1,2 @@
UPD 2020-06-19_08:28:14 6090 FHEM/98_backupToStorage.pm
UPD 2020-06-19_07:55:06 15635 lib/FHEM/backupToStorage.pm
UPD 2021-01-04_14:37:28 6262 FHEM/98_backupToStorage.pm
UPD 2021-01-04_14:53:20 19356 lib/FHEM/backupToStorage.pm

39
hooks/pre-commit Executable file
View File

@ -0,0 +1,39 @@
#!/usr/bin/perl -w
use File::Basename;
use POSIX qw(strftime);
use strict;
my @filenames = ( 'FHEM/98_backupToStorage.pm',
'lib/FHEM/backupToStorage.pm',
);
my $controlsfile = 'controls_backupToStorage.txt';
open(FH, ">$controlsfile") || return("Can't open $controlsfile: $!");
for my $filename (@filenames) {
my @statOutput = stat($filename);
if (scalar @statOutput != 13) {
printf 'error: stat has unexpected return value for ' . $filename . "\n";
next;
}
my $mtime = $statOutput[9];
my $date = POSIX::strftime("%Y-%m-%d", localtime($mtime));
my $time = POSIX::strftime("%H:%M:%S", localtime($mtime));
my $filetime = $date."_".$time;
my $filesize = $statOutput[7];
printf FH 'UPD ' . $filetime . ' ' . $filesize . ' ' .$filename . "\n";
}
close(FH);
system("git add $controlsfile");
print 'Create controls File succesfully' . "\n";
exit 0;

View File

@ -122,10 +122,12 @@ BEGIN {
readingsBeginUpdate
readingsEndUpdate
ReadingsVal
ReadingsAge
gettimeofday
InternalTimer
defs
modules
IsDisabled
setKeyValue
getKeyValue
getUniqueId
@ -148,10 +150,10 @@ sub Define {
return $@ unless ( FHEM::Meta::SetInternals($hash) );
use version 0.60; our $VERSION = FHEM::Meta::Get( $hash, 'version' );
return 'only one backupToStorage instance allowed'
return qq{only one backupToStorage instance allowed}
if ( devspec2array('TYPE=backupToStorage') > 1 )
; # es wird geprüft ob bereits eine Instanz unseres Modules existiert,wenn ja wird abgebrochen
return 'too few parameters: define <name> backupToStorage'
return qq{too few parameters: define <name> backupToStorage}
if ( scalar( @{$aArg} ) != 2 );
my $name = shift @$aArg;
@ -159,7 +161,7 @@ sub Define {
$hash->{NOTIFYDEV} = 'global,' . $name;
$hash->{STORAGETYPE} = AttrVal( $name, 'bTS_Type', 'Nextcloud' );
Log3( $name, 3, "backupToStorage ($name) - defined" );
Log3( $name, 3, qq{backupToStorage ($name) - defined} );
return;
}
@ -168,7 +170,7 @@ sub Undef {
my $hash = shift;
my $name = shift;
Log3( $name, 3, "backupToStorage ($name) - delete device $name" );
Log3( $name, 3, qq{backupToStorage ($name) - delete device $name} );
return;
}
@ -201,15 +203,31 @@ sub Notify {
my $devname = $dev->{NAME};
my $devtype = $dev->{TYPE};
my $events = deviceEvents( $dev, 1 );
return if ( !$events );
_CheckIsDisabledAfterSetAttr($hash)
if ( (
(
grep m{^DELETEATTR.$name.(disable|disabledForIntervals)$}xms,
@{$events}
or grep m{^ATTR.$name.(disable|disabledForIntervals).\S+$}xms,
@{$events}
)
&& $devname eq 'global'
&& $init_done
)
|| $devname eq $name
);
return if ( !$events
|| IsDisabled($name) );
Log3( $name, 4,
"AutoShuttersControl ($name) - Devname: "
. $devname
. " Name: "
. $name
. " Notify: "
. Dumper $events); # mit Dumper
qq{backupToStorage ($name) -
Devname: $devname
Name: $name
Notify: } . Dumper $events
); # mit Dumper
PushToStorage($hash)
if ( ( grep m{^backup.done(.+)?$}xms, @{$events} )
@ -275,33 +293,93 @@ sub Set {
my $name = shift @$aArg;
my $cmd = shift @$aArg
// return qq{"set $name" needs at least one argument};
// return qq{set "$name" needs at least one argument};
if ( lc $cmd eq 'addpassword' ) {
return "please set Attribut bTS_User first"
return qq{please set Attribut bTS_User first}
if ( AttrVal( $name, 'bTS_User', 'none' ) eq 'none' );
return "usage: $cmd <password>" if ( scalar( @{$aArg} ) != 1 );
return qq{usage: "$cmd" <password>} if ( scalar( @{$aArg} ) != 1 );
StorePassword( $hash, $name, $aArg->[0] );
}
elsif ( lc $cmd eq 'deletepassword' ) {
return "usage: $cmd" if ( scalar( @{$aArg} ) != 0 );
return qq{usage: $cmd} if ( scalar( @{$aArg} ) != 0 );
DeletePassword($hash);
}
elsif ( lc $cmd eq 'active' ) {
return qq{usage: $cmd} if ( scalar( @{$aArg} ) != 0 );
readingsSingleUpdate( $hash, 'state', 'ready', 1 );
}
elsif ( lc $cmd eq 'inactive' ) {
return qq{usage: $cmd} if ( scalar( @{$aArg} ) != 0 );
readingsSingleUpdate( $hash, 'state', $cmd, 1 );
}
else {
my $list = (
defined( ReadPassword( $hash, $name ) )
? 'deletepassword:noArg'
: 'addpassword'
);
my $list = 'active:noArg inactive:noArg';
$list .= (
defined( ReadPassword( $hash, $name ) )
? ' deletepassword:noArg'
: ' addpassword'
);
return 'Unknown argument ' . $cmd . ', choose one of ' . $list;
return qq{Unknown argument "$cmd", choose one of $list};
}
return;
}
sub Attr {
my $cmd = shift;
my $name = shift;
my $hash = $defs{$name};
my $attrName = shift;
my $attrVal = shift;
if ( $attrName eq 'disable'
|| $attrName eq 'disabledForIntervals' ) {
if ( $cmd eq 'set' ) {
if ( $attrName eq 'disabledForIntervals' ) {
return
'check disabledForIntervals Syntax HH:MM-HH:MM or HH:MM-HH:MM HH:MM-HH:MM ...'
if ( $attrVal !~ /^((\d{2}:\d{2})-(\d{2}:\d{2})\s?)+$/ );
Log3( $name, 3, qq{backupToStorage ($name) - disabledForIntervals} );
}
elsif ( $attrName eq 'disable' ) {
Log3( $name, 3, qq{backupToStorage ($name) - disabled} );
}
}
InternalTimer( gettimeofday() + 1,
'FHEM::backupToStorage::_CheckIsDisabledAfterSetAttr', $hash, 0 );
}
elsif ( $attrName eq 'bTS_Type' ) {
InternalTimer( gettimeofday() + 1,
sub { $hash->{STORAGETYPE} = AttrVal($name,'bTS_Type','Nextcloud'); }, $hash, 0 );
}
return;
}
sub _CheckIsDisabledAfterSetAttr {
my $hash = shift;
my $name = $hash->{NAME};
my $state = ( IsDisabled($name)
? 'inactive'
: 'ready' );
Log3( $name, 3, qq{backupToStorage ($name) - _CheckIsDisabledAfterSetAttr} );
readingsSingleUpdate($hash, 'state', $state, 1)
if ( ReadingsVal($name, 'state', 'ready' ) ne $state );
}
sub Rename {
my $new = shift;
my $old = shift;
@ -319,50 +397,65 @@ sub PushToStorage {
my $name = $hash->{NAME};
Log3( $name, 4, "backupToStorage ($name) - push to storage function" );
Log3( $name, 4, qq{backupToStorage ($name) - push to storage function} );
return
if ( ReadingsAge($name,'fhemBackupFile',1) > 180 );
Log3( $name, 4, qq{backupToStorage ($name) - after readings age return} );
require "SubProcess.pm";
my $subprocess = SubProcess->new( { onRun => \&FileUpload } );
my $backupFile = ReadingsVal( $name, 'fhemBackupFile', 'none' );
if ( $hash->{STORAGETYPE} eq 'SynologyFileStation' ) {
}
else {
require "SubProcess.pm";
my $subprocess = SubProcess->new( { onRun => \&FileUpload } );
my @fileNameAtStorage_array = split( '/', $backupFile );
my $fileNameAtStorage = $fileNameAtStorage_array[$#fileNameAtStorage_array];
my $backupFile = ReadingsVal( $name, 'fhemBackupFile', 'none' );
$subprocess->{curl} = qx(which curl);
chomp($subprocess->{curl});
$subprocess->{type} = $hash->{STORAGETYPE};
$subprocess->{host} = AttrVal( $name, 'bTS_Host', '' );
$subprocess->{user} = AttrVal( $name, 'bTS_User', '' );
$subprocess->{pass} = ReadPassword( $hash, $name );
$subprocess->{path} = AttrVal( $name, 'bTS_Path', '' );
$subprocess->{backupfile} = $backupFile;
$subprocess->{fileNameAtStorage} = $fileNameAtStorage;
my @fileNameAtStorage_array = split( '/', $backupFile );
my $fileNameAtStorage = $fileNameAtStorage_array[$#fileNameAtStorage_array];
my $pid = $subprocess->run();
$subprocess->{curl} = qx(which curl);
chomp($subprocess->{curl});
$subprocess->{type} = $hash->{STORAGETYPE};
$subprocess->{host} = AttrVal( $name, 'bTS_Host', '' );
$subprocess->{user} = AttrVal( $name, 'bTS_User', '' );
$subprocess->{pass} = ReadPassword( $hash, $name );
$subprocess->{path} = AttrVal( $name, 'bTS_Path', '' );
$subprocess->{backupfile} = $backupFile;
$subprocess->{fileNameAtStorage} = $fileNameAtStorage;
$subprocess->{proto} = AttrVal( $name, 'bTS_Proto', 'https' );
$subprocess->{loglevel} = AttrVal( $name, 'verbose', 3 );
readingsSingleUpdate( $hash, 'state', ' file upload in progress', 1 );
my $pid = $subprocess->run();
if ( !defined($pid) ) {
Log3( $name, 1,
"backupToStorage ($name) - Cannot execute command asynchronously" );
readingsSingleUpdate( $hash, 'state', ' file upload in progress', 1 );
CleanSubprocess($hash);
readingsSingleUpdate( $hash, 'state',
'Cannot execute command asynchronously', 1 );
return undef;
if ( !defined($pid) ) {
Log3( $name, 1,
qq{backupToStorage ($name) - Cannot execute command asynchronously} );
CleanSubprocess($hash);
readingsSingleUpdate( $hash, 'state',
'Cannot execute command asynchronously', 1 );
return undef;
}
Log3( $name, 4,
qq{backupToStorage ($name) - execute command asynchronously (PID="$pid")}
);
$hash->{".fhem"}{subprocess} = $subprocess;
InternalTimer( gettimeofday() + 1,
"FHEM::backupToStorage::PollChild", $hash );
}
Log3( $name, 4,
"backupToStorage ($name) - execute command asynchronously (PID=$pid)"
);
$hash->{".fhem"}{subprocess} = $subprocess;
InternalTimer( gettimeofday() + 1,
"FHEM::backupToStorage::PollChild", $hash );
Log3( $hash, 4,
"backupToStorage ($name) - control passed back to main loop." );
qq{backupToStorage ($name) - control passed back to main loop.} );
return;
}
@ -378,20 +471,20 @@ sub PollChild {
if ( !defined($json) ) {
Log3( $name, 5,
"backupToStorage ($name) - still waiting ("
. $subprocess->{lasterror}
. ")." );
qq{backupToStorage ($name) - still waiting ($subprocess->{lasterror}).}
);
InternalTimer( gettimeofday() + 1,
"FHEM::backupToStorage::PollChild", $hash );
return;
}
else {
Log3( $name, 4,
"backupToStorage ($name) - got result from asynchronous parsing."
);
qq{backupToStorage ($name) - got result from asynchronous parsing: $json} );
$subprocess->wait();
Log3( $name, 4,
"backupToStorage ($name) - asynchronous finished." );
qq{backupToStorage ($name) - asynchronous finished.} );
CleanSubprocess($hash);
WriteReadings( $hash, $json );
@ -408,17 +501,33 @@ sub FileUpload {
if ( $subprocess->{type} eq 'Nextcloud' ) {
my ($returnString,$returnCode) = ExecuteNCupload($subprocess);
$response->{ncUpload} = ( $returnCode == 72057594037927935
&& $returnString eq ''
? 'upload successfully'
: $returnString );
print 'backupToStorage File Upload - FileUpload Nextcloud, returnCode: '
. $returnCode
. ' , returnString: '
. $returnString . "\n"
if ( $subprocess->{loglevel} > 4 );
if ( $returnString =~ /100\s\s?[0-9].*\s100\s\s?[0-9].*/m
and $returnString =~ /\s\s<o:hint xmlns:o="o:">(.*)<\/o:hint>/m ) {
$response->{ncUpload} = $1;
}
elsif ( $returnString =~ /100\s\s?[0-9].*\s100\s\s?[0-9].*/m ) {
$response->{ncUpload} = 'upload successfully';
}
elsif ( $returnString =~ /(curl:\s.*)/ ){
$response->{ncUpload} = $1;
}
else {
$response->{ncUpload} = 'unknown error';
}
}
my $json = eval { encode_json($response) };
if ($@) {
Log3( 'backupToStorage File Upload',
1, "backupToStorage - JSON error: $@" );
print 'backupToStorage File Upload backupToStorage - JSON error: $@'
. "\n";
$json = '{"jsonerror":"$@"}';
}
@ -431,10 +540,10 @@ sub ExecuteNCupload {
my $subprocess = shift;
my $command = $subprocess->{curl};
$command .= ' -s -u ';
$command .= ' -k -u ';
$command .= $subprocess->{user} . ':' . $subprocess->{pass};
$command .= ' -T ' . $subprocess->{backupfile};
$command .= ' "https://';
$command .= ' "' . $subprocess->{proto} . '://';
$command .= $subprocess->{host};
$command .= '/remote.php/dav/files/';
$command .= $subprocess->{user};
@ -461,7 +570,7 @@ sub CleanSubprocess {
my $name = $hash->{NAME};
delete( $hash->{".fhem"}{subprocess} );
Log3( $name, 4, "backupToStorage ($name) - clean Subprocess" );
Log3( $name, 4, qq{backupToStorage ($name) - clean Subprocess} );
}
sub StorePassword {
@ -489,9 +598,9 @@ sub StorePassword {
my $err = setKeyValue( $index, $enc_pwd );
DoTrigger( $name, 'password add' );
return "error while saving the password - $err" if ( defined($err) );
return qq{error while saving the password - $err} if ( defined($err) );
return "password successfully saved";
return qq{password successfully saved};
}
sub ReadPassword {
@ -502,14 +611,14 @@ sub ReadPassword {
my $key = getUniqueId() . $index;
my ( $password, $err );
Log3( $name, 4, "backupToStorage ($name) - Read password from file" );
Log3( $name, 4, qq{backupToStorage ($name) - Read password from file} );
( $err, $password ) = getKeyValue($index);
if ( defined($err) ) {
Log3( $name, 3,
"backupToStorage ($name) - unable to read password from file: $err"
qq{backupToStorage ($name) - unable to read password from file: $err}
);
return undef;
}
@ -532,7 +641,7 @@ sub ReadPassword {
return $dec_pwd;
}
else {
Log3( $name, 3, "backupToStorage ($name) - No password in file" );
Log3( $name, 3, qq{backupToStorage ($name) - No password in file} );
return undef;
}
@ -583,7 +692,7 @@ sub WriteReadings {
my $decode_json = eval { decode_json($json) };
if ($@) {
Log3( $name, 2, "backupToStorage ($name) - JSON error: $@" );
Log3( $name, 2, qq{backupToStorage ($name) - JSON error: $@} );
return;
}