Skip to content

luci-app-uci-git-backup: add LuCI interface #8543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mrangger wants to merge 1 commit into
base: master
Choose a base branch
from
Open

luci-app-uci-git-backup: add LuCI interface #8543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions applications/luci-app-uci-git-backup/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# This is free software, licensed under the GNU General Public License v2.

include $(TOPDIR)/rules.mk

LUCI_TITLE:=UCI Git Backup
LUCI_DEPENDS:=+luci-base +uci-git-backup

PKG_LICENSE:=GPL-2.0-only
PKG_MAINTAINER:=Mathias Rangger <mathias.rangger@gmail.com>

include ../../luci.mk

# call BuildPackage - OpenWrt buildroot signature
120 changes: 120 additions & 0 deletions ...tions/luci-app-uci-git-backup/htdocs/luci-static/resources/view/uci-git-backup/restore.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
'use strict';
'require view';
'require fs';
'require ui';

function parseCommits(logText) {
return (logText || '').split(/\n/).filter(Boolean).map(function(line) {
const parts = line.split('\t');

if (parts.length < 3)
return null;

return {
sha: parts[0],
date: parts[1],
msg: parts.slice(2).join('\t')
};
}).filter(Boolean);
}

function renderOutput(title, res, reloadAfterClose) {
const output = [res.stdout, res.stderr].filter(Boolean).join('\n').trim() || _('No output.');
const success = (res.code === 0);

ui.showModal(title, [
E('p', { 'class': success ? 'spinning' : null }, [
success ? _('Command completed successfully.') : _('Command failed with exit code %d.').format(res.code)
]),
E('pre', { 'style': 'white-space: pre-wrap' }, [ output ]),
E('div', { 'class': 'right' }, [
E('button', {
'class': 'btn',
'click': function() {
ui.hideModal();

if (reloadAfterClose)
window.location.reload();
}
}, [ _('Dismiss') ])
])
]);
}

return view.extend({
handleRestoreConfirm: function(sha) {
ui.showModal(_('Restoring backup...'), [
E('p', { 'class': 'spinning' }, [ _('The selected commit is being restored now.') ])
]);

return fs.exec('/usr/bin/uci-git-restore', [ sha ]).then(function(res) {
renderOutput(_('Restore Output'), res, res.code === 0);
});
},

handleRestore: function(sha) {
ui.showModal(_('Restore this backup?'), [
E('p', [ _('This will copy the selected backup into <code>/etc/config/</code> and trigger a configuration reload.') ]),
E('p', [ _('Selected commit: %s').format(sha) ]),
E('div', { 'class': 'right' }, [
E('button', { 'class': 'btn', 'click': ui.hideModal }, [ _('Cancel') ]),
' ',
E('button', {
'class': 'btn cbi-button-action important',
'click': ui.createHandlerFn(this, 'handleRestoreConfirm', sha)
}, [ _('Restore') ])
])
]);
},

load: function() {
return L.resolveDefault(fs.exec('/usr/bin/uci-git-list', []), { code: 1, stdout: '', stderr: '' });
},

render: function(res) {
const commits = (res.code === 0) ? parseCommits(res.stdout) : [];
let body;

if (res.code !== 0) {
body = E('div', { 'class': 'alert-message warning' }, [
E('p', [ _('Unable to read backup history.') ]),
E('pre', { 'style': 'white-space: pre-wrap' }, [ (res.stderr || res.stdout || _('No error output.')).trim() ])
]);
}
else if (!commits.length) {
body = E('p', { 'class': 'cbi-section-descr' }, [ _('No backup commits found yet.') ]);
}
else {
const rows = commits.map(L.bind(function(commit) {
return E('tr', { 'class': 'tr' }, [
E('td', { 'class': 'td' }, [ commit.date ]),
E('td', { 'class': 'td' }, [ commit.msg ]),
E('td', { 'class': 'td' }, [ E('code', [ commit.sha.substring(0, 8) ]) ]),
E('td', { 'class': 'td right' }, [
E('button', {
'class': 'btn cbi-button-action',
'click': ui.createHandlerFn(this, 'handleRestore', commit.sha)
}, [ _('Restore') ])
])
]);
}, this));

body = E('table', { 'class': 'table' }, [
E('tr', { 'class': 'tr table-titles' }, [
E('th', { 'class': 'th' }, [ _('Date') ]),
E('th', { 'class': 'th' }, [ _('Commit') ]),
E('th', { 'class': 'th' }, [ _('SHA') ]),
E('th', { 'class': 'th right' }, [ _('Action') ])
])
].concat(rows));
}

return E([], [
E('h2', [ _('Restore UCI Backup') ]),
E('div', { 'class': 'cbi-map-descr' }, [
_('Select one of the last 30 backup commits and restore it. A new commit recording the restore will be created afterwards.')
]),
body
]);
}
});
245 changes: 245 additions & 0 deletions ...ions/luci-app-uci-git-backup/htdocs/luci-static/resources/view/uci-git-backup/settings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,245 @@
'use strict';
'require view';
'require form';
'require fs';
'require ui';
'require uci';

const CONFIG = 'uci_git_backup';
const SECTION = 'config';
const SSH_KEY_FILE = '/etc/uci-git-backup/id_rsa';

function getLocalFqdn() {
const host = (window.location && window.location.hostname) || 'openwrt';
return host.trim() || 'openwrt';
}

function getDefaultAuthorName() {
return _('OpenWrt (%s)').format(getLocalFqdn());
}

function renderOutput(title, res) {
const output = [res.stdout, res.stderr].filter(Boolean).join('\n').trim() || _('No output.');
const success = (res.code === 0);

ui.showModal(title, [
E('p', { 'class': success ? 'spinning' : null }, [
success ? _('Command completed successfully.') : _('Command failed with exit code %d.').format(res.code)
]),
E('pre', { 'style': 'white-space: pre-wrap' }, [output]),
E('div', { 'class': 'right' }, [
E('button', { 'class': 'btn', 'click': ui.hideModal }, [ _('Dismiss') ])
])
]);
}

function readRecentBackupLog() {
return L.resolveDefault(fs.exec('/sbin/logread', [ '-e', 'uci-git-backup' ]), { code: 1, stdout: '', stderr: '' })
.then(function(res) {
return (res.stdout || '').trim();
});
}

return view.extend({
getCurrentSettingsValues: function() {
if (!this.settingsSection)
return {};

return this.settingsSection.formvalue(SECTION);
},

saveCurrentSettings: function() {
if (!this.map)
return Promise.resolve();

return this.map.parse().then(L.bind(function() {
return this.save(null, true);
}, this.map));
},

handleRunBackup: function() {
ui.showModal(_('Saving settings...'), [
E('p', { 'class': 'spinning' }, [ _('Saving the current form values before running the backup.') ])
]);

return this.saveCurrentSettings().then(function() {
ui.showModal(_('Running backup...'), [
E('p', { 'class': 'spinning' }, [ _('The backup script is running now.') ])
]);

return fs.exec('/usr/bin/uci-git-backup', []).then(function(res) {
return readRecentBackupLog().then(function(logText) {
if (![res.stdout, res.stderr].filter(Boolean).join('\n').trim() && logText)
res.stdout = logText;

renderOutput(_('Backup Output'), res);
});
});
}).catch(function(err) {
renderOutput(_('Backup Output'), {
code: 1,
stdout: '',
stderr: err?.message || String(err)
});
});
},

handleTestConnection: function() {
const values = this.getCurrentSettingsValues();
const args = [
'--remote-url', values.remote_url || '',
'--branch', values.branch || 'main',
'--auth-type', values.auth_type || 'password',
'--username', values.username || '',
'--password', values.password || ''
];

ui.showModal(_('Saving settings...'), [
E('p', { 'class': 'spinning' }, [ _('Saving the current form values before testing the connection.') ])
]);

return this.saveCurrentSettings().then(function() {
ui.showModal(_('Testing connection...'), [
E('p', { 'class': 'spinning' }, [ _('Checking remote reachability and authentication with the current form values.') ])
]);

return fs.exec('/usr/bin/uci-git-test', args).then(function(res) {
renderOutput(_('Connection Test Output'), res);
});
}).catch(function(err) {
renderOutput(_('Connection Test Output'), {
code: 1,
stdout: '',
stderr: err?.message || String(err)
});
});
},

load: function() {
return Promise.all([
uci.load(CONFIG),
L.resolveDefault(fs.read(SSH_KEY_FILE), ''),
readRecentBackupLog()
]);
},

render: function(data) {
const sshKey = data[1] || '';
const logText = data[2] || '';
const defaultAuthorName = getDefaultAuthorName();
let m, s, o;

m = new form.Map(CONFIG, _('UCI Git Backup'),
_('Automatically commits and pushes watched UCI configuration to a remote Git repository whenever a watched config is committed.'));
this.map = m;

s = m.section(form.NamedSection, SECTION, 'uci_git_backup', _('Settings'));
this.settingsSection = s;
s.anonymous = false;
s.addremove = false;

o = s.option(form.Flag, 'enabled', _('Enable automatic backup'));
o.default = o.disabled;
o.rmempty = false;

o = s.option(form.Value, 'remote_url', _('Remote Repository URL'),
_('HTTPS or SSH URL, e.g. <code>https://github.com/user/repo.git</code> or <code>git@github.com:user/repo.git</code>'));
o.placeholder = 'https://github.com/user/router-backup.git';
o.rmempty = false;

o = s.option(form.Value, 'branch', _('Branch'),
_('Remote branch to push to. It will be created if it does not exist yet.'));
o.placeholder = 'main';
o.default = 'main';
o.rmempty = false;

o = s.option(form.ListValue, 'auth_type', _('Authentication'));
o.value('password', _('Username / Password or Token (HTTPS)'));
o.value('ssh', _('SSH Private Key'));
o.default = 'password';

o = s.option(form.Value, 'username', _('Username'),
_('Required for HTTPS auth. For personal access tokens, use your normal Git username here and paste the token below.'));
o.depends('auth_type', 'password');
o.rmempty = true;

o = s.option(form.Value, 'password', _('Password / Token'),
_('For hosted Git services, use a personal access token instead of your account password.'));
o.depends('auth_type', 'password');
o.password = true;
o.rmempty = true;

o = s.option(form.TextValue, 'ssh_private_key', _('SSH Private Key'),
_('Stored in <code>/etc/uci-git-backup/id_rsa</code>, not in UCI. Paste an unencrypted key. Leaving this field empty keeps the existing key file.'));
o.depends('auth_type', 'ssh');
o.rows = 10;
o.wrap = 'off';
o.rmempty = true;
o.load = function() {
return sshKey;
};
o.write = function(section_id, value) {
value = (value || '').replace(/\r\n/g, '\n');

if (value.trim().length < 20)
return;

if (!value.endsWith('\n'))
value += '\n';

return fs.write(SSH_KEY_FILE, value).then(function() {
return fs.exec('/bin/chmod', [ '0600', SSH_KEY_FILE ]);
});
};
o.remove = function() {};

o = s.option(form.Value, 'repo_path', _('Local Repository Path'),
_('Use <code>/etc/...</code> for persistent storage or <code>/tmp/...</code> for temporary RAM-only storage.'));
o.placeholder = '/etc/uci-git-backup/repo';
o.default = '/etc/uci-git-backup/repo';

o = s.option(form.Value, 'author_name', _('Commit Author Name'));
o.placeholder = defaultAuthorName;
o.default = defaultAuthorName;
o.cfgvalue = function(section_id) {
const value = uci.get(CONFIG, section_id, 'author_name');
return (!value || value === 'OpenWRT' || value === 'OpenWrt') ? defaultAuthorName : value;
};

o = s.option(form.Value, 'author_email', _('Commit Author Email'));
o.placeholder = 'openwrt@localhost';
o.default = 'openwrt@localhost';

o = s.option(form.DynamicList, 'extra_triggers', _('Additional UCI Configs to Watch'),
_('Extra config names beyond the built-in set. Restart the service after saving to apply trigger changes.'));
o.placeholder = 'custom_package';
o.rmempty = true;

s = m.section(form.NamedSection, SECTION, 'uci_git_backup', _('Actions'));
s.anonymous = false;
s.addremove = false;

o = s.option(form.Button, '_run_backup', _('Run Backup Now'),
_('Saves the current form values, then runs the backup script and shows its output.'));
o.inputstyle = 'action';
o.inputtitle = _('Run Backup Now');
o.onclick = ui.createHandlerFn(this, 'handleRunBackup');

o = s.option(form.Button, '_test_connection', _('Test Connection'),
_('Saves the current form values, then tests the remote settings without creating a commit or push.'));
o.inputstyle = 'action';
o.inputtitle = _('Test Connection');
o.onclick = ui.createHandlerFn(this, 'handleTestConnection');

s = m.section(form.NamedSection, SECTION, 'uci_git_backup', _('Recent Log'));
s.anonymous = false;
s.addremove = false;

o = s.option(form.DummyValue, '_recent_log', _('Recent Log Output'));
o.renderWidget = function() {
return E('pre', { 'style': 'white-space: pre-wrap' }, [ logText || _('No recent log output.') ]);
};

return m.render();
}
});
Loading