]> git.99rst.org Git - openwrt-luci.git/blob
git.99rst.org / openwrt-luci.git / blob
? search:


ca5f9954b4ecb4e6d17679671033ac44000ff803
[openwrt-luci.git] /
1 'use strict';
2 'require view';
3 'require form';
4 'require uci';
5 'require rpc';
6 'require ui';
7 'require poll';
8 'require request';
9 'require dom';
10 'require fs';
11
12
13 /* --------------------------------------------------------------------------
14 * This section should be sufficient to isolate the changes that any forked
15 * versions need to change with a custom support url.
16 */
17
18 const support_url = 'https://forum.openwrt.org/t/luci-attended-sysupgrade-support-thread/230552';
19 const support_link = E('a', { href: support_url }, _('this forum thread'));
20
21 function detailsBlock(title, content, pre) {
22 /* Formatter for discourse-based forum "details" block.
23 *
24 * If the above support_url is changed to github, say, then you'd
25 * probably need to get rid of the '[details...]' syntax.
26 */
27 return ! content ? '' : ''.concat(
28 '[details="', title, '"]\n',
29 pre ? '```\n' : '',
30 content, '\n',
31 pre ? '```\n' : '',
32 '[/details]\n',
33 );
34 }
35
36 /* -------------------------------------------------------------------------- */
37
38 const callPackagelist = rpc.declare({
39 object: 'rpc-sys',
40 method: 'packagelist',
41 });
42
43 const callSystemBoard = rpc.declare({
44 object: 'system',
45 method: 'board',
46 });
47
48 const callUpgradeStart = rpc.declare({
49 object: 'rpc-sys',
50 method: 'upgrade_start',
51 params: ['keep'],
52 });
53
54 /**
55 * Returns the branch of a given version. This helps to offer upgrades
56 * for point releases (aka within the branch).
57 *
58 * Logic:
59 * SNAPSHOT -> SNAPSHOT
60 * 21.02-SNAPSHOT -> 21.02
61 * 21.02.0-rc1 -> 21.02
62 * 19.07.8 -> 19.07
63 *
64 * @param {string} version
65 * Input version from which to determine the branch
66 * @returns {string}
67 * The determined branch
68 */
69 function get_branch(version) {
70 return version.replace('-SNAPSHOT', '').split('.').slice(0, 2).join('.');
71 }
72
73 /**
74 * The OpenWrt revision string contains both a hash as well as the number
75 * commits since the OpenWrt/LEDE reboot. It helps to determine if a
76 * snapshot is newer than another.
77 *
78 * @param {string} revision
79 * Revision string of a OpenWrt device
80 * @returns {integer}
81 * The number of commits since OpenWrt/LEDE reboot
82 */
83 function get_revision_count(revision) {
84 return parseInt(revision.substring(1).split('-')[0]);
85 }
86
87 return view.extend({
88 steps: {
89 init: [ 0, _('Received build request')],
90 container_setup: [ 10, _('Setting up ImageBuilder')],
91 validate_revision: [ 20, _('Validating revision')],
92 validate_manifest: [ 30, _('Validating package selection')],
93 calculate_packages_hash: [ 40, _('Calculating package hash')],
94 building_image: [ 50, _('Generating firmware image')],
95 signing_images: [ 95, _('Signing images')],
96 done: [100, _('Completed generating firmware image')],
97 failed: [100, _('Failed to generate firmware image')],
98
99 /* Obsolete status values, retained for backward compatibility. */
100 download_imagebuilder: [ 20, _('Downloading ImageBuilder archive')],
101 unpack_imagebuilder: [ 40, _('Setting Up ImageBuilder')],
102 },
103
104 request_hash: new Map(),
105 sha256_unsigned: '',
106
107 applyPackageChanges: async function(package_info) {
108 let { url, target, version, packages } = package_info;
109
110 const overview_url = `${url}/api/v1/overview`;
111 const revision_url = `${url}/api/v1/revision/${version}/${target}`;
112
113 let changes, target_revision;
114
115 await Promise.all([
116 request.get(overview_url)
117 .then(response => response.json())
118 .then(json => json.branches)
119 .then(branches => branches[get_branch(version)])
120 .then(branch => { changes = branch.package_changes; })
121 .catch(error => {
122 throw Error(`Get overview failed:<br>${overview_url}<br>${error}`);
123 }),
124
125 request.get(revision_url)
126 .then(response => response.json())
127 .then(json => json.revision)
128 .then(revision => { target_revision = get_revision_count(revision); })
129 .catch(error => {
130 throw Error(`Get revision failed:<br>${revision_url}<br>${error}`);
131 }),
132 ]);
133
134 for (const change of changes) {
135 let idx = packages.indexOf(change.source);
136 if (idx >= 0 && change.revision <= target_revision) {
137 if (change.target)
138 packages[idx] = change.target;
139 else
140 packages.splice(idx, 1);
141 }
142 }
143 return packages;
144 },
145
146 selectImage: function (images, data, firmware) {
147 var filesystemFilter = function(e) {
148 return (e.filesystem == firmware.filesystem);
149 }
150 var typeFilter = function(e) {
151 let efi_targets = ['armsr', 'loongarch', 'x86'];
152 let efi_capable = efi_targets.some((tgt) => firmware.target.startsWith(tgt));
153 if (efi_capable) {
154 if (data.efi) {
155 return (e.type == 'combined-efi');
156 } else {
157 return (e.type == 'combined');
158 }
159 } else {
160 return (e.type == 'sysupgrade' || e.type == 'combined');
161 }
162 }
163 return images.filter(filesystemFilter).filter(typeFilter)[0];
164 },
165
166 handle200: function (response, content, data, firmware) {
167 response = response.json();
168 let image = this.selectImage(response.images, data, firmware);
169
170 if (image.name != undefined) {
171 this.sha256_unsigned = image.sha256_unsigned;
172 let sysupgrade_url = `${data.url}/store/${response.bin_dir}/${image.name}`;
173
174 let keep = E('input', { type: 'checkbox' });
175 keep.checked = true;
176
177 let fields = [
178 _('Version'),
179 `${response.version_number} ${response.version_code}`,
180 _('SHA256'),
181 image.sha256,
182 ];
183
184 if (data.advanced_mode == 1) {
185 fields.push(
186 _('Profile'),
187 response.id,
188 _('Target'),
189 response.target,
190 _('Build Date'),
191 response.build_at,
192 _('Filename'),
193 image.name,
194 _('Filesystem'),
195 image.filesystem
196 );
197 }
198
199 fields.push(
200 '',
201 E('a', { href: sysupgrade_url }, _('Download firmware image'))
202 );
203 if (data.rebuilder) {
204 fields.push(_('Rebuilds'), E('div', { id: 'rebuilder_status' }));
205 }
206
207 let table = E('div', { class: 'table' });
208
209 for (let i = 0; i < fields.length; i += 2) {
210 table.appendChild(
211 E('tr', { class: 'tr' }, [
212 E('td', { class: 'td left', width: '33%' }, [fields[i]]),
213 E('td', { class: 'td left' }, [fields[i + 1]]),
214 ])
215 );
216 }
217
218 let modal_body = [
219 table,
220 E(
221 'p',
222 { class: 'mt-2' },
223 E('label', { class: 'btn' }, [
224 keep,
225 ' ',
226 _('Keep settings and retain the current configuration'),
227 ])
228 ),
229 E('div', { class: 'right' }, [
230 E('div', { class: 'btn', click: ui.hideModal }, _('Cancel')),
231 ' ',
232 E(
233 'button',
234 {
235 class: 'btn cbi-button cbi-button-positive important',
236 click: ui.createHandlerFn(this, function () {
237 this.handleInstall(sysupgrade_url, keep.checked, image.sha256);
238 }),
239 },
240 _('Install firmware image')
241 ),
242 ]),
243 ];
244
245 ui.showModal(_('Successfully created firmware image'), modal_body);
246 if (data.rebuilder) {
247 this.handleRebuilder(content, data, firmware);
248 }
249 }
250 },
251
252 handle202: function (response) {
253 if ('queue_position' in response) {
254 ui.showModal(_('Queued...'), [
255 E(
256 'p',
257 { class: 'spinning' },
258 _('Request in build queue position %s').format(
259 response.queue_position
260 )
261 ),
262 ]);
263 } else {
264 ui.showModal(_('Building Firmware...'), [
265 E(
266 'p',
267 { class: 'spinning' },
268 _('Progress: %s%% %s').format(
269 this.steps[response.imagebuilder_status][0],
270 this.steps[response.imagebuilder_status][1]
271 )
272 ),
273 ]);
274 }
275 },
276
277 handleError: function (response, data, firmware, request_hash) {
278 response = response.json();
279 const request_data = {
280 ...data,
281 request_hash: request_hash,
282 sha256_unsigned: this.sha256_unsigned,
283 ...firmware
284 };
285 const request_str = JSON.stringify(request_data, null, 4);
286 let body = [
287 E('p', {}, [
288 _('First, check'), ' ',
289 support_link,
290 _('. If you don\'t find a solution there, then report all of the information below.')
291 ]),
292
293 E(
294 'button',
295 {
296 class: 'btn cbi-button cbi-button-positive important',
297 style: 'margin-bottom: 1em; padding: 0.2em',
298 click: ui.createHandlerFn(this, function () {
299 var text = ''.concat(
300 // No translations in here as it's intended for the forum.
301 'Server response: %s\n\n'.format(response.detail),
302 detailsBlock('Request Data', request_str, true),
303 detailsBlock('STDOUT', response.stdout, true),
304 detailsBlock('STDERR', response.stderr, true),
305 );
306
307 navigator.clipboard.writeText(text);
308
309 ui.showModal(_('Data copied!'), [
310 E('p', [
311 _('Paste the contents of the clipboard to'), ' ',
312 support_link,
313 '.',
314 ]),
315 E('div', { class: 'right' }, [
316 E('div', { class: 'btn', click: ui.hideModal }, _('Close')),
317 ]),
318 ]);
319 }),
320 },
321 _('Copy error data to clipboard...')
322 ),
323
324 E('p', _('Server response: %s').format(response.detail)),
325 E('p', _('Request Data:')),
326 E('pre', {}, request_str),
327 ];
328
329 if (response.stdout) {
330 body.push(
331 E('b', 'STDOUT:'),
332 E('pre', response.stdout),
333 );
334 }
335
336 if (response.stderr) {
337 body.push(
338 E('b', 'STDERR:'),
339 E('pre', response.stderr),
340 );
341 }
342
343 body.push(
344 E('div', { class: 'right' }, [
345 E('div', { class: 'btn', click: ui.hideModal }, _('Close')),
346 ]),
347 );
348
349 ui.showModal(_('Error building the firmware image'), body);
350 },
351
352 handleRequest: function (server, main, content, data, firmware) {
353 let request_url = `${server}/api/v1/build`;
354 let method = 'POST';
355 let local_content = content;
356 const request_hash = this.request_hash.get(server);
357
358 /**
359 * If `request_hash` is available use a GET request instead of
360 * sending the entire object.
361 */
362 if (request_hash) {
363 request_url += `/${request_hash}`;
364 local_content = {};
365 method = 'GET';
366 }
367
368 request
369 .request(request_url, { method: method, content: local_content })
370 .then((response) => {
371 switch (response.status) {
372 case 202:
373 response = response.json();
374
375 this.request_hash.set(server, response.request_hash);
376
377 if (main) {
378 this.handle202(response);
379 } else {
380 let view = document.getElementById(server);
381 view.innerText = `⏳ (${
382 this.steps[response.imagebuilder_status][0]
383 }%) ${server}`;
384 }
385 break;
386 case 200:
387 if (main == true) {
388 poll.remove(this.pollFn);
389 this.handle200(response, content, data, firmware);
390 } else {
391 poll.remove(this.rebuilder_polls[server]);
392 response = response.json();
393 let view = document.getElementById(server);
394 let image = this.selectImage(response.images, data, firmware);
395 if (image.sha256_unsigned == this.sha256_unsigned) {
396 view.innerText = '✅ %s'.format(server);
397 } else {
398 view.innerHTML = `⚠️ ${server} (<a href="${server}/store/${
399 response.bin_dir
400 }/${image.name}">${_('Download')}</a>)`;
401 }
402 }
403 break;
404 default: // any error or unexpected responses
405 if (main == true) {
406 poll.remove(this.pollFn);
407 this.handleError(response, data, firmware, request_hash);
408 } else {
409 poll.remove(this.rebuilder_polls[server]);
410 document.getElementById(server).innerText = '🚫 %s'.format(
411 server
412 );
413 }
414 break;
415 }
416 });
417 },
418
419 handleRebuilder: function (content, data, firmware) {
420 this.rebuilder_polls = {};
421 for (let rebuilder of data.rebuilder) {
422 this.rebuilder_polls[rebuilder] = L.bind(
423 this.handleRequest,
424 this,
425 rebuilder,
426 false,
427 content,
428 data,
429 firmware
430 );
431 poll.add(this.rebuilder_polls[rebuilder], 5);
432 document.getElementById(
433 'rebuilder_status'
434 ).innerHTML += `<p id="${rebuilder}">⏳ ${rebuilder}</p>`;
435 }
436 poll.start();
437 },
438
439 handleInstall: function (url, keep, sha256) {
440 ui.showModal(_('Downloading...'), [
441 E(
442 'p',
443 { class: 'spinning' },
444 _('Downloading firmware from server to browser')
445 ),
446 ]);
447
448 request
449 .get(url, {
450 headers: {
451 'Content-Type': 'application/x-www-form-urlencoded',
452 },
453 responseType: 'blob',
454 })
455 .then((response) => {
456 let form_data = new FormData();
457 form_data.append('sessionid', rpc.getSessionID());
458 form_data.append('filename', '/tmp/firmware.bin');
459 form_data.append('filemode', 600);
460 form_data.append('filedata', response.blob());
461
462 ui.showModal(_('Uploading...'), [
463 E(
464 'p',
465 { class: 'spinning' },
466 _('Uploading firmware from browser to device')
467 ),
468 ]);
469
470 request
471 .get(`${L.env.cgi_base}/cgi-upload`, {
472 method: 'PUT',
473 content: form_data,
474 })
475 .then((response) => response.json())
476 .then((response) => {
477 if (response.sha256sum != sha256) {
478 ui.showModal(_('Wrong checksum'), [
479 E('p', _('Error during download of firmware. Please try again')),
480 E('div', { class: 'btn', click: ui.hideModal }, _('Close')),
481 ]);
482 } else {
483 ui.showModal(_('Installing...'), [
484 E('div', { class: 'spinning' }, [
485 E('p', _('Installing the sysupgrade image...')),
486 E('p',
487 _('Once the image is written, the system will reboot.')
488 + ' ' +
489 _('This should take at least a minute, so please wait for the login screen.')
490 ),
491 E('b', _('While you are waiting, do not unpower device!')),
492 ]),
493 ]);
494
495 L.resolveDefault(callUpgradeStart(keep), {}).then((response) => {
496 // Wait 10 seconds before we try to reconnect...
497 let hosts = keep ? [] : ['192.168.1.1', 'openwrt.lan'];
498 setTimeout(() => { ui.awaitReconnect(...hosts); }, 10000);
499 });
500 }
501 });
502 });
503 },
504
505 handleCheck: function (data, firmware) {
506 this.request_hash.clear();
507 let { url, revision, advanced_mode, branch } = data;
508 let { version, target, profile, packages } = firmware;
509 let candidates = [];
510
511 const endpoint = version.endsWith('SNAPSHOT') ? `revision/${version}/${target}` : 'overview';
512 const request_url = `${url}/api/v1/${endpoint}`;
513
514 ui.showModal(_('Searching...'), [
515 E(
516 'p',
517 { class: 'spinning' },
518 _('Searching for an available sysupgrade of %s - %s').format(
519 version,
520 revision
521 )
522 ),
523 ]);
524
525 L.resolveDefault(request.get(request_url)).then((response) => {
526 if (!response.ok) {
527 ui.showModal(_('Error connecting to upgrade server'), [
528 E(
529 'p',
530 {},
531 _('Could not reach API at "%s". Please try again later.').format(
532 response.url
533 )
534 ),
535 E('pre', {}, response.responseText),
536 E('div', { class: 'right' }, [
537 E('div', { class: 'btn', click: ui.hideModal }, _('Close')),
538 ]),
539 ]);
540 return;
541 }
542 if (version.endsWith('SNAPSHOT')) {
543 const remote_revision = response.json().revision;
544 if (
545 get_revision_count(revision) < get_revision_count(remote_revision)
546 ) {
547 candidates.push([version, remote_revision]);
548 }
549 } else {
550 const latest = response.json().latest;
551
552 // ensure order: newest to oldest release
553 latest.sort().reverse();
554
555 for (let remote_version of latest) {
556 let remote_branch = get_branch(remote_version);
557
558 // already latest version installed
559 if (version == remote_version) {
560 break;
561 }
562
563 candidates.unshift([remote_version, null]);
564
565 // don't offer branches older than the current
566 if (branch == remote_branch) {
567 break;
568 }
569 }
570 }
571
572 // allow to re-install running firmware in advanced mode
573 if (advanced_mode == 1) {
574 candidates.unshift([version, revision]);
575 }
576
577 if (candidates.length) {
578 let s, o;
579
580 let mapdata = {
581 request: {
582 profile,
583 version: candidates[0][0],
584 packages: Object.keys(packages).sort(),
585 },
586 };
587
588 let map = new form.JSONMap(mapdata, '');
589
590 s = map.section(
591 form.NamedSection,
592 'request',
593 '',
594 '',
595 'Use defaults for the safest update'
596 );
597 o = s.option(form.ListValue, 'version', 'Select firmware version');
598 for (let candidate of candidates) {
599 if (candidate[0] == version && candidate[1] == revision) {
600 o.value(
601 candidate[0],
602 _('[installed] %s').format(
603 candidate[1]
604 ? `${candidate[0]} - ${candidate[1]}`
605 : candidate[0]
606 )
607 );
608 } else {
609 o.value(
610 candidate[0],
611 candidate[1] ? `${candidate[0]} - ${candidate[1]}` : candidate[0]
612 );
613 }
614 }
615
616 if (advanced_mode == 1) {
617 o = s.option(form.Value, 'profile', _('Board Name / Profile'));
618 o = s.option(form.DynamicList, 'packages', _('Packages'));
619 }
620
621 L.resolveDefault(map.render()).then((form_rendered) => {
622 ui.showModal(_('New firmware upgrade available'), [
623 E(
624 'p',
625 _('Currently running: %s - %s').format(
626 version,
627 revision
628 )
629 ),
630 form_rendered,
631 E('div', { class: 'right' }, [
632 E('div', { class: 'btn', click: ui.hideModal }, _('Cancel')),
633 ' ',
634 E(
635 'button',
636 {
637 class: 'btn cbi-button cbi-button-positive important',
638 click: ui.createHandlerFn(this, function () {
639 map.save().then(() => {
640 this.applyPackageChanges({
641 url,
642 target,
643 version: mapdata.request.version,
644 packages: mapdata.request.packages,
645 }).then((packages) => {
646 const content = {
647 ...firmware,
648 packages: packages,
649 version: mapdata.request.version,
650 profile: mapdata.request.profile
651 };
652 this.pollFn = L.bind(function () {
653 this.handleRequest(url, true, content, data, firmware);
654 }, this);
655 poll.add(this.pollFn, 5);
656 poll.start();
657 })
658 .catch(error => {
659 ui.addNotification(null, E('p', error.message));
660 ui.hideModal();
661 });
662 });
663 }),
664 },
665 _('Request firmware image')
666 ),
667 ]),
668 ]);
669 });
670 } else {
671 ui.showModal(_('No upgrade available'), [
672 E(
673 'p',
674 _('The device runs the latest firmware version %s - %s').format(
675 version,
676 revision
677 )
678 ),
679 E('div', { class: 'right' }, [
680 E('div', { class: 'btn', click: ui.hideModal }, _('Close')),
681 ]),
682 ]);
683 }
684 });
685 },
686
687 load: async function () {
688 const promises = await Promise.all([
689 L.resolveDefault(callPackagelist(), {}),
690 L.resolveDefault(callSystemBoard(), {}),
691 L.resolveDefault(fs.stat('/sys/firmware/efi'), null),
692 uci.load('attendedsysupgrade'),
693 ]);
694 const data = {
695 system_board: promises[1],
696 advanced_mode: uci.get_first('attendedsysupgrade', 'client', 'advanced_mode') || 0,
697 url: uci.get_first('attendedsysupgrade', 'server', 'url').replace(/\/+$/, ''),
698 branch: get_branch(promises[1].release.version),
699 revision: promises[1].release.revision,
700 efi: promises[2],
701 rebuilder: uci.get_first('attendedsysupgrade', 'server', 'rebuilder'),
702 };
703 const firmware = {
704 client: 'luci/' + promises[0].packages['luci-app-attendedsysupgrade'],
705 packages: promises[0].packages,
706 profile: promises[1].board_name,
707 target: promises[1].release.target,
708 version: promises[1].release.version,
709 diff_packages: true,
710 filesystem: promises[1].rootfs_type,
711
712 // If the user has changed the rootfs partition size via owut,
713 // then make sure to keep new image the same size. A null value
714 // is interpreted by the ASU server as "default".
715 rootfs_size_mb: uci.get('attendedsysupgrade', 'owut', 'rootfs_size'),
716 };
717 return [data, firmware];
718 },
719
720 render: function (response) {
721 const data = response[0];
722 const firmware = response[1];
723
724 return E('p', [
725 E('h2', _('Attended Sysupgrade')),
726 E(
727 'p',
728 _(
729 'The attended sysupgrade service allows to upgrade vanilla and custom firmware images easily.'
730 )
731 ),
732 E(
733 'p',
734 _(
735 'This is done by building a new firmware on demand via an online service.'
736 )
737 ),
738 E(
739 'p',
740 _('Currently running: %s - %s').format(
741 firmware.version,
742 data.revision
743 )
744 ),
745 E(
746 'button',
747 {
748 class: 'btn cbi-button cbi-button-positive important',
749 click: ui.createHandlerFn(this, this.handleCheck, data, firmware),
750 },
751 _('Search for firmware upgrade')
752 ),
753 ]);
754 },
755 handleSaveApply: null,
756 handleSave: null,
757 handleReset: null,
758 });
git clone https://git.99rst.org/PROJECT