Backup Config Module - Beta - Final stage

Ctek · July 2, 2016, 6:17am

Hi Davide,
I understand now what you wanted to say with splitting the package.
I have no problem with building two packages.

The only issue i can see is if you use the “default” UI of the BCM you will lose some functionality.

But let’s see how this goes.
PS have you tested the BCM on your system ?

davidep · July 2, 2016, 8:18am

Thank you for supporting me, Bogdan!

The Enterprise version has already a similar feature that uploads the config backups to the private Nethesis cloud.

Therefore my goal is supporting both UIs (and whatever future one) with a common API.

Yeah of course I did it to give an attempt at the merge!

davidep · July 2, 2016, 8:27am

The PKI module in nethserver-base has now an upload field for custom certificates. Have a glance at the module and view code!

It required a fix to the ajax library in Nethgui to work.

Ctek · July 2, 2016, 8:56am

Hi Davide.
Just let me know when you have the packages ready, to give them a test from the Software Center.

stephdl · July 4, 2016, 6:24pm

nice feature

davidep · July 7, 2016, 5:02pm

Hi Bogdan,
I’ve just pushed an experimental package to nethforge-testing, please have a look at it

http://packages.nethserver.org/nethserver/7.2.1511/nethforge-testing/x86_64/Packages/nethserver-backup-history-0.0.0-1.14.ga492b60.ns7.noarch.rpm

Probably there are some things to fix; at least I managed to re-pack your code without requiring changes to the core package. Now we can see how to enhance it!

Ctek · July 7, 2016, 5:16pm

@Davide, I’ll give it a try this on a fresh NS instance and let you know.
Thanks for you work on this package!

davidep · July 8, 2016, 7:31am

To move out of “testing”, I think it requires at least two enhancements:

Enforce authentication on each HTTP request.
You could move bkp_jlib_ajax.php logic to Nethserver\Module\BackupConfig\History class.
Remove the need of backup/ symlink and 0644 permissions on backup archives.
Backup archives can’t be world-readable because they may contain sensitive informations. You could isolate privileged operations into some scripts, as you already did, and call them with sudo.

I think the latest PKI - Server certificate page is very similar to this module and could be an example of how to arrange the things:

Lists some files
Allows uploading and validating new files
Allows selecting an item as “default/target”
Performs privileged operations with sudo

Ctek · July 8, 2016, 11:27am

Hi Davide,
I agree with you on enforcing the auth on http requests.
On the second point (removing the need for backup/ symlink), I can see the functions to obtain the list of backups but I do not see how you can download the files after that since there will not be a function that will be able to read the file to put it to the header buffer…

So, List / Delete archives, will be possible, but i can’t see the mechanism for download. I’ve mentioned this before, that i can’t make this feature available…
Do you have a possible way to achieve this ?

davidep · July 8, 2016, 12:53pm

We can follow the VPN example to achieve the download feature:

github.com

NethServer/nethserver-openvpn/blob/master/root/usr/share/nethesis/NethServer/Module/VPN/Accounts/Download.php#L47




public function initialize()
{
    $parameterSchema = array(
        array('name', Validate::USERNAME, \Nethgui\Controller\Table\Modify::KEY),
    );


    $this->setSchema($parameterSchema);
}


public function prepareView(\Nethgui\View\ViewInterface $view)
{
    parent::prepareView($view);


    $name = \Nethgui\array_head($this->getRequest()->getPath()); 
    $view['ovpn'] = $view->getModuleUrl('/VPN/Accounts/download/ovpn/' . $name);
    $view['pem'] = $view->getModuleUrl('/VPN/Accounts/download/pem/' .  \Nethgui\array_head($this->getRequest()->getPath()));
    $view['ca'] = $view->getModuleUrl('/VPN/Accounts/download/ca/' .  \Nethgui\array_head($this->getRequest()->getPath()));
    $view['pkcs12'] = $view->getModuleUrl('/VPN/Accounts/download/pkcs12/' .  \Nethgui\array_head($this->getRequest()->getPath()));
    if ($this->getRequest()->isValidated()) {
        $command = "";

We can wrap cat into an helper executed with sudo.

Ctek · July 8, 2016, 12:58pm

I agree Davide, it looks like the best solution and it will also keep the same “profile” as the rest of the NS code.
This starts to look very promising!
I’ll try to take a look at the section of code for getting the file into the view.

I still don’t get how the function will get triggered when you click the download button…

davidep · July 8, 2016, 1:13pm

Button click events are handled in javascript by this class:

github.com

NethServer/nethgui/blob/829b74396cc85a3835336c11422629f9e09021f6/Nethgui/Js/jquery.nethgui.button.js#L42


        this.element.attr('href', value);
    }
},
_setOption: function( key, value ) {
    if(key === 'disabled') {
        this.element.button('option', 'disabled', value);
    } else {
        SUPER.prototype._setOption.apply( this, arguments );
    }
},
_onClick: function(e) {
    var tagName = this.element[0].tagName.toLowerCase();


    if(tagName === 'a') {
        var href = this.element.attr('href');
        if(this.element.hasClass('cancel')) {
            this._trigger('cancel');
        } else if(this.element.hasClass('givefocus') && href[0] === '#') {
            $(href).trigger('focus');
        } else if(this.element.hasClass('Help')) {
            this.element.trigger('nethguihelp', href);

Ctek · July 8, 2016, 1:13pm

@Davide,
I’ve installed the Backup History module you provided and i have encountered two issues:
1 After a backup is made (or a backup is deleted) , on the History tab i see the table for 1 second then it gets replaced by this:

Or after delete by this:

After i hit the button “Backup now” again after a backup was just made it freezes and remains like this:

Pasted image1907×955 128 KB

Only if I hit “reload” on the browser or refresh the page it restores normal operation.

The pages seem to be affected ONLY after the backup button has been clicked or after an event (Like delete).

Otherwise if no event has been used it looks normal.

davidep · July 8, 2016, 1:19pm

I’m looking at it next week! If we agree on moving the logic into the History controller, I’m sure we get back all this issues solved

Ctek · July 8, 2016, 1:27pm

Sure Davide, I’ on for how this module can be improved.

I think that we can remove the tabs Backup and Restore and keep only one that will have the Backup and Restore functions alongside the table of backups. (they are kind of redundant in my opinion)

As I have said, I’ll try to take a look at the code you provided as reference and figure it out if I can.
This way I can help you on porting all this to the more standard NS code

davidep · July 8, 2016, 1:41pm

I agree, they are kinda redundant and we could arrange the whole UI in a cleaner way, too. But I must keep into account the Enterprise module that - as said above - already provides a similar feature. I need some time to iron out the kinks, please be (still) patient!

Meanwhile, we can safely proceed with this add-on!

Ctek · July 8, 2016, 1:44pm

Not a problem. Take your time, there is no pressure issue from my side

BR
Bogdan

davidep · June 8, 2017, 2:25pm

Well that time has passed, it’s time to take in hand this module again!

Starting from @Ctek’s work (and straight from our meeting at FOSDEM17) I’m going to develop a configuration backup enhancement. The goal is the same

“restore from backup” at first system boot (FirstConfigWiz UI module)
configuration backup history
history length customization
upload an item to the history
restore from history

Tracked by issue https://github.com/NethServer/dev/issues/5314

alefattorini · June 8, 2017, 2:28pm

Looks a great news, Bogdan will be happy to hear that

davidep · June 9, 2017, 10:52am

This is an UI mockup

Row available actions:

Restore
Download

Configure options:

History length