FHEM/fhem-mirror
2
0
Fork 0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-02-02 01:40:34 +00:00
Code Issues Releases Wiki Activity
eb30dc2d18
fhem-mirror/fhem/FHEM/98_update.pm
rudolfkoenig ba7e9f8a9b fhem.pl: print os and user upon startup, move release.pm from fhem.pl to update 
git-svn-id: https://svn.fhem.de/fhem/trunk@3741 2b470e98-0d58-463d-a4d8-8e2adae1ed80
2013-08-18 15:23:42 +00:00

1358 lines
43 KiB
Perl
Raw Blame History

################################################################
# $Id$
# vim: ts=2:et
################################################################
#
# (c) 2012 Copyright: Martin Fischer (m_fischer at gmx dot de)
# All rights reserved
#
# This script is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# The GNU General Public License can be found at
# http://www.gnu.org/copyleft/gpl.html.
# A copy is found in the textfile GPL.txt and important notices to the license
# from the author is found in LICENSE.txt distributed with these scripts.
#
# This script is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
################################################################
package main;
use strict;
use warnings;
use HttpUtils;
use File::Copy qw(cp mv);
use Blocking;
use FhemUtils::release;
sub CommandUpdate($$);
sub update_CheckFhemRelease($$$);
sub update_CheckNotice($$$);
sub update_CheckUpdates($$$$$);
sub update_CleanUpLocalFiles($$$);
sub update_DoUpdate(@);
sub update_DoHousekeeping($$);
sub update_GetRemoteFiles($$$$);
sub update_ListChanges($$$);
sub update_MakeDirectory($);
sub update_ParseControlFile($$$$);
sub update_WriteLocalControlFile($$$$$);
########################################
sub
update_Initialize($$)
{
foreach my $pack (split(" ",uc($UPDATE{packages}))) {
$UPDATE{$pack}{control} = "controls_".lc($pack).".txt";
}
my %hash = (
Fn => "CommandUpdate",
Hlp => "[development|stable] [<file>|check|fhem],update Fhem",
);
$cmds{update} = \%hash;
}
########################################
sub
CommandUpdate($$)
{
my ($cl,$param) = @_;
my $modpath = (-d "updatefhem.dir" ? "updatefhem.dir":$attr{global}{modpath});
my $moddir = "$modpath/FHEM";
my $srcdir = "";
my $update = "";
my $force = 0;
my $ret = "";
# split arguments
my @args = split(/ +/,$param);
# set default trunk
my $BRANCH = (!defined($attr{global}{updatebranch}) ? $DISTRIB_BRANCH : uc($attr{global}{updatebranch}));
if ($BRANCH ne "STABLE" && $BRANCH ne "DEVELOPMENT") {
$ret = "global attribute 'updatebranch': unknown keyword: '$BRANCH'. Keyword should be 'STABLE' or 'DEVELOPMENT'";
Log 1, "update $ret";
return "$ret";
}
if (!defined($args[0])) {
push(@args,$BRANCH);
} elsif (uc($args[0]) ne "STABLE" && uc($args[0]) ne "DEVELOPMENT" && uc($args[0]) ne "THIRDPARTY") {
unshift(@args,$BRANCH);
} elsif (uc($args[0]) eq "STABLE" || uc($args[0]) eq "DEVELOPMENT" || uc($args[0]) eq "THIRDPARTY") {
$args[0] = uc($args[0]);
$BRANCH = uc($args[0]);
}
# check arguments
if (defined($args[1]) && $args[1] eq "?") {
# return complete usage
$ret = "Usage:\n";
$ret .= "=> FHEM update / check for updates:\n";
$ret .= "\tupdate [development|stable] [<file|package>] [force]\n";
$ret .= "\tupdate [development|stable] check\n";
$ret .= "\tupdate housekeeping\n";
$ret .= "=> Third party package update / check for a package update:\n";
$ret .= "\tupdate thirdparty <url> <package> [force]\n";
$ret .= "\tupdate thirdparty <url> <package> check";
return $ret;
} elsif (int(@args) <= 2 && $BRANCH eq "THIRDPARTY") {
# missing arguments for third party package
$ret = "Usage:\n";
$ret .= "\tupdate thirdparty <url> <package|file> [force]\n";
$ret .= "\tupdate thirdparty <url> <package> check";
return $ret;
} elsif (int(@args) > 2) {
if (grep (m/^HOUSEKEEPING$/i,@args)) {
return "Usage: update housekeeping";
} elsif (grep (m/^CHECK$/i,@args)) {
if (($BRANCH eq "STABLE" ||
$BRANCH eq "DEVELOPMENT") &&
$BRANCH ne "THIRDPARTY"
) {
return "Usage: update [development|stable] check";
} elsif ($BRANCH eq "THIRDPARTY" &&
(uc($args[1]) !~ m/^(HTTP|HTTPS):/ ||
uc($args[3]) !~ "CHECK" ||
int(@args) != 4)
) {
return "Usage: update thirdparty <url> <package> check";
}
} elsif ($BRANCH eq "THIRDPARTY" &&
(uc($args[1]) !~ m/^(HTTP|HTTPS):/ ||
(int(@args) == 4 &&
uc($args[3]) ne "FORCE") ||
int(@args) > 4)
) {
return "Usage: update thirdparty <url> <package> [force]";
} elsif ($BRANCH ne "THIRDPARTY" &&
(exists $UPDATE{uc($args[1])} &&
(int(@args) == 3 &&
uc($args[2]) ne "FORCE") ||
int(@args) > 3)
) {
return "Usage: update [development|stable] <package> [force]";
}
}
# set default update
if (!defined($args[1]) ||
(defined($args[1]) &&
(uc($args[1]) eq "FORCE") ||
uc($args[1]) eq "HOUSEKEEPING")) {
$update = "FHEM";
} elsif (exists $UPDATE{uc($args[1])}) {
$update = uc($args[1]);
} else {
$update = $args[1];
}
# build sourcedir for update
if ($BRANCH ne "THIRDPARTY") {
# set path for fhem.de
my $branch = lc($BRANCH);
$branch = "SVN" if ($BRANCH eq "DEVELOPMENT");
$srcdir = $UPDATE{path}."/".lc($branch);
} else {
# set path for 3rd-party
$srcdir = $args[1];
$update = $args[2];
}
# force update
$force = 1 if (grep (m/^FORCE$/i,@args));
if (defined($args[1]) && uc($args[1]) eq "CHECK" ||
$BRANCH eq "THIRDPARTY" && defined($args[3]) && uc($args[3]) eq "CHECK") {
$ret = update_ListChanges($srcdir,$BRANCH,$update);
} elsif (defined($args[1]) && uc($args[1]) eq "HOUSEKEEPING") {
$ret = update_DoHousekeeping($BRANCH,$update);
$ret = "nothing to do..." if (!$ret);
} else {
my $unconfirmed;
my $notice;
($notice,$unconfirmed) = update_CheckNotice($BRANCH,$update,"before");
$ret .= $notice if(defined($notice));
return $ret if($unconfirmed);
if(AttrVal("global","updateInBackground",undef)) {
CallFn($cl->{NAME}, "ActivateInformFn", $cl);
BlockingCall("update_DoUpdateInBackground", {srcdir=>$srcdir,
BRANCH=>$BRANCH, update=>$update, force=>$force,cl=>$cl});
$ret = "Executing the update the background.";
} else {
$ret .= update_DoUpdate($srcdir,$BRANCH,$update,$force,$cl);
($notice,$unconfirmed) = update_CheckNotice($BRANCH,$update,"after");
$ret .= $notice if(defined($notice));
my $sendStatistics = AttrVal("global","sendStatistics",undef);
if(defined($sendStatistics) && lc($sendStatistics) eq "onupdate") {
$ret .= "\n\n";
$ret .= AnalyzeCommandChain(undef, "fheminfo send");
}
}
}
return $ret;
}
my $inLog = 0;
sub
update_Log2Event($$)
{
my ($level, $text) = @_;
return if($inLog || $level > $attr{global}{verbose});
$inLog = 1;
BlockingInformParent("DoTrigger", ["global", $text, 1], 0);
BlockingInformParent("Log", [$level, $text], 0);
$inLog = 0;
}
sub
update_DoUpdateInBackground($)
{
my ($h) = @_;
no warnings 'redefine'; # The main process is not affected
*Log = \&update_Log2Event;
sleep(2); # Give time for ActivateInform / FHEMWEB / JavaScript
my $ret = update_DoUpdate($h->{srcdir}, $h->{BRANCH}, $h->{update},
$h->{force}, $h->{cl});
my ($notice,$unconfirmed) =
update_CheckNotice($h->{BRANCH}, $h->{update}, "after");
$ret .= $notice if(defined($notice));
if(lc(AttrVal("global","sendStatistics","")) eq "onupdate") {
$ret .= "\n\n";
$ret .= AnalyzeCommandChain(undef, "fheminfo send");
}
}
########################################
sub
update_CheckNotice($$$)
{
my ($BRANCH,$update,$position) = @_;
my $modpath = (-d "updatefhem.dir" ? "updatefhem.dir":$attr{global}{modpath});
my $moddir = "$modpath/FHEM";
my $noticeDir = "$moddir/FhemUtils";
my @notes = ("thirdparty", $update);
my $ret;
my $result;
my @published;
my @unconfirmed;
my @confirmed;
if ($BRANCH ne "THIRDPARTY") {
$result = AnalyzeCommandChain(undef, "notice get update 6");
@published = split(",",$result) if($result);
$result = AnalyzeCommandChain(undef, "notice get update 7");
@unconfirmed = split(",",$result) if($result);
$result = AnalyzeCommandChain(undef, "notice get update 8");
@confirmed = split(",",$result) if($result);
} else {
foreach my $note (@notes) {
$result = AnalyzeCommandChain(undef, "notice get $note 6");
push(@published, split(",",$result)) if($result);
$result = AnalyzeCommandChain(undef, "notice get $note 7");
push(@unconfirmed, split(",",$result)) if($result);
$result = AnalyzeCommandChain(undef, "notice get $note 8");
push(@confirmed, split(",",$result)) if($result);
}
}
# remove confirmed from published
my %c;
@c{@confirmed} = undef;
@published = grep {not exists $c{$_}} @published;
my @merged = (@published,@unconfirmed);
my %unique = ();
foreach my $notice (@merged) {
$unique{$notice} ++;
}
my @noticeList = keys %unique;
if(@noticeList) {
foreach my $notice (sort @noticeList) {
my $sendStatistics;
my $condition = AnalyzeCommandChain(undef, "notice condition $notice");
if($condition) {
my @conditions = split(/\|/,$condition);
foreach my $pair (@conditions) {
my ($key,$val,$con) = split(":",$pair);
if(lc($key) eq "sendstatistics") {
# skip this message if attrib sendStatistics is already defined
$sendStatistics = AttrVal("global","sendStatistics",undef);
}
}
}
next if(defined($sendStatistics) && $sendStatistics ne "");
my $cmdret = AnalyzeCommandChain(undef, "notice position $notice");
if( defined($cmdret) && lc($cmdret) eq lc($position) ||
( defined($cmdret) && grep (m/^$notice$/,@unconfirmed) && lc($cmdret) eq "after") ||
(!defined($cmdret) && grep (m/^$notice$/,@unconfirmed) && $position eq "before") ||
(!defined($cmdret) && !grep (m/^$notice$/,@unconfirmed) && $position eq "after") ) {
$ret .= "\n==> Message-ID: $notice\n";
my $noticeDE = AnalyzeCommandChain(undef, "notice view $notice noheader de");
my $noticeEN = AnalyzeCommandChain(undef, "notice view $notice noheader en");
if($noticeDE && $noticeEN) {
# $ret .= "(English Translation: Please see below.)\n\n";
$ret .= $noticeDE;
$ret .= "~~~~~~~~~~\n";
$ret .= $noticeEN;
} elsif($noticeDE) {
$ret .= $noticeDE;
} elsif($noticeEN) {
$ret .= $noticeEN;
} else {
$ret .= "==> Message file is corrupt. Please report this!\n"
}
}
}
if(@unconfirmed) {
$ret .= "==> Action required:\n\n";
if($position eq "before") {
$ret .= " There is at least one unconfirmed message. Before updating FHEM\n";
$ret .= " these messages have to be confirmed first:\n";
} else {
$ret .= " There is at least one unconfirmed message. You have to confirm\n";
$ret .= " these messages before you can update FHEM again.\n";
}
foreach my $notice (@unconfirmed) {
$ret .= " ID: $notice\n";
Log 1,"update Action required: please run 'notice view $notice'";
}
$ret .= "\n";
$ret .= " To view a message (again), please enter 'notice view <ID>'.\n";
$ret .= " To confirm a message, please enter 'notice confirm <ID> [value]'.\n";
$ret .= " '[value]' is an optional argument. Please refer to the message,\n";
$ret .= " whether the disclosure of '[value]' is necessary.\n\n";
$ret .= " For further information please consult the manual for the command\n";
$ret .= " 'notice' in the documentation of FHEM (commandref.html).";
if($position eq "before") {
$ret .= "\n\n";
$ret .= " The update is canceled for now.";
}
}
} else {
$ret = undef;
}
return ($ret,(@unconfirmed) ? 1 : 0);
}
########################################
sub
update_DoUpdate(@)
{
my ($srcdir,$BRANCH,$update,$force,$cl) = @_;
my $modpath = (-d "updatefhem.dir" ? "updatefhem.dir":$attr{global}{modpath});
my $moddir = "$modpath/FHEM";
my $server = $UPDATE{server};
my $uri;
my $url;
my $controlsTxt;
my @packages;
my $fail;
my $ret = "";
if ($BRANCH ne "THIRDPARTY") {
# Get fhem.pl version
my $checkFhemRelease = update_CheckFhemRelease($force,$srcdir,$BRANCH);
return $checkFhemRelease if ($checkFhemRelease);
# set packages
@packages = split(" ",uc($UPDATE{packages}));
} else {
# set packages
@packages = ($update);
}
# get list of files
my $rControl_ref = {};
my $lControl_ref = {};
foreach my $pack (@packages) {
if ($BRANCH ne "THIRDPARTY") {
$controlsTxt = $UPDATE{$pack}{control};
$uri = "$server/$srcdir/$controlsTxt";
$url = "$server/$srcdir";
} else {
$controlsTxt = "controls_$pack.txt";
$uri = "$srcdir/$controlsTxt";
$server = $srcdir;
$url = $server;
}
Log 3, "update get $uri";
my $controlFile = GetFileFromURL($uri);
return "Can't get '$controlsTxt' from $server" if (!$controlFile);
# parse remote controlfile
($fail,$rControl_ref) = update_ParseControlFile($pack,$controlFile,$rControl_ref,0);
return "$fail\nUpdate canceled..." if ($fail);
# parse local controlfile
($fail,$lControl_ref) = update_ParseControlFile($pack,"$moddir/$controlsTxt",$lControl_ref,1);
return "$fail\nUpdate canceled..." if ($fail);
}
# Check for new / modified files
my ($checkUpdates,$updateFiles_ref) = update_CheckUpdates($BRANCH,$update,$force,$lControl_ref,$rControl_ref);
if (!keys %$updateFiles_ref) {
return $checkUpdates;
} else {
$ret = $checkUpdates;
}
# save statefile
$ret .= "\nSaving statefile: ";
my $cmdret = WriteStatefile();
if (!$cmdret) {
Log 1, "update saving statefile";
$ret .= "done\n\n";
} else {
Log 1, "update statefile: $cmdret";
$ret .= "Something went wrong with statefile:\n$cmdret\n\n";
}
# do a backup first
my $doBackup = (!defined($attr{global}{backup_before_update}) ? 1 : $attr{global}{backup_before_update});
if ($doBackup) {
my $cmdret = AnalyzeCommand(undef, "backup");
if ($cmdret !~ m/backup done.*/) {
Log 1, "update Backup: The operation was canceled. Please check manually!";
$ret .= "Something went wrong during backup:\n$cmdret\n";
$ret .= "The operation was canceled. Please check manually!";
return $ret;
}
$ret .= "Backup:\n$cmdret\n";
}
# get new / modified files
my $getUpdates;
($fail,$getUpdates) = update_GetRemoteFiles($BRANCH,$url,$updateFiles_ref,$cl);
$ret .= $getUpdates if($getUpdates);
foreach my $pack (@packages) {
# write local controlfile
my $localControlFile = update_WriteLocalControlFile($BRANCH,$pack,$lControl_ref,$rControl_ref,$updateFiles_ref);
$ret .= $localControlFile if ($localControlFile);
}
undef($updateFiles_ref);
return $ret if($fail);
if (uc($update) eq "FHEM" || $BRANCH eq "THIRDPARTY") {
my $doHousekeeping = update_DoHousekeeping($BRANCH,$update);
$ret .= $doHousekeeping if ($doHousekeeping);
}
$ret .= "\nUpdate completed!";
return $ret;
}
########################################
sub
update_DoHousekeeping($$)
{
my ($BRANCH,$update) = @_;
my $modpath = (-d "updatefhem.dir" ? "updatefhem.dir":$attr{global}{modpath});
my $moddir = "$modpath/FHEM";
my $cleanup;
my $pack;
my $ret;
# parse local controlfile
my $controlsTxt;
if ($BRANCH ne "THIRDPARTY") {
$pack = uc($update);
$controlsTxt = $UPDATE{$pack}{control};
} else {
$pack = $update;
$controlsTxt = "controls_$pack.txt";
}
my $fail;
my $lControl_ref;
($fail,$lControl_ref) = update_ParseControlFile($pack,"$moddir/$controlsTxt",$lControl_ref,1);
return "$fail\nHousekeeping canceled..." if ($fail);
my %lControl = %$lControl_ref;
# first run: create directories
foreach my $f (sort keys %{$lControl{$pack}}) {
my $lCtrl = $lControl{$pack}{$f}{ctrl};
my $str;
next if ($lCtrl ne "DIR");
if ($lCtrl eq "DIR") {
$str = update_CleanUpLocalFiles($lCtrl,"$f","");
if($str) {
$cleanup .= "==> $str\n" ;
Log 1, "update $str";
}
}
}
# second run: move named files
foreach my $f (sort keys %{$lControl{$pack}}) {
my $lCtrl = $lControl{$pack}{$f}{ctrl};
my $str;
next if ($lCtrl ne "MOV");
if ($lCtrl eq "MOV" && $f !~ /\*/) {
$str = update_CleanUpLocalFiles($lCtrl,"$modpath/$f","$modpath/$lControl{$pack}{$f}{move}");
$cleanup .= "==> $str\n";
Log 1, "update $str";
}
}
# third run: move glob
foreach my $f (sort keys %{$lControl{$pack}}) {
my $lCtrl = $lControl{$pack}{$f}{ctrl};
my $str;
next if ($lCtrl ne "MOV");
if ($lCtrl eq "MOV" && $f =~ /\*/) {
# get filename and path
#my $fname = substr $f,rindex($f,'/')+1;
my $fpath = substr $f,0,rindex($f,'/')+1;
foreach my $file (<$modpath/$f>) {
$str = update_CleanUpLocalFiles($lCtrl,"$file","$modpath/$lControl{$pack}{$f}{move}/");
$cleanup .= "==> $str\n";
Log 1, "update $str";
}
}
}
# last run: delete
foreach my $f (sort keys %{$lControl{$pack}}) {
my $lCtrl = $lControl{$pack}{$f}{ctrl};
my $str;
next if ($lCtrl ne "DEL");
if ($f =~ /\*/) {
# get filename and path
#my $fname = substr $f,rindex($f,'/')+1;
my $fpath = substr $f,0,rindex($f,'/')+1;
foreach my $file (<$modpath/$f>) {
if ($lCtrl eq "DEL") {
$str = update_CleanUpLocalFiles($lCtrl,"$file","");
$cleanup .= "==> $str\n";
Log 1, "update $str";
}
}
} else {
if ($lCtrl eq "DEL") {
$str = update_CleanUpLocalFiles($lCtrl,"$modpath/$f","");
$cleanup .= "==> $str\n";
Log 1, "update $str";
}
}
}
if ($cleanup) {
$ret = "\nHousekeeping:\n$cleanup";
}
return $ret;
}
########################################
sub
update_CheckUpdates($$$$$)
{
my ($BRANCH,$update,$force,$lControl_ref,$rControl_ref) = @_;
return "Wildcards are not ( yet ;-) ) allowed." if ($update =~ /(\*|\?)/);
my @exclude;
my $excluded = (!defined($attr{global}{exclude_from_update}) ? "" : $attr{global}{exclude_from_update});
my $found = 0;
my $pack;
my $ret;
my $singleFile = 0;
my $search = lc($update);
my @suggest;
my %updateFiles = ();
# select package
if($BRANCH ne "THIRDPARTY") {
$pack = "FHEM";
$pack = uc($update) if ($force);
} else {
$pack = $update;
}
# build searchstring
if (uc($update) ne "FHEM" && $BRANCH ne "THIRDPARTY") {
$singleFile = 1;
if ($update =~ m/^(\S+)\.(.*)$/) {
$search = lc($1);
if ($search =~ m/(\d+)_(.*)/) {
$search = lc($2);
}
}
}
# search for new / modified files
my %rControl = %$rControl_ref;
my %lControl = %$lControl_ref;
foreach my $f (sort keys %{$rControl{$pack}}) {
# skip housekeeping
next if ($rControl{$pack}{$f}{ctrl} eq "DEL" ||
$rControl{$pack}{$f}{ctrl} eq "DIR" ||
$rControl{$pack}{$f}{ctrl} eq "MOV");
# get remote filename
my $fname = substr $f,rindex($f,'/')+1;
# suggest filenames for given searchstring
if ($singleFile && lc($fname) ne lc($update)) {
if ($search && lc($fname) =~ m/$search/) {
push(@suggest,$fname);
}
}
# skip if some file was specified and the name does not match
next if ($singleFile && $fname ne $update);
if ($excluded =~ /$fname/) {
$lControl{$pack}{$f}{ctrl} = "EXC";
$lControl{$pack}{$f}{date} = (!defined($lControl{$pack}{$f}{date}) ?
$rControl{$pack}{$f}{date} :
$lControl{$pack}{$f}{date});
$lControl{$pack}{$f}{size} = (!defined($lControl{$pack}{$f}{size}) ?
$rControl{$pack}{$f}{size} :
$lControl{$pack}{$f}{size});
$lControl{$pack}{$f}{file} = (!defined($lControl{$pack}{$f}{file}) ?
$rControl{$pack}{$f}{file} :
$lControl{$pack}{$f}{file});
Log 1, "update excluded by configuration: $fname";
push(@exclude,$f);
}
if ($singleFile && $fname eq $update) {
#if (!@exclude && $lControl{$pack}{$f}{date} &&
# $rControl{$pack}{$f}{date} ne $lControl{$pack}{$f}{date}) {
if (!@exclude && $lControl{$pack}{$f}{date}) {
$updateFiles{$f}{file} = $fname;
$updateFiles{$f}{size} = $rControl{$pack}{$f}{size};
$updateFiles{$f}{date} = $rControl{$pack}{$f}{date};
}
$found = 1;
last;
}
next if (!$force &&
$lControl{$pack}{$f}{date} &&
$rControl{$pack}{$f}{date} eq $lControl{$pack}{$f}{date});
if ($excluded !~ /$fname/) {
$updateFiles{$f}{file} = $fname;
$updateFiles{$f}{size} = $rControl{$pack}{$f}{size};
$updateFiles{$f}{date} = $rControl{$pack}{$f}{date};
}
$found = 1;
}
my $nothing = "nothing to do...";
if ($found) {
if (@exclude) {
my $exc;
foreach my $f (sort @exclude) {
my $fname = substr $f,rindex($f,'/')+1;
$exc .= "==> $fname\n" if ($rControl{$pack}{$f}{date} ne $lControl{$pack}{$f}{date});
}
if (!keys(%updateFiles)) {
$ret .= $nothing;
Log 1, "update $nothing";
} else {
if ($exc) {
$ret = "\nFile(s) skipped for an update! Excluded by configuration:\n$exc";
}
}
}
} else {
if ($singleFile && !@suggest) {
$ret = "'$update' not found.";
Log 1, "update $nothing";
}
if ($singleFile && @suggest) {
$ret = "'$update' not found. Did you mean:\n";
foreach my $f (sort @suggest) {
if ($excluded =~ /$f/) {
$ret .= "==> $f (excluded from updates)\n";
} else {
$ret .= "==> $f\n";
}
}
$ret .= $nothing;
Log 1, "update $nothing";
}
if (!$singleFile && !keys(%updateFiles)) {
$ret .= $nothing;
Log 1, "update $nothing";
}
}
return ($ret,\%updateFiles);
}
########################################
sub
update_GetRemoteFiles($$$$)
{
my ($BRANCH,$url,$updateFiles_ref,$cl) = @_;
my $modpath = (-d "updatefhem.dir" ? "updatefhem.dir":$attr{global}{modpath});
my $moddir = "$modpath/FHEM";
my $server = $UPDATE{server};
my %diffSize = ();
my $fail = 0;
my $localFile;
my $newFhem = 0;
my $remoteFile;
my @reloadModules;
my $writeError;
my $ret;
foreach my $f (sort keys %$updateFiles_ref) {
$remoteFile = $f;
$localFile = "$modpath/$f";
if ($BRANCH ne "THIRDPARTY") {
# mark for a restart of fhem.pl
if ($f =~ m/fhem.pl$/) {
$newFhem = 1;
$localFile = $0 if (! -d "updatefhem.dir");
$remoteFile = "$f.txt";
}
}
# replace special char % in filename
$remoteFile =~ s/%/%25/g;
# get remote filename
my $fname = substr $f,rindex($f,'/')+1;
my $fpath = $f;
$fpath =~ s/$fname//g;
# get remote File
Log 3, "update get $url/$remoteFile";
my $fileContent = GetFileFromURL("$url/$remoteFile");
my $fileLength = length($fileContent);
my $ctrlLength = $updateFiles_ref->{$f}->{size};
if ($fileLength ne $ctrlLength) {
$diffSize{$fname}{filelength} = $fileLength;
$diffSize{$fname}{ctrllength} = $ctrlLength;
$diffSize{$fname}{updatefile} = $f;
Log 1, "update skip '$fname'. Size does not correspond to " .
"controlfile: $ctrlLength bytes download: $fileLength bytes";
} else {
# mark for a reload of a modified module if its in use
if ($f =~ m/^.*(\d\d_)(.*).pm$/) {
my $modFile = "$1$2";
my $modName = $2;
push(@reloadModules,$modFile) if ($modules{$modName} && $modules{$modName}{LOADED});
}
my $mkdir;
$mkdir = update_MakeDirectory($fpath);
$ret .= $mkdir if ($mkdir);
next if ($mkdir);
if (open (FH, ">$localFile")) {
binmode FH;
print FH $fileContent;
close (FH);
Log 5, "update write $localFile";
} else {
delete $updateFiles_ref->{$f};
Log 1, "update Can't write $localFile: $!";
$writeError .= "Can't write $localFile: $!\n";
}
}
}
if ($writeError) {
$ret .= "\nFile(s) skipped for an update! Error while writing:\n";
$ret .= "$writeError";
}
if (keys(%diffSize)) {
$ret .= "\nFile(s) skipped for an update! Size does not correspond:\n";
foreach my $f (sort keys(%diffSize)) {
delete $updateFiles_ref->{$diffSize{$f}{updatefile}};
$ret .= "==> $f: size from controlfile: $diffSize{$f}{ctrllength} bytes, " .
"size after download: $diffSize{$f}{filelength} bytes\n";
}
}
if (keys(%$updateFiles_ref)) {
my $str = keys(%$updateFiles_ref)." file(s) have been updated";
$ret .= "\n$str:\n";
Log 1, "update $str.";
foreach my $f (sort keys(%$updateFiles_ref)) {
my ($date,$time) = split("_",$updateFiles_ref->{$f}->{date});
$ret .= "==> $date $time $f\n";
}
if (!$newFhem && @reloadModules) {
$ret .= "A new version of one or more module(s) was installed, 'shutdown restart' is required!";
#$ret .= "\nModule(s) reloaded:\n";
#foreach my $modFile (@reloadModules) {
# my $cmdret = CommandReload($cl,$modFile);
# if (!$cmdret) {
# Log 1, "update reloaded module: $modFile";
# $ret .= "==> $modFile\n";
# } else {
# $ret .= "==> $modFile:\n$cmdret\n";
# }
#}
}
if ($newFhem && $BRANCH ne "THIRDPARTY") {
my $str = "A new version of fhem.pl was installed, 'shutdown restart' is required!";
Log 1, "update $str";
$ret .= "\n$str\n";
}
} else {
my $str = "No files have been updated because one or more errors have occurred!";
$fail = 1;
$ret .= "\n$str\n";
Log 1, "update $str";
}
return ($fail,$ret);
}
########################################
sub
update_ListChanges($$$)
{
my ($srcdir,$BRANCH,$update) = @_;
my $modpath = (-d "updatefhem.dir" ? "updatefhem.dir":$attr{global}{modpath});
my $moddir = "$modpath/FHEM";
my $excluded = (!defined($attr{global}{exclude_from_update}) ? "" : $attr{global}{exclude_from_update});
my $fail;
my $pack;
my $server = $UPDATE{server};
my $ret = "List of new / modified files since last update:\n";
my $uri;
my $localControlFile;
my $changedFile;
if($BRANCH ne "THIRDPARTY") {
$pack = "FHEM";
$uri = "$server/$srcdir/$UPDATE{$pack}{control}";
$localControlFile = "$moddir/$UPDATE{$pack}{control}";
$changedFile = "$server/$srcdir/CHANGED";
} else {
$pack = $update;
$uri = "$srcdir/controls_$update.txt";
$localControlFile = "$moddir/controls_$update.txt";
$changedFile = "$srcdir/CHANGED";
}
# get list of files
Log 3, "update get $uri";
my $controlFile = GetFileFromURL($uri);
return "Can't get controlfile from $uri" if (!$controlFile);
# parse remote controlfile
my $rControl_ref = {};;
($fail,$rControl_ref) = update_ParseControlFile($pack,$controlFile,$rControl_ref,0);
return "$fail" if ($fail);
# parse local controlfile
my $lControl_ref = {};
($fail,$lControl_ref) = update_ParseControlFile($pack,$localControlFile,$lControl_ref,1);
return "$fail" if ($fail);
# Check for new / modified files
my $str;
my %rControl = %$rControl_ref;
my %lControl = %$lControl_ref;
foreach my $f (sort keys %{$rControl{$pack}}) {
next if ($rControl{$pack}{$f}{ctrl} eq "DEL" ||
$rControl{$pack}{$f}{ctrl} eq "DIR" ||
$rControl{$pack}{$f}{ctrl} eq "MOV");
next if ($lControl{$pack}{$f} &&
$rControl{$pack}{$f}{date} eq $lControl{$pack}{$f}{date});
$str = "$rControl{$pack}{$f}{ctrl} $f\n";
if ($f !~ m/\*/) {
my $ef = substr $f,rindex($f,'/')+1;
if ($excluded =~ /$ef/) {
$str = "--- $f (excluded from updates)\n";
}
}
$ret .= $str;
}
if (!$str) {
$ret .= "nothing to do...";
} else {
# get list of changes
$ret .= "\nList of last changes:\n";
my $changed = GetFileFromURL($changedFile);
if (!$changed || $changed =~ m/Error 404/g) {
$ret .= "Can't get list of changes from $server";
} else {
my @lines = split(/\015\012|\012|\015/,$changed);
foreach my $line (@lines) {
last if ($line eq "");
$ret .= $line."\n";
}
}
}
return $ret;
}
########################################
sub
update_CheckFhemRelease($$$)
{
my ($force,$srcdir,$BRANCH) = @_;
my $server = $UPDATE{server};
my $versRemote;
my $ret = undef;
# get fhem to check version
Log 3, "update get $server/$srcdir/FHEM/FhemUtils/release.pm";
my $uRelease = GetFileFromURL("$server/$srcdir/FHEM/FhemUtils/release.pm");
Log 5, "update get $server/$srcdir/FHEM/FhemUtils/release.pm";
return "Can't get release.pm from $server" if (!$uRelease);
my ($NEW_DISTRIB_ID,$NEW_DISTRIB_RELEASE,$NEW_DISTRIB_BRANCH,$NEW_DISTRIB_DESCRIPTION) = "";
foreach my $l (split("[\r\n]", $uRelease)) {
chomp($l);
Log 5, "update release.pm: $l";
if ($l =~ m/^\$DISTRIB_ID="(.*)"/) {
$NEW_DISTRIB_ID = $1;
}
if ($l =~ m/^\$DISTRIB_RELEASE="(\d+.\d+)"/) {
$NEW_DISTRIB_RELEASE = $1;
}
if ($l =~ m/^\$DISTRIB_BRANCH="(.*)"/) {
$NEW_DISTRIB_BRANCH = $1;
}
}
if (!$NEW_DISTRIB_ID || !$NEW_DISTRIB_RELEASE || !$NEW_DISTRIB_BRANCH) {
Log 1, "update The operation was canceled, while checking the remote Release.";
return "Can't read remote Release Informations. Update canceled now."
}
$NEW_DISTRIB_DESCRIPTION="$NEW_DISTRIB_ID $NEW_DISTRIB_RELEASE ($NEW_DISTRIB_BRANCH)";
if (!$force &&
($NEW_DISTRIB_RELEASE lt $DISTRIB_RELEASE ||
($NEW_DISTRIB_RELEASE == $DISTRIB_RELEASE &&
($DISTRIB_BRANCH eq "DEVELOPMENT" && $NEW_DISTRIB_BRANCH ne "DEVELOPMENT")))) {
$ret = "The installed version $DISTRIB_DESCRIPTION is newer than the remote\n";
$ret .= "version $NEW_DISTRIB_DESCRIPTION.\n";
$ret .= "A downgrade is not recommended! Your default updatebranch is '$BRANCH'.\n";
$ret .= "You can force the downgrade with the argument 'force' (e.g. 'update force')\n";
$ret .= "at your own risk. In case of problems within the downgrade process, there is\n";
$ret .= "no support from the developers!";
Log 1, "update Downgrade is not allowed!";
}
Log 1, "update check Releases => local: $DISTRIB_DESCRIPTION remote: $NEW_DISTRIB_DESCRIPTION";
return $ret;
}
########################################
sub
update_WriteLocalControlFile($$$$$)
{
my ($BRANCH,$pack,$lControl_ref,$rControl_ref,$updateFiles_ref) = @_;
my $modpath = (-d "updatefhem.dir" ? "updatefhem.dir":$attr{global}{modpath});
my $moddir = "$modpath/FHEM";
my $controlsTxt;
if ($BRANCH ne "THIRDPARTY") {
$controlsTxt = $UPDATE{$pack}{control};
} else {
$controlsTxt = "controls_$pack.txt";
}
return "Can't write $moddir/$controlsTxt: $!" if (!open(FH, ">$moddir/$controlsTxt"));
Log 5, "update write $moddir/$controlsTxt";
my %rControl = %$rControl_ref;
my %lControl = %$lControl_ref;
my %updFiles = %$updateFiles_ref;
foreach my $f (sort keys %{$rControl{$pack}}) {
my $ctrl = $rControl{$pack}{$f}{ctrl} if (defined($rControl{$pack}{$f}{ctrl}));
my $date = $rControl{$pack}{$f}{date} if (defined($rControl{$pack}{$f}{date}));
my $size = $rControl{$pack}{$f}{size} if (defined($rControl{$pack}{$f}{size}));
my $file = $rControl{$pack}{$f}{file} if (defined($rControl{$pack}{$f}{file}));
my $move = $rControl{$pack}{$f}{move} if (defined($rControl{$pack}{$f}{move}));
if ($ctrl eq "UPD") {
if (defined($lControl{$pack}{$f}{ctrl}) &&
($lControl{$pack}{$f}{ctrl} eq "EXC" || !exists $updFiles{$f})) {
$date = defined($lControl{$pack}{$f}{date}) ? $lControl{$pack}{$f}{date} :
$rControl{$pack}{$f}{date};
$size = defined($lControl{$pack}{$f}{size}) ? $lControl{$pack}{$f}{size} :
$rControl{$pack}{$f}{size};
$file = defined($lControl{$pack}{$f}{file}) ? $lControl{$pack}{$f}{file} :
$rControl{$pack}{$f}{file};
}
Log 5, "update $controlsTxt: $ctrl $date $size $file";
print FH "$ctrl $date $size $file\n";
}
if ($ctrl eq "DIR") {
Log 5, "update $controlsTxt: $ctrl $file";
print FH "$ctrl $file\n";
}
if ($ctrl eq "MOV") {
Log 5, "update $controlsTxt: $ctrl $file $move";
print FH "$ctrl $file $move\n";
}
if ($ctrl eq "DEL") {
Log 5, "update $controlsTxt: $ctrl $file";
print FH "$ctrl $file\n";
}
}
close(FH);
return undef;
}
########################################
sub
update_ParseControlFile($$$$)
{
my ($pack,$controlFile,$control_ref,$local) = @_;
my %control = %$control_ref if ($control_ref && ref($control_ref) eq "HASH");
my $from = ($local ? "local" : "remote");
my $ret;
if ($local) {
my $str = "";
# read local controlfile in string
if (open FH, "$controlFile") {
$str = do { local $/; <FH> };
}
close(FH);
$controlFile = $str
}
# parse file
if ($controlFile) {
foreach my $l (split("[\r\n]", $controlFile)) {
chomp($l);
Log 5, "update $from controls_".lc($pack).".txt: $l";
my ($ctrl,$date,$size,$file,$move) = "";
if ($l =~ m/^(UPD) (20\d\d-\d\d-\d\d_\d\d:\d\d:\d\d) (\d+) (\S+)$/) {
$ctrl = $1;
$date = $2;
$size = $3;
$file = $4;
} elsif ($l =~ m/^(DIR) (\S+)$/) {
$ctrl = $1;
$file = $2;
} elsif ($l =~ m/^(MOV) (\S+) (\S+)$/) {
$ctrl = $1;
$file = $2;
$move = $3;
} elsif ($l =~ m/^(DEL) (\S+)$/) {
$ctrl = $1;
$file = $2;
} else {
$ctrl = "ESC"
}
if ($ctrl eq "ESC") {
Log 1, "update File 'controls_".lc($pack).".txt' ($from) is corrupt";
$ret = "File 'controls_".lc($pack).".txt' ($from) is corrupt";
}
last if ($ret);
# if ($local) {
# next if ($l =~ m/^(DEL|MOV) /);
# }
$control{$pack}{$file}{ctrl} = $ctrl;
$control{$pack}{$file}{date} = $date;
$control{$pack}{$file}{size} = $size;
$control{$pack}{$file}{file} = $file;
$control{$pack}{$file}{move} = $move;
}
}
return ($ret, \%control);
}
########################################
sub
update_CleanUpLocalFiles($$$)
{
my ($ctrl,$file,$move) = @_;
my $modpath = (-d "updatefhem.dir" ? "updatefhem.dir":$attr{global}{modpath});
my $ret;
# make dir
if ($ctrl eq "DIR") {
my $mret = update_MakeDirectory($file);
if ($mret) {
$ret = "create directory $modpath/$file failed: $mret";
}
}
# move file
if ($ctrl eq "MOV") {
my $mvret = mv "$file", "$move" if (-f $file);
if ($mvret) {
$ret = "moving $file to $move";
} else {
$ret = "moving $file to $move failed: $!";
}
}
# delete file
if ($ctrl eq "DEL") {
unlink "$file" if (-f $file);
if (!$!) {
$ret = "deleting $file";
} else {
$ret = "deleting $file failed: $!";
}
}
return $ret;
}
########################################
sub
update_MakeDirectory($)
{
my $fullPath = shift;
my $modpath = (-d "updatefhem.dir" ? "updatefhem.dir":$attr{global}{modpath});
my $error;
my $dir;
my $recPath = "";
my $ret;
foreach $dir (split(/\//, $fullPath)) {
$recPath = "$recPath$dir/";
if ($dir ne "") {
if (! -d "$modpath/$recPath") {
undef($!);
mkdir "$modpath/$recPath";
if($!) {
$error .= "==> $modpath/$recPath: $!\n";
Log 1, "update Error while creating: $modpath/$recPath: $!";
}
}
}
}
if ($error) {
$ret = "\nError while creating:\n$error";
}
return $ret;
}
1;
=pod
=begin html
<a name="update"></a>
<h3>update</h3>
<ul>
<strong>FHEM update / check for updates:</strong>
<br>
<code>update [development|stable] [&lt;file|package&gt;] [force]</code><br>
<code>update [development|stable] check</code><br>
<code>update housekeeping</code><br><br>
<strong>Third party package update / check for a package update:</strong>
<br>
<code>update thirdparty &lt;url&gt; &lt;package&gt; [force]</code><br>
<code>update thirdparty &lt;url&gt; &lt;package&gt; check</code><br>
<br>
The installed fhem distribution and its installed extensions (just like the
webGUI PGM2) are updated via this command from the online repository. The
locally installed files will be checked against the online repository and
will be updated in case the files online are in a newer version.
<br>
<br>
The update function will process more advanced distribution information
as well as control commands for updating, removing or renaming existing files.
New file structures can also be set up via control command files.
The update process will exclusively work with the file path which is
given by the global attribute "modpath" except for the fhem.pl file. The user
decides whether to use a stable, or a developer-rated version of fhem.
<strong>stable is not yet implemented</strong>, so an update use always the developer-rated version.
<br>
<br>
Furthermore, the use of packages is supported just like in a manual installation
of fhem. On the moment this only refers to FHEM including PGM2 (FHEMWEB), others
may follow up. By using the update in this way, only files which are acutally
used will be updated.
<br>
<br>
The update function supports the installation of third-party packages like
modules or GUIs that are not part of the FHEM distribution.
<br>
<br>
<i>Notice for Developers of third-party packages:</i>
<br>
<i>Further information can be obtained from the file 'docs/LIESMICH.update-thirdparty'.</i>
<br>
<br>
Examples:
<blockquote>Check for new updates:<code><pre>
fhem&gt; update check
</pre></code></blockquote>
<blockquote>FHEM update:<code><pre>
fhem&gt; update
</pre></code></blockquote>
<blockquote>Force FHEM update (all files are updated!):<code><pre>
fhem&gt; update force
</pre></code></blockquote>
<blockquote>Update a single file:<code><pre>
fhem&gt; update 98_foobar.pm
</pre></code></blockquote>
<blockquote>Search for a filename:<code><pre>
fhem&gt; update backup
'backup' not found. Did you mean:
==&gt; 98_backup.pm
nothing to do...
</pre></code></blockquote>
<blockquote>Update / install a third-party package:<code><pre>
fhem&gt; update thirdparty http://domain.tld/path packagename
</pre></code></blockquote>
<blockquote>Check a third-party package for new updates:<code><pre>
fhem&gt; update thirdparty http://domain.tld/path packagename check
</pre></code></blockquote>
<a name="updateattr"></a>
<b>Attributes</b>
<ul>
<li><a href="#backup_before_update">backup_before_update</a></li><br>
<li><a href="#exclude_from_update">exclude_from_update</a></li><br>
<li><a href="#updatebranch">updatebranch</a></li><br>
</ul>
</ul>
=end html
=begin html_DE
<a name="update"></a>
<h3>update</h3>
<ul>
<strong>FHEM aktualisieren / auf Aktualisierungen pr&uuml;fen:</strong>
<br>
<code>update [development|stable] [&lt;Date|Paket&gt;] [force]</code><br>
<code>update [development|stable] check</code><br>
<code>update housekeeping</code><br><br>
<strong>Aktualisierung eines Fremdpaketes / Fremdpaket auf Aktualisierungen pr&uuml;fen:</strong>
<br>
<code>update thirdparty &lt;url&gt; &lt;Paketname&gt; [force]</code><br>
<code>update thirdparty &lt;url&gt; &lt;Paketname&gt; check</code><br>
<br>
Die installierte FHEM Distribution und deren Erweiterungen (z.B. das Web-Interface
PGM2 (FHEMWEB)) werden mit diesem Befehl &uuml;ber ein Online Repository aktualisiert.
Enth&auml;lt das Repository neuere Dateien oder Dateiversionen als die lokale
Installation, werden die aktualisierten Dateien aus dem Repository installiert.
<br>
<br>
Die Update-Funktion unterst&uuml;tzt erweiterte Distributions Informationen sowie
die Steuerung &uuml;ber spezielle Befehle zum aktualisieren, verschieben oder
umbenennen von bestehenden Dateien. Neue Verzeichnisstrukturen k&ouml;nnen ebenfalls
&uuml;ber die Aktualisierung erzeugt werden. Die Aktualisierung erfolgt exklusiv
im Verzeichnispfad der &uuml;ber das globale Attribut "modpath" gesetzt wurde
(Ausnahme: fhem.pl). Der Anwender kann die Aktualisierung wahlweise
aus dem stabilen (stable) oder Entwicklungs-Zweig (development) vornehmen lassen.
<strong>Ein Aktualisierung erfolgt zur Zeit ausschliesslich nur &uuml;ber den
Entwicklungs-Zweig (development).</strong>
<br>
<br>
Weiterhin unterst&uuml;tzt der update Befehl die manuelle Installation von Paketen
die Bestandteil der FHEM Distribution sind. Aktuell werden noch keine erweiterten FHEM
Pakete bereitgestellt.
<br>
<br>
Der update Befehl unterst&uuml;tzt auch die Installation von Paketen die kein Bestandteil
der FHEM Distribution sind. Diese Pakete k&ouml;nnen z.B. von Entwicklern angebotene
Module oder Benutzerinterfaces beinhalten.
<br>
<br>
<i>Hinweis f&uuml;r Anbieter von zus&auml;tzlichen Paketen:</i>
<br>
<i>Weiterf&uuml;hrende Informationen zur Bereitstellung von Paketen sind der Datei
'docs/LIESMICH.update-thirdparty' zu entnehmen.</i>
<br>
<br>
Beispiele:
<blockquote>Auf neue Aktualisierungen pr&uuml;fen:<code><pre>
fhem&gt; update check
</pre></code></blockquote>
<blockquote>FHEM aktualisieren:<code><pre>
fhem&gt; update
</pre></code></blockquote>
<blockquote>FHEM Aktualisierung erzwingen (alle Dateien werden aktualisiert!):<code><pre>
fhem&gt; update force
</pre></code></blockquote>
<blockquote>Eine einzelne Datei aktualisieren:<code><pre>
fhem&gt; update 98_foobar.pm
</pre></code></blockquote>
<blockquote>Nach einem Dateinamen suchen:<code><pre>
fhem&gt; update backup
'backup' not found. Did you mean:
==&gt; 98_backup.pm
nothing to do...
</pre></code></blockquote>
<blockquote>Aktualisierung oder Installation eines Fremdpaketes:<code><pre>
fhem&gt; update thirdparty http://domain.tld/path paketname
</pre></code></blockquote>
<blockquote>Fremdpaket auf neue Aktualisierungen pr&uuml;fen:<code><pre>
fhem&gt; update thirdparty http://domain.tld/path paketname check
</pre></code></blockquote>
<a name="updateattr"></a>
<b>Attribute</b>
<ul>
<li><a href="#backup_before_update">backup_before_update</a></li><br>
<li><a href="#exclude_from_update">exclude_from_update</a></li><br>
<li><a href="#updatebranch">updatebranch</a></li><br>
</ul>
</ul>
=end html_DE
=cut
Reference in New Issue View Git Blame Copy Permalink